Help Center/ Data Replication Service/ API Reference/ APIs V5.0 (in OBT)/ Database Object Configuration/ Querying Column Information (Column Mapping and Column Filtering) of an Object - ShowColumnInfos
Updated on 2026-03-17 GMT+08:00
View PDF
Share

Querying Column Information (Column Mapping and Column Filtering) of an Object - ShowColumnInfos

Function

This API is used to query the column information (column mapping and column filtering) of an object.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permissions are required for calling this API.

URI

POST /v5/{project_id}/job/{job_id}/column-info

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID.

job_id

Yes

String

Task ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

No

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.

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 response is returned, the value of X-Subject-Token in the response header is the token value.

X-Language

No

String

Request language type.

Enumerated values:

  • en-us

  • zh-cn
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

refresh

Yes

Boolean

Whether to obtain column information from the node again.

object_ids

No

Array of strings

Object information of the column.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

column_map_infos

Array of objects

Column mapping information.

For details, see ColumnMappingInfo.

object_with_column_infos

Array of objects

Object related to column information.

For details, see ObjectWithColumnInfo.
Table 5 ColumnMappingInfo

Parameter

Type

Description

object_id

String

Object ID.

column_info_lists

Array of objects

Column information.

For details, see ColumnInfo.
Table 6 ColumnInfo

Parameter

Type

Description

column_name

String

Column name.

column_type

String

Column type.

key_type

String

Key type of the column.

column_mapped_name

String

Mapped column name.

status

Boolean

Whether to filter the column.

partition

Boolean

Whether to specify partitionKey for the column.
Table 7 ObjectWithColumnInfo

Parameter

Type

Description

id

String

Node ID.

parent_id

String

Parent node ID.

type

String

Node type.

name

String

Node name.

alias_name

String

Node alias.

notices

Array of strings

Prompt information. For example, a message indicates that there are too many tables in the database.

extend_info

String

Extended information: For example, a message indicates whether there is data and whether the structure exists in the destination database.

is_support_expand

Boolean

Whether the query can be expanded.

has_column_info

Boolean

Whether there is column information.

is_preset

Boolean

Preset or not.

token_count

String

Number of tokens.

is_sent

Boolean

Whether information has been delivered to the node.

sent_alias_name

String

Alias of the node to which information is delivered.

Status code: 400

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

Querying the column information of an object

https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/jobs/fc77e18b-21c8-4040-96b5-ae599d3jb201/column-info

{
  "object_ids" : [ "test-*-*-test2" ],
  "refresh" : false
}

Example Responses

Status code: 200

OK

{
  "column_map_infos" : [ {
    "object_id" : "test-*-*-test2",
    "column_info_lists" : [ {
      "status" : true,
      "partition" : false,
      "column_name" : "id",
      "column_type" : "int unsigned",
      "primary_key_or_unique_index" : "PRI",
      "column_mapped_name" : null
    } ]
  } ],
  "object_with_column_infos" : [ ]
}

Status code: 400

Bad Request

{
  "error_code" : "DRS.10000001",
  "error_msg" : "Failed."
}

Status Code

Status Code

Description

200

OK

400

Bad Request

Error Code

For details, see Error Code.