获取表字段信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dms:ListTableColumns | get | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Tid | long | 否 | 租户 ID，可通过调用接口 GetUserActiveTenant 或 ListUserTenants 获取该参数的值。 | 3*** |
| DbId | integer | 是 | 物理库 ID：可通过调用接口 ListDatabases 或 SearchDatabase 获取该参数的值。 | 123 |
| TableName | string | 是 | 表名。 说明
您可以通过调用接口 ListTables 获取该参数的值。
| 100g_customer |
| TableSchemaName | string | 否 | 表模式名，仅当 SQLServer 需要传递为架构名。 | dbo |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
"ErrorCode": "UnknownError",
"ColumnList": {
"Column": [
{
"ColumnId": 12345,
"ColumnType": "varchar",
"Description": "column desc",
"AutoIncrement": false,
"FunctionType": "NULL",
"DataPrecision": 0,
"DefaultValue": "aaa",
"ColumnName": "c1",
"SecurityLevel": "INNER",
"DataScale": 0,
"DataLength": 32,
"Sensitive": false,
"Nullable": true
}
]
},
"ErrorMessage": "UnknownError",
"Success": true
}错误码
访问错误中心查看更多错误码。