调用DescribeAllDataSource接口查询社区兼容版集群的数据库、表和列信息

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	DescribeAllDataSource	系统规定参数。取值：DescribeAllDataSource。
DBClusterId	String	是	cc-bp108z124a8o7****	集群ID。
SchemaName	String	是	database	数据库名。
TableName	String	是	table	表名。

返回数据


名称	类型	示例值	描述
RequestId	String	05321590-BB65-4720-8CB6-8218E041CDD0	请求ID。
Tables	Array of Table		表信息。
Table
TableName	String	table	表名。
DBClusterId	String	cc-bp108z124a8o7****	集群ID。
SchemaName	String	database	数据库名。
Columns	Array of Column		列信息。
Column
Type	String	String	列类型。
ColumnName	String	name	列名。
TableName	String	table	表名。
AutoIncrementColumn	Boolean	true	列是否自增，取值说明： true：自增。 false：不自增。
DBClusterId	String	cc-bp108z124a8o7****	集群ID。
PrimaryKey	Boolean	true	列是否为主键，取值说明： true：主键。 false：非主键。
SchemaName	String	database	数据库名。
Schemas	Array of Schema		数据库信息。
Schema
DBClusterId	String	cc-bp108z124a8o7****	集群ID。
SchemaName	String	database	数据库名。

示例

请求示例

http(s)://clickhouse.aliyuncs.com/?Action=DescribeAllDataSource
&DBClusterId=cc-bp108z124a8o7****
&SchemaName=database
&TableName=table
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeAllDataSourceResponse>
    <RequestId>05321590-BB65-4720-8CB6-8218E041CDD0</RequestId>
    <Tables>
        <TableName>table</TableName>
        <DBClusterId>cc-bp108z124a8o7****</DBClusterId>
        <SchemaName>database</SchemaName>
    </Tables>
    <Columns>
        <Type>String</Type>
        <ColumnName>name</ColumnName>
        <TableName>table</TableName>
        <AutoIncrementColumn>true</AutoIncrementColumn>
        <DBClusterId>cc-bp108z124a8o7****</DBClusterId>
        <PrimaryKey>true</PrimaryKey>
        <SchemaName>database</SchemaName>
    </Columns>
    <Schemas>
        <DBClusterId>cc-bp108z124a8o7****</DBClusterId>
        <SchemaName>database</SchemaName>
    </Schemas>
</DescribeAllDataSourceResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "05321590-BB65-4720-8CB6-8218E041CDD0",
  "Tables" : [ {
    "TableName" : "table",
    "DBClusterId" : "cc-bp108z124a8o7****",
    "SchemaName" : "database"
  } ],
  "Columns" : [ {
    "Type" : "String",
    "ColumnName" : "name",
    "TableName" : "table",
    "AutoIncrementColumn" : true,
    "DBClusterId" : "cc-bp108z124a8o7****",
    "PrimaryKey" : true,
    "SchemaName" : "database"
  } ],
  "Schemas" : [ {
    "DBClusterId" : "cc-bp108z124a8o7****",
    "SchemaName" : "database"
  } ]
}

错误码


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

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