# 查询对象的列加工（列映射、列过滤）情况 - ShowObjectColumnInfo #### 功能介绍 查询对象的列加工（列映射、列过滤）情况 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-drs/drs_api_0035.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI GET /v5/{project_id}/job/{job_id}/object-column-info 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 租户在某一Region下的Project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-drs/drs_api_0106.html)。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及 | | job_id | 是 | String | **参数解释**： 任务ID，用于唯一标识一个数据复制任务，在查询、修改、删除等操作中作为任务的识别凭证。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | object_id | 否 | String | **参数解释**： 对象id。不填时默认查询库级的对象。 **约束限制**： 不涉及。 **取值范围**： 不涉及 **默认取值**： 不涉及 | | is_refresh | 否 | Boolean | **参数解释**： 是否强制刷新查询结果。 **约束限制**： 不涉及。 **取值范围**： - true 强制刷新 - false 不强制刷新 **默认取值**： false | | limit | 否 | Integer | **参数解释**： 查询返回记录的数量限制，用于分页查询时控制每页返回的数据条数。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 10 | | offset | 否 | Integer | **参数解释**： 偏移量，表示查询该偏移量后面的记录，用于分页查询。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 0 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | Content-Type | 是 | String | **参数解释**： 发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 **约束限制：** 不涉及。 **取值范围：** application/json **默认取值：** application/json | | X-Auth-Token | 是 | String | **参数解释**： 从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | X-Language | 否 | String | **参数解释**： 请求语言类型。 **约束限制：** 不涉及。 **取值范围：** - **en-us**：英语 - **zh-cn**：中文 **默认取** **值：** **en-us** | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | object_with_column_infos | Array of objects | **参数解释**： 和列信息相关的对象。 详情请参见[表5]。 | 表5ObjectWithColumnInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： 对象id。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | parent_id | String | **参数解释**： 父对象id。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | type | String | **参数解释**： 对象类型。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | name | String | **参数解释**： 对象名称。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | alias_name | String | **参数解释**： 对象别名。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | notices | Array of strings | **参数解释**： 提示信息，例如提示库下表过多。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | extend_info | String | **参数解释**： 扩展信息，例如提示有无数据,结构是否在目标库中存在。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | is_support_expand | Boolean | **参数解释**： 是否支持展开查询。 **约束限制**： 不涉及。 **取值范围**： - true 支持展开查询 - false 不支持展开查询 | | has_column_info | String | **参数解释**： 是否有列信息。 **约束限制**： 不涉及。 **取值范围**： - true 有列信息 - false 没有列信息 - partial 对象类型为database或schema时，库或schema中部分表有列信息 | | is_preset | Boolean | **参数解释**： 是否预置。 **约束限制**： 不涉及。 **取值范围**： - true 预置 - false 非预置 - partial 对象类型为database或schema时，库或schema中部分表预置 | | token_count | String | **参数解释**： token个数。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | | is_sent | Boolean | **参数解释**： 列加工所属的对象信息是否已经下发给node。 **约束限制**： 不涉及。 **取值范围**： - true 已经下发给node - false 暂未下发给node | | sent_alias_name | String | **参数解释**： 下发给node的列加工所属对象信息的别名。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 | **状态码：400** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码，当任务报错时返回的错误代码。 **约束限制**： - 最小长度：12 - 最大长度：12 **取值范围**： 格式为DRS.XXXXXX。 | | error_msg | String | **参数解释**： 错误详细信息，当任务执行失败时返回的具体错误描述。 **约束限制**： - 最小长度：1 - 最大长度：512 **取值范围**： 不涉及。 | #### 请求示例 查询所有库级对象的列加工（列映射、列过滤）情况 ``` https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/jobs/fc77e18b-21c8-4040-96b5-ae599d3jb201/object-column-info ``` #### 响应示例 **状态码：200** OK ``` { "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" } ] } ``` **状态码：400** Bad Request ``` { "error_code" : "DRS.10000001", "error_msg" : "Failed." } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | Bad Request | 其他状态请参见[状态码](https://support.huaweicloud.com/api-drs/drs_api_0108.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-drs/drs_05_0004.html)。