DescribeDBInstanceDataSources - 查询DB或者Table的数据结构_云数据库 ClickHouse(ClickHouse)-阿里云帮助中心

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
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	object []	列类型。
DBName	string	数据库名称。	dbtest
Type	string	存储数据类型。	UInt64
TableName	string	表名。	tableTest
ColumnName	string	列名。	c31
PrimaryKey	string	列是否为主键，取值说明： true：主键。 false：非主键。	false
Comment	string	数据库账号的描述。	测试

示例

正常返回示例

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": "测试"
      }
    ]
  }
}

错误码

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

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史