Help Center/ Data Replication Service/ API Reference/ APIs V5.0 (in OBT)/ Data Processing/ Collecting Column Information About a Specified Database Table
Updated on 2025-12-15 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Collecting Column Information About a Specified Database Table

Function

This API is used to collect the column information about a specified database table.

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}/columns/collect

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

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

is_force_refresh

No

Boolean

Whether to obtain the latest column information from the Node.

db_object_infos

Yes

Array of objects

Information about a specified database table.

For details, see Table 4.
Table 4 Data structure description of field db_object_infos

Parameter

Mandatory

Type

Description

db_name

Yes

String

Database name.

schema_name

No

String

Schema name.

table_name

Yes

String

Table name.

Response Parameters

Status code: 202

Table 5 Response body parameters

Parameter

Type

Description

id

String

Query result ID.

job_id

String

Task ID.

status

String

Query status.

Enumerated values:

  • pending
  • failed
  • success

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

Collecting the column information about a specified database table

POST https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/job/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r/columns/collect

{
  "is_force_refresh" : false,
  "db_object_infos" : [ {
    "db_name" : "testDb",
    "schema_name" : "testSchema",
    "table_name" : "testTable"
  } ]
}

Example Response

Status code: 202

Accept

{
  "id" : "0eacda0b-9422-4535-8b62-537d1833638b",
  "job_id": "177738d1-4eee-4fcb-a4e1-09aea79jb20i",
  "status" : "pending"
}

Status code: 400

Bad Request

{
  "error_code" : "DRS.10030016",
  "error_msg" : "Query column info failed"
}

Status Code

Status Code

Description

202

Accept

400

Bad Request

Error Code

For details, see Error Code.

Parent topic: Data Processing