调用DescribeAllDataSource枚举数据库列表_云原生数据仓库AnalyticDB(AnalyticDB)-阿里云帮助中心

枚举实例下所有数据库列表、表列表和列列表。

调试

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

授权信息

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

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

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

请求参数

名称	类型	必填	描述	示例值
DBClusterId	string	是	数仓版集群 ID。说明您可以调用 DescribeDBClusters 接口查询目标地域中所有数仓版集群的集群 ID。	am-bp1pke2pcfavw****
SchemaName	string	是	数据库名称。	adb_demo
TableName	string	是	表名。	test

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	421794A3-72A5-5D27-9E8B-A75A4C503E17
Tables	array<object>	表信息。
Table	object	表列表。
TableName	string	表名。	test
DBClusterId	string	数仓版集群 ID。	am-bp1pke2pcfavw****
SchemaName	string	数据库名称。	adb_demo
Columns	array<object>	列信息。
Column	object	列列表。
Type	string	列数据类型。	bigint
ColumnName	string	列名	id
TableName	string	表名。	test
AutoIncrementColumn	boolean	列是否自增，取值说明： true：自增。 false：不自增。	true
DBClusterId	string	数仓版集群 ID。	am-bp1pke2pcfavw****
PrimaryKey	boolean	列是否为主键，取值说明： true：主键。 false：非主键。	false
SchemaName	string	数据库名。	adb_demo
Schemas	array<object>	数据库信息。
Schema	object	数据库列表。
DBClusterId	string	数仓版集群 ID。	am-bp1pke2pcfavw****
SchemaName	string	数据库名。	adb_demo

示例

正常返回示例

JSON格式

{
  "RequestId": "421794A3-72A5-5D27-9E8B-A75A4C503E17",
  "Tables": {
    "Table": [
      {
        "TableName": "test",
        "DBClusterId": "am-bp1pke2pcfavw****",
        "SchemaName": "adb_demo"
      }
    ]
  },
  "Columns": {
    "Column": [
      {
        "Type": "bigint",
        "ColumnName": "id",
        "TableName": "test",
        "AutoIncrementColumn": true,
        "DBClusterId": "am-bp1pke2pcfavw****",
        "PrimaryKey": false,
        "SchemaName": "adb_demo"
      }
    ]
  },
  "Schemas": {
    "Schema": [
      {
        "DBClusterId": "am-bp1pke2pcfavw****",
        "SchemaName": "adb_demo"
      }
    ]
  }
}

错误码

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

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