文档

DescribeAdbMySqlColumns - 查询表的列信息

更新时间:

查询集群指定表的列信息。

接口说明

  • 地域的公网接入地址: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:DescribeAdbMySqlColumnslist
  • 全部资源
    *

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。

说明 您可以调用 DescribeRegions 接口查看指定集群的地域 ID。
cn-hangzhou
DBClusterIdstring

企业版、基础版或湖仓版集群 ID。

说明 您可以调用 DescribeDBClusters 接口查看目标地域下所有集群的集群 ID。
amv-bp1r053byu48p****
Schemastring

数据库名称。

adb_demo
TableNamestring

表名称。

test

返回参数

名称类型描述示例值
object
Messagestring

调用结果的附加信息。取值说明:

  • 请求正常,返回 Success
  • 请求异常,返回具体异常错误码。
Success
RequestIdstring

请求 ID。

A9F013CD-0222-595E-8157-445969B97F03
Successboolean

调用是否成功。

  • true:成功。
  • false:失败。
true
Schemastring

数据库名称。

adb_demo
TableNamestring

表名。

test
ColumnCountinteger

总列数。

1
Columnsarray<object>

列信息。

object

列信息。

Typestring

列的数据类型。

bigint
Namestring

列名。

id
Commentstring

列注释。

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-02API 内部配置变更,不影响调用查看变更详情