查询对象的列信息（列映射、列过滤） - ShowColumnInfos
功能介绍
查询对象的列信息（列映射、列过滤）
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
POST /v5/{project_id}/job/{job_id}/column-info
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 |
|
job_id |
是 |
String |
任务ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
Content-Type |
否 |
String |
发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 |
|
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 |
|
X-Language |
否 |
String |
请求语言类型。 枚举值： |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
refresh |
是 |
Boolean |
是否重新从node获取列信息 |
|
object_ids |
否 |
Array of strings |
列所属的对象信息 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
column_map_infos |
Array of objects |
列映射信息 |
|
object_with_column_infos |
Array of objects |
和列信息相关的对象 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
object_id |
String |
对象id |
|
column_info_lists |
Array of objects |
列信息 详情请见表 ColumnInfo |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
column_name |
String |
列名 |
|
column_type |
String |
列类型 |
|
key_type |
String |
列的键类型。 |
|
column_mapped_name |
String |
列映射后的名称 |
|
status |
Boolean |
该列是否过滤 |
|
partition |
Boolean |
该列是否partitionKey |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
是否支持展开查询 |
|
has_column_info |
Boolean |
是否有列信息 |
|
is_preset |
Boolean |
是否预置 |
|
token_count |
String |
token个数 |
|
is_sent |
Boolean |
是否已经下发给node |
|
sent_alias_name |
String |
下发给node的别名 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
请求示例
查询对象的列信息
https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/jobs/fc77e18b-21c8-4040-96b5-ae599d3jb201/column-info
{
"object_ids" : [ "test-*-*-test2" ],
"refresh" : false
}
响应示例
状态码：200
OK
{
"column_map_infos" : [ {
"object_id" : "test-*-*-test2",
"column_info_lists" : [ {
"status" : true,
"partition" : false,
"column_name" : "id",
"column_type" : "int unsigned",
"primary_key_or_unique_index" : "PRI",
"column_mapped_name" : null
} ]
} ],
"object_with_column_infos" : [ ]
}
状态码：400
Bad Request
{
"error_code" : "DRS.10000001",
"error_msg" : "Failed."
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
错误码
请参见错误码。
