获取数据源中表的字段
功能介绍
获取数据源中表的字段
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/{connection_id}/datatables/{table_id}/columns
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
项目ID，获取方法请参见项目ID和账号ID。 最小长度：1 最大长度：128 |
connection_id |
是 |
String |
数据连接id，可通过数据连接列表中获取。 最小长度：1 最大长度：128 |
table_id |
是 |
String |
数据表的id信息 最小长度：1 最大长度：128 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
limit |
否 |
String |
数据条数限制 最小长度：1 最大长度：16 |
offset |
否 |
String |
偏移量 最小长度：1 最大长度：16 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token，使用Token认证时必选。通过调用ManageOne平台的IAM服务的“获取用户Token”接口获取响应消息头中X-Subject-Token的值。 最小长度：0 最大长度：4096 |
workspace |
是 |
String |
数据所在空间的id值 最小长度：1 最大长度：128 |
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
table_id |
String |
数据表的id信息 最小长度：1 最大长度：128 |
total_count |
Integer |
当前表中字段记录数 最小值：0 最大值：100 |
columns |
Array of ColumnsList objects |
字段列表 数组长度：0 - 100 |
参数 |
参数类型 |
描述 |
|---|---|---|
comment |
String |
字段注解 最小长度：1 最大长度：128 |
column_name |
String |
字段名称 最小长度：1 最大长度：128 |
column_type |
String |
字段类型 最小长度：1 最大长度：128 |
seq_number |
Integer |
字段的顺序 最小值：0 最大值：100 |
primary |
Boolean |
字段是否为主键 缺省值：false |
partition_col |
Boolean |
是否对字段进行分割 缺省值：false |
状态码： 400
参数 |
参数类型 |
描述 |
|---|---|---|
error_msg |
String |
返回的错误信息。 最小长度：1 最大长度：1024 |
error_code |
String |
返回的错误码。 最小长度：1 最大长度：1024 |
状态码： 500
参数 |
参数类型 |
描述 |
|---|---|---|
error_msg |
String |
返回的错误信息。 最小长度：1 最大长度：1024 |
error_code |
String |
返回的错误码。 最小长度：1 最大长度：1024 |
请求示例
无
响应示例
状态码： 200
Success，返回字段列表
{
"columns" : [ {
"comment" : "",
"column_name" : "age",
"column_type" : "integer",
"seq_number" : 2,
"primary" : false,
"partition_col" : false
}, {
"comment" : "",
"column_name" : "address",
"column_type" : "character varying",
"seq_number" : 3,
"primary" : false,
"partition_col" : false
}, {
"comment" : "",
"column_name" : "phonenum",
"column_type" : "character varying",
"seq_number" : 4,
"primary" : false,
"partition_col" : false
} ],
"total_count" : 7,
"table_id" : "NativeTable-9b18c0ad6ef5404caef4e6cbaccdae6f-postgres-dm_autotest-QQQQQQQstudents_infoweq"
}
状态码： 400
{
"error_code" : "DAYU.4402",
"error_msg" : "The operation failed， detail msg {0}."
}
状态码： 500
{
"error_code" : "DAYU.3531",
"error_msg" : "Internal server error: {0}"
}
状态码
状态码 |
描述 |
|---|---|
200 |
Success，返回字段列表 |
400 |
BadRequest |
500 |
Internal Server Error |
