查询数据加工对象的附加列信息 - ListExtraColumns
功能介绍
查询数据加工对象的附加列信息
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/jobs/{job_id}/extra-column-info
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 |
| job_id | 是 | String | 任务ID。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| is_only_show_sent | 否 | Boolean | 是否仅查询已下发的加工对象，默认为否。 |
| offset | 否 | Integer | 偏移量，表示查询该偏移量后面的记录，默认为0。 |
| limit | 否 | Integer | 查询返回记录的数量限制，默认为10。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Content-Type | 否 | String | 发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 |
| X-Auth-Token | 是 | String | 从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 |
| X-Language | 否 | String | 请求语言类型。 枚举值： |
响应参数
状态码：200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total_count | Integer | 列表中的项目总数，与分页无关。 |
| column_process_objects | Array of objects | 列加工对象。 详情请参看ColumnProcessObjects。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| object_source_names | Array of strings | 选择的源库对象名。 |
| object_alias_name | String | 映射后的对象名。 |
| is_sent | Boolean | 附加列是否已下发。 |
| extra_column_infos | Array of objects | 附加列信息。 详情请参看AddColumnInfo。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| column_type | String | 列类型。 取值：default_value，create_time，update_time，expression，server_database_table |
| column_name | String | 列名称。 |
| column_value | String | 列填充值。 |
| data_type | String | 填充列的数据类型。 取值：int，long，varchar(256)，varchar(191)，datetime，timestamp |
状态码：400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误描述。 |
请求示例
查询已下发的数据加工对象的附加列信息
GET https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb201/extra-column-info?is_only_show_sent=true&limit=10&offset=0 响应示例
状态码：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
} 状态码：400
Bad Request
{
"error_code" : "DRS.10000010",
"error_msg" : "Job does not exist, please check job ID."
} 错误码
请参见错误码。
