调用DescribeColumns查看列_云数据库 ClickHouse-阿里云帮助中心

查看列。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

clickhouse:DescribeColumns

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
DBClusterId	string	是	集群 ID。	cc-2zeux3ua25242****
SchemaName	string	是	数据库名。您可以通过调用接口 DescribeSchemas 查询数据库名。	database
TableName	string	是	表名。您可以通过调用接口 DescribeTables 查询表名。	table

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	66428721-FFEC-5023-B4E5-3BD1B67837E0
Items	object
Column	array<object>	列信息。
	object	列信息。
Type	string	列类型。	String
ColumnName	string	列名。	name
TableName	string	表名。	table
AutoIncrementColumn	boolean	列是否自增，取值说明： true：自增。 false：不自增。	true
DBClusterId	string	集群 ID。	cc-2zeux3ua25242****
PrimaryKey	boolean	列是否为主键，取值说明： true：主键。 false：非主键。	true
SchemaName	string	数据库名。	database

示例

正常返回示例

JSON格式

{
  "RequestId": "66428721-FFEC-5023-B4E5-3BD1B67837E0",
  "Items": {
    "Column": [
      {
        "Type": "String",
        "ColumnName": "name",
        "TableName": "table",
        "AutoIncrementColumn": true,
        "DBClusterId": "cc-2zeux3ua25242****",
        "PrimaryKey": true,
        "SchemaName": "database"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
500	InternalError	An error occurred while processing your request.	系统内部错误，请稍后重试
503	ServiceUnavailable	An error occurred while processing your request.	系统暂时不可用，请稍后重试

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

变更历史

更多信息，参考变更详情。