文档首页/数据复制服务 DRS/API参考/API v5（公测中）/数据加工/采集指定数据库表的列信息 - CollectColumns
更新时间：2025-12-04 GMT+08:00
在线调试
CLI示例
查看PDF
分享

采集指定数据库表的列信息 - CollectColumns

功能介绍

采集指定数据库表的列信息。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

POST /v5/{project_id}/job/{job_id}/columns/collect

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的Project ID。

获取方法请参见获取项目ID。

job_id

是

String

任务ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。

缺省值：application/json

X-Auth-Token

是

String

从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

否

String

请求语言类型。

缺省值：en-us

枚举值：

  • en-us
  • zh-cn
表3 请求Body参数

参数

是否必选

参数类型

描述

is_force_refresh

否

Boolean

是否从Node获取最新的列信息。

db_object_infos

是

Array of objects

指定数据库表信息。

详情请参见表4。

表4 db_object_infos字段数据结构说明

参数

是否必选

参数类型

描述

db_name

是

String

数据库名称。

schema_name

否

String

数据库schema名称。

table_name

是

String

数据库表名称。

响应参数

状态码：202

表5 响应Body参数

参数

参数类型

描述

id

String

查询结果id

job_id

String

任务ID。

status

String

查询状态

枚举值：

  • pending
  • failed
  • success

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

最小长度：12

最大长度：12

error_msg

String

错误描述。

最小长度：1

最大长度：512

请求示例

采集指定数据库表的列信息：

POST https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/job/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r/columns/collect

{
  "is_force_refresh" : false,
  "db_object_infos" : [ {
    "db_name" : "testDb",
    "schema_name" : "testSchema",
    "table_name" : "testTable"
  } ]
}

响应示例

状态码：202

Accept

{
  "id" : "0eacda0b-9422-4535-8b62-537d1833638b",
  "job_id": "177738d1-4eee-4fcb-a4e1-09aea79jb20i",
  "status" : "pending"
}

状态码：400

Bad Request

{
  "error_code" : "DRS.10030016",
  "error_msg" : "Query column info failed"
}

状态码

状态码

描述

202

Accept

400

Bad Request

错误码

请参见错误码。

父主题：数据加工