查询集群指定表的列信息。
接口说明
- 地域的公网接入地址:
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对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
adb:DescribeAdbMySqlColumns | list |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域 ID。 说明
您可以调用 DescribeRegions 接口查看指定集群的地域 ID。
| cn-hangzhou |
DBClusterId | string | 是 | 企业版、基础版或湖仓版集群 ID。 说明
您可以调用 DescribeDBClusters 接口查看目标地域下所有集群的集群 ID。
| amv-bp1r053byu48p**** |
Schema | string | 否 | 数据库名称。 | adb_demo |
TableName | string | 否 | 表名称。 | test |
返回参数
示例
正常返回示例
JSON
格式
{
"Message": "Success",
"RequestId": "A9F013CD-0222-595E-8157-445969B97F03",
"Success": true,
"Schema": "adb_demo",
"TableName": "test",
"ColumnCount": 1,
"Columns": [
{
"Type": "bigint",
"Name": "id",
"Comment": "test"
}
]
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-11-02 | API 内部配置变更,不影响调用 | 查看变更详情 |