文档首页> 数据复制服务 DRS> API参考> API v5（公测中）> 数据加工> 获取指定数据库表列信息
更新时间：2023-10-24 GMT+08:00
在线调试
CLI示例
查看PDF

获取指定数据库表列信息

功能介绍

获取指定数据库表列信息。

URI

GET /v5/{project_id}/job/{job_id}/columns

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的Project ID。

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

job_id

是

String

任务ID。
表2 Query参数

参数

是否必选

参数类型

描述

query_id

是

String

指定数据库表的列信息采集的ID，提交采集指定数据库表的列信息接口返回的ID。

offset

否

Integer

偏移量，表示查询该偏移量后面的记录。

limit

否

Integer

查询返回记录的数量限制。

请求参数

表3 请求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

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

results

Array of objects

指定数据库表列信息。

详情请参见表5。

total_count

Integer

列表中的项目总数，与分页无关。
表5 results字段数据结构说明

参数

参数类型

描述

db_name

String

数据库库名称。

schema_name

String

数据库schema名称。

table_name

String

数据库表名称。

column_infos

Array of objects

数据库列信息。

详情请参见表6。

total_count

Integer

数据库列信息总数，与分页无关，仅作为返回体参数。
表6 column_infos字段数据结构说明

参数

参数类型

描述

column_name

String

列名。

column_type

String

列类型。

primary_key_or_unique_index

String

主键或者唯一索引。

column_mapped_name

String

列映射后的名称。

is_filtered

Boolean

该列是否过滤。

is_partition_key

Boolean

该列是否partitionKey。

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

最小长度：12

最大长度：12

error_msg

String

错误描述。

最小长度：1

最大长度：512

请求示例

获取指定数据库表列信息：

GET https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/job/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r/columns?query_id=0eacda0b-9422-4535-8b62-537d1833638b

响应示例

状态码： 200

OK

{
  "results" : [ {
    "db_name" : "testdb02",
    "table_name" : "test5",
    "column_infos" : [ {
      "column_name" : "id",
      "column_type" : "NUMBER",
      "primary_key_or_unique_index" : "PRI",
      "column_mapped_name" : null,
      "is_filtered" : false,
      "is_partition_key" : false
    }, {
      "column_name" : "C1",
      "column_type" : "VARCHAR2",
      "primary_key_or_unique_index" : "",
      "column_mapped_name" : null,
      "is_filtered" : false,
      "is_partition_key" : false
    }, {
      "column_name" : "C2",
      "column_type" : "VARCHAR2",
      "primary_key_or_unique_index" : "",
      "column_mapped_name" : null,
      "is_filtered" : false,
      "is_partition_key" : false
    } ],
    "total_count" : 3
  } ],
  "total_count" : 1
}

状态码： 400

Bad Request

{
  "error_code" : "DRS.10000010",
  "error_msg" : "Job does not exist, please check job ID."
}

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码。

父主题： 数据加工