使用DescribeDBInstanceDataSources查询数据库或表的数据结构-云数据库 ClickHouse-阿里云-云数据库 ClickHouse-阿里云帮助中心

调用DescribeDBInstanceDataSources接口查询DB或者Table的数据结构。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

clickhouse:DescribeDBInstanceDataSources

get

*EnterpriseDBCluster

acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。	cn-hangzhou
DBInstanceId	string	是	集群 ID。	cc-bp100p4q1g9z3****
DBName	string	否	数据库名称。	dbtest
TableName	string	否	表名称。	tableTest

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	F543E6CC-6868-523D-8D28-0E92CF977ED2
Data	object	返回结果。
DBInstanceId	string	集群 ID。	cc-bp100p4q1g9z3****
Schemas	string	账号。	default
Tables	array	表列表。
	string	表列表。	table_test
Columns	array<object>	列类型。
	object	列类型。
DBName	string	数据库名称。	dbtest
Type	string	存储数据类型。	UInt64
TableName	string	表名。	tableTest
ColumnName	string	列名。	c31
PrimaryKey	string	列是否为主键，取值说明： true：主键。 false：非主键。	false
Comment	string	数据库账号的描述。	Test

示例

正常返回示例

JSON格式

{
  "RequestId": "F543E6CC-6868-523D-8D28-0E92CF977ED2",
  "Data": {
    "DBInstanceId": "cc-bp100p4q1g9z3****",
    "Schemas": "default",
    "Tables": [
      "table_test"
    ],
    "Columns": [
      {
        "DBName": "dbtest",
        "Type": "UInt64",
        "TableName": "tableTest",
        "ColumnName": "c31",
        "PrimaryKey": "false",
        "Comment": "Test"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
404	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in our records.

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

变更历史

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