Help Center/ Data Replication Service/ API Reference/ APIs V5.0 (in OBT)/ Database Object Configuration/ Querying the Synchronization Mapping List
Updated on 2024-04-17 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying the Synchronization Mapping List

Function

This API is used to query the synchronization mapping list. During real-time synchronization, the objects that can be mapped to the destination include databases, schemas, tables, and columns (in data processing).

URI

POST /v5/{project_id}/jobs/{job_id}/object-mappings

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region.

For details, see Obtaining a Project ID.

job_id

Yes

String

Task ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

MIME type of the request body. Use the default value application/json. For APIs used to upload objects or images, the value varies depending on the flow type.

The default value is application/json.

X-Auth-Token

Yes

String

User token obtained from IAM.

It is a response to the API for obtaining a user token. This API is the only one that does not require authentication.

After a request is processed, the value of X-Subject-Token in the header is the token value.

X-Language

No

String

Request language type.

Default value: en-us

Enumerated values:

  • en-us
  • zh-cn
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Offset, which is the position where the query starts. The value must be greater than or equal to 0. The default value is 0.

Default value: 0

limit

No

Integer

Number of items displayed per page. The default value is 10. The value ranges from 1 to 1000.

Minimum value: 1

Maximum value: 1000

Default value: 10

db_name

No

String

Database name.

schema_name

No

String

Schema name.

table_name

No

String

Table name.

has_column_info

No

Boolean

Whether there is column mapping.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

count

Long

Total number.

object_mapping_list

Array of objects

List of synchronization mapping data.

For details, see Table 5.
Table 5 object_mapping_list parameters

Parameter

Type

Description

source_db_name

String

Database name in the source database.

source_schema_name

String

Schema name in the source database.

source_table_name

String

Table name in the source database name.

target_db_name

String

Database name in the destination database.

target_schema_name

String

Schema name in the destination database.

target_table_name

String

Table name in the destination database.

has_column_info

Boolean

Whether there is column mapping.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum length: 12

Maximum length: 12

error_msg

String

Error message.

Minimum length: 1

Maximum length: 512

Example Request

Querying the synchronization mapping list

https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/jobs/163b98e8-6088-46c3-8b86-c18fea6jb502/object-mappings
{
  "db_name": "",
  "schema_name": "",
  "table_name": "",
  "offset": 1,
  "limit": 10,
  "has_column_info": false
}

Example Response

Status code: 200

OK 
{ 
  "object_mapping_list" : [ { 
    "source_db_name" : "yf", 
    "source_table_name" : "aaaa", 
    "target_db_name" : "yf", 
    "target_table_name" : "aaaa" 
  } ], 
  "count" : 1 
}

Status code: 400

Bad Request

{
  "error_code": "DRS.M05003",
  "error_msg": "Task information not found."
}

Error Code

For details, see Error Code.