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

Obtaining Column Information About a Specified Database Table

Function

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

URI

GET /v5/{project_id}/job/{job_id}/columns

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.
Table 2 Query parameters

Parameter

Mandatory

Type

Description

query_id

Yes

String

ID of the column information collection request for a specified database table, which is returned by the API for submitting the column information collection of a specified database table.

offset

No

Integer

Offset. The records after this offset will be queried.

limit

No

Integer

Maximum number of records that can be returned.

Request Parameters

Table 3 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

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

results

Array of objects

Column information about a specified database table.

For details, see Table 5.

total_count

Integer

Total number of records in the list, which is irrelevant to pagination.
Table 5 Data structure description of field results

Parameter

Type

Description

db_name

String

Database name.

schema_name

String

Schema name.

table_name

String

Table name.

column_infos

Array of objects

Column information.

For details, see Table 6.

total_count

Integer

Total number of database column records, which is irrelevant to pagination and is used only as a return body parameter.
Table 6 Data structure description of field column_infos

Parameter

Type

Description

column_name

String

Column name.

column_type

String

Column type.

primary_key_or_unique_index

String

Primary key or unique index.

column_mapped_name

String

Mapped column name.

is_filtered

Boolean

Whether the column is filtered.

is_partition_key

Boolean

Whether the column is a partition column.

Status code: 400

Table 7 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

Obtaining the column information about a specified database table

GET https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/job/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r/columns?query_id=0eacda0b-9422-4535-8b62-537d1833638b

Example Response

Status code: 200

OK

{
  "results" : [ {
    "db_name" : "testdb02",
    "table_name" : "test5",
    "column_infos" : [ {
      "column_name" : "id",
      "column_type" : "NUMBER",
      "primary_key_or_unique_index" : "PRI",
      "column_mapped_name" : null,
      "is_filtered" : false,
      "is_partition_key" : false
    }, {
      "column_name" : "C1",
      "column_type" : "VARCHAR2",
      "primary_key_or_unique_index" : "",
      "column_mapped_name" : null,
      "is_filtered" : false,
      "is_partition_key" : false
    }, {
      "column_name" : "C2",
      "column_type" : "VARCHAR2",
      "primary_key_or_unique_index" : "",
      "column_mapped_name" : null,
      "is_filtered" : false,
      "is_partition_key" : false
    } ],
    "total_count" : 3
  } ],
  "total_count" : 1
}

Status code: 400

Bad Request

{
  "error_code" : "DRS.10000010",
  "error_msg" : "Job does not exist, please check job ID."
}

Status Code

Status Code

Description

200

OK

400

Bad Request

Error Code

For details, see Error Code.

Parent topic: Data Processing