文档

DescribeAllDataSource - 枚举数据库列表

更新时间:

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
adb:DescribeAllDataSourceRead
  • DBCluster
    acs:adb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

请求参数

名称类型必填描述示例值
DBClusterIdstring

AnalyticDB MySQL 数仓版(3.0)集群 ID。

说明 您可以调用 DescribeDBClusters 接口查询目标地域中所有 AnalyticDB MySQL 数仓版(3.0)集群的集群 ID。
am-bp1pke2pcfavw****
SchemaNamestring

数据库名称。

adb_demo
TableNamestring

表名。

test

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

421794A3-72A5-5D27-9E8B-A75A4C503E17
Tablesobject []

表信息。

TableNamestring

表名。

test
DBClusterIdstring

AnalyticDB MySQL 数仓版(3.0)集群 ID。

am-bp1pke2pcfavw****
SchemaNamestring

数据库名称。

adb_demo
Columnsobject []

列信息。

Typestring

列数据类型。

bigint
ColumnNamestring

列名

id
TableNamestring

表名。

test
AutoIncrementColumnboolean

列是否自增,取值说明:

  • true:自增。
  • false:不自增。
true
DBClusterIdstring

AnalyticDB MySQL 数仓版(3.0)集群 ID。

am-bp1pke2pcfavw****
PrimaryKeyboolean

列是否为主键,取值说明:

  • true:主键。
  • false:非主键。
false
SchemaNamestring

数据库名。

adb_demo
Schemasobject []

数据库信息。

DBClusterIdstring

AnalyticDB MySQL 数仓版(3.0)集群 ID。

am-bp1pke2pcfavw****
SchemaNamestring

数据库名。

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错误码错误信息描述
404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.您指定的 DBClusterId 不存在,请确认 DBClusterId 值是否正确。

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

  • 本页导读 (1)
文档反馈