查询表的字段知识列表,包含字段元信息、业务描述、安全信息等
接口说明
查询表的字段知识列表,返回每个字段的元信息(类型、可空、自增等)、业务描述、术语、数据标准、安全等级与索引信息
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST / HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| DbId |
integer |
是 |
数据库 ID,可以调用 ListDatabases 接口获取。 |
1*** |
| TableName |
string |
是 |
表名 |
order_info |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回内容 |
||
| RequestId |
string |
Id of the request |
0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931 |
| ErrorCode |
string |
错误码。 |
UnknownError |
| ErrorMessage |
string |
错误信息。 |
UnknownError |
| Success |
boolean |
请求是否成功,返回值如下:
|
true |
| Data |
array |
字段知识列表 |
|
| ColumnKnowledgeVO |
返回的数据信息。 |
true |
示例
正常返回示例
JSON格式
{
"RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
"ErrorCode": "UnknownError",
"ErrorMessage": "UnknownError",
"Success": true,
"Data": [
{
"TableId": 0,
"ColumnId": 0,
"ColumnName": "",
"Position": 0,
"ColumnType": "",
"Description": "",
"AssetDescription": "",
"Title": "",
"AssetModifiedGmt": "",
"LevelType": "",
"Level": 0,
"HotLevel": 0,
"Nullable": true,
"AutoIncrement": true,
"ColumnKeyType": "",
"UserSensitivityLevel": "",
"Plain": true,
"SecurityLevel": ""
}
]
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。
该文章对您有帮助吗?