Querying Additional Column Information About Data Processing Objects_Data Processing_APIs V5.0_API Reference

Function

This API is used to query the additional column information about data processing objects.

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

GET /v5/{project_id}/jobs/{job_id}/extra-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.

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
is_only_show_sent	No	Boolean	Whether to query only delivered processing objects. The default value is No.
offset	No	Integer	Offset. The records after this offset will be queried. The default value is 0.
limit	No	Integer	Maximum number of records that can be returned. The default value is 10.

Request Parameters

**Table 3** 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. The token is the value of X-Subject-Token in the response header.
X-Language	No	String	Request language type Enumerated values: en-us zh-cn

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_count	Integer	Total number of records in the list, which is irrelevant to pagination.
column_process_objects	Array of objects	Column processing object. For details, see ColumnProcessObjects.

**Table 5** ColumnProcessObjects
Parameter	Type	Description
object_source_names	Array of strings	Name of the selected source database object.
object_alias_name	String	Mapped object name.
is_sent	Boolean	Whether the additional column has been delivered.
extra_column_infos	Array of objects	Additional column information. For details, see AddColumnInfo.

**Table 6** AddColumnInfo
Parameter	Type	Description
column_type	String	Column type. The value can be default_value, create_time, update_time, expression, or server_database_table.
column_name	String	Column name.
column_value	String	Column value.
data_type	String	Data type of a column. The value can be int, long, varchar(256), varchar(191), datetime, or timestamp.

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

Querying the additional column information about delivered data processing objects

GET https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb201/extra-column-info?is_only_show_sent=true&limit=10&offset=0

Example Response

Status code: 200

OK

{
  "column_process_objects" : [ {
    "object_alias_name" : "zc01-*-*-test_add_clolumn",
    "object_source_names" : [ "zc01-*-*-test_add_clolumn" ],
    "is_sent" : true,
    "extra_column_infos" : [ {
      "column_name" : "test_add_column",
      "column_type" : "ADDITIONALCOLUMN,default_value",
      "data_type" : "int",
      "column_value" : "11"
    } ]
  } ],
  "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

For other statuses, see Status Code.

Error Code

For details, see Error Code.

Querying Additional Column Information About Data Processing Objects