查询指定表的列列表信息。
接口说明
- 地域的公网接入地址：
adb.<region-id>.aliyuncs.com。示例：adb.cn-hangzhou.aliyuncs.com。 - 地域的 VPC 接入地址：
adb-vpc.<region-id>.aliyuncs.com。示例：adb-vpc.cn-hangzhou.aliyuncs.com。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 地域 ID。 | cn-hangzhou |
| DBClusterId | string | 是 | 企业版、基础版或湖仓版集群 ID。 | amv-bp1xxxxxxxx47 |
| SchemaName | string | 否 | 数据库名称。 | adb_demo |
| TableName | string | 否 | 查询表名。 | test |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "1AD222E9-E606-4A42-BF6D-XXX442913CEF",
"Items": {
"Column": [
{
"Type": "bigint",
"ColumnName": "id",
"TableName": "test",
"AutoIncrementColumn": true,
"DBClusterId": "amv-bp111m2cfrdl1****",
"PrimaryKey": false,
"SchemaName": "adb_demo"
}
]
}
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | MDS.IllegalArgument | Invalid argument. | 用户使用了非法参数 |
| 400 | MDS.InvalidPrivilege | No permissions. | 用户无权限进行操作 |
| 400 | MDS.MetaSchemaAlreadyExist | The database already exists. | 数据库已存在 |
| 400 | MDS.MetaSchemaNotExist | The database does not exist. | 操作的数据库不存在 |
| 400 | MDS.MetaTableAlreadyExist | The table already exists. | 操作的表已经存在 |
| 400 | MDS.MetaTableNotExist | The table is not found. | 操作的表不存在 |
| 403 | MDS.RamAuthAccessDenied | ram auth access denied. | ram鉴权失败 |
| 500 | MDS.InternalError | An internal MDS error occurred. | MDS服务内部错误 |
| 500 | MDS.MetaVisitError | Failed to access metadata. | 访问元数据失败 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-12-11 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2023-08-25 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2023-08-22 | OpenAPI 错误码发生变更 | 查看变更详情 |