Querying Column Processing (Column Mapping and Column Filtering) of Objects

Function

This API is used to query column processing (column mapping and column filtering) of 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}/job/{job_id}/object-column-info

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
job_id	Yes	String	Definition Task ID, which uniquely identifies a data replication task and serves as the identifier for operations such as query, modification, and deletion. Constraints N/A Range N/A Default Value N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
object_id	No	String	Definition Object ID. If this parameter is left blank, database-level objects are queried by default. Constraints N/A Range N/A Default Value N/A
is_refresh	No	Boolean	Definition Whether to forcibly refresh the query result. Constraints N/A Range true: The query result is forcibly refreshed. false: The query result is not forcibly refreshed. Default Value false
limit	No	Integer	Definition Maximum number of records that can be returned. This parameter is used to specify the number of records returned on each page during pagination query. Constraints N/A Range N/A Default Value 10
offset	No	Integer	Definition Offset, which is used for pagination query. The records after this offset will be queried. Constraints N/A Range N/A Default Value 0

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Definition 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. Constraints N/A Range application/json Default Value application/json
X-Auth-Token	Yes	String	Definition 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. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Request language type. Constraints N/A Range en-us: English zh-cn: Chinese Default Value en-us

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
object_with_column_infos	Array of objects	Definition Object related to column information. For details, see Table 5.

**Table 5** ObjectWithColumnInfo
Parameter	Type	Description
id	String	Definition Object ID. Constraints N/A Range N/A
parent_id	String	Definition Parent object ID. Constraints N/A Range N/A
type	String	Definition Object type. Constraints N/A Range N/A
name	String	Definition Object name. Constraints N/A Range N/A
alias_name	String	Definition Object alias. Constraints N/A Range N/A
notices	Array of strings	Definition Prompt information. For example, a message indicates that there are too many tables in the database. Constraints N/A Range N/A
extend_info	String	Definition Extended information. For example, a message indicates whether there is data and whether the structure exists in the destination database. Constraints N/A Range N/A
is_support_expand	Boolean	Definition Whether the query can be expanded. Constraints N/A Range true: The query can be expanded. false: The query cannot be expanded.
has_column_info	String	Definition Whether there is column information. Constraints N/A Range true: There is column information. false: There is no column information. partial: When the object type is database or schema, partial tables in the database or schema have column information.
is_preset	Boolean	Definition Whether the object is preset. Constraints N/A Range true: preset false: non-preset partial: When the object type is database or schema, partial tables in the database or schema are preset.
token_count	String	Definition Number of tokens. Constraints N/A Range N/A
is_sent	Boolean	Definition Whether the object information to which the column processing belongs has been delivered to the node. Constraints N/A Range true: The information has been delivered to the node. false: The information has not been delivered to the node.
sent_alias_name	String	Definition Alias of the object information which is delivered to the node. Constraints N/A Range N/A

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code returned when an error occurs during task execution. Constraints Minimum length: 12 characters Maximum length: 12 characters Range The format is DRS.XXXXXX.
error_msg	String	Definition Detailed error description returned when a task fails to be executed. Constraints Minimum length: 1 character Maximum length: 512 characters Range N/A

Example Request

Querying column processing (column mapping and column filtering) of all database-level objects

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

Example Response

Status code: 200

{ 
  "object_with_column_info" : [ { 
    "id" : "dws_test01", 
    "select" : "true", 
    "canExpand" : true, 
    "hasColumnInfo" : "false", 
    "objectType" : "database", 
    "objectName" : "dws_test01" 
  }, { 
    "id" : "test1", 
    "select" : "true", 
    "canExpand" : true, 
    "hasColumnInfo" : "true", 
    "objectType" : "database", 
    "objectName" : "test1" 
  } ] 
}

Status code: 400

Bad Request

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

Status Code

Status Code	Description
200	OK
400	Bad Request

For other statuses, see Status Code.

Error Code

For details, see Error Code.

Parent topic: Database Object Configuration

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

Next topic: Task Details