DescribeColumns - 枚举实例下指定表格的列列表 - 云原生数据仓库AnalyticDB

调用DescribeColumns接口枚举实例下指定表格的列列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
adb:DescribeColumns	get	*DBCluster `acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	无	无

请求参数

名称	类型	必填	描述	示例值
DBClusterId	string	是	实例 ID。	am-bp1xxxxxxxx47
SchemaName	string	是	数据库名。	adb_demo
TableName	string	是	表名。	test

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	1AD222E9-E606-4A42-BF6D-8A4442913CEF
Items	array<object>	列列表。
Column	object
Type	string	列数据类型。	bigint
ColumnName	string	列名。	id
TableName	string	表名。	test
AutoIncrementColumn	boolean	是否自增。	true
DBClusterId	string	实例 ID。	am-bp1xxxxxxxx47
PrimaryKey	boolean	是否主键。	false
SchemaName	string	数据库名。	adb_demo

示例

正常返回示例

JSON格式

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "Items": {
    "Column": [
      {
        "Type": "bigint",
        "ColumnName": "id",
        "TableName": "test",
        "AutoIncrementColumn": true,
        "DBClusterId": "am-bp1xxxxxxxx47",
        "PrimaryKey": false,
        "SchemaName": "adb_demo"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。

访问错误中心查看更多错误码。