Overview
Queries the transfer object mappings of a project. Corresponds to DescribeTransferMapping.
API details
Constraints
The caller must have an AccessKey to access the multi-cloud API. For information about how to obtain the AccessKey ID and AccessKey Secret, see Manage AccessKeys.
Request path
GET /api/v2/oms/project/transferMapping
Request parameters
Header
Parameter |
Type |
Required |
Description |
Example value |
|---|---|---|---|---|
| X-Ob-Project-Id | String | Yes | Project ID. | proj-xxxxxxxx |
| X-Ob-Org-Id | String | Yes | Organization ID. | org-xxxxxxxx |
Query
Parameter |
Type |
Required |
Description |
Example value |
|---|---|---|---|---|
| requestId | String | No | Request ID. | d04eabba-acef-4f4b-96f1-c657******** |
| id | String | Yes | Unique project identifier. | np_7befdmp08juo |
Response parameters
Field |
Type |
Description |
Example value |
|---|---|---|---|
| success | Boolean | Whether the request succeeded. | true |
| requestId | String | Request ID. | req-xxx-xxx |
| cost | String | Time taken. | 123ms |
| data | TransferMappingVO | Transfer object mappings, with the same structure as transferMapping in the CreateProject API. |
Examples
Request example
curl --digest -u '<your AK:SK>' \
--request GET \
--url 'https://api-cloud.oceanbase.com/api/v2/oms/project/transferMapping?id=np_7befdmp08juo' \
-H 'X-Ob-Project-Id: <project ID>' \
-H 'X-Ob-Org-Id: <organization ID>'
Response example
{
"success": true,
"requestId": "req-xxx-xxx",
"cost": "123ms",
"data": {
"mode": "COMPLEX",
"schemas": [
{
"name": "source_db",
"mappedName": "target_db",
"tables": [
{ "name": "table_1", "mappedName": "table_1" }
]
}
]
}
}