All Products
Search
Document Center

AnalyticDB for MySQL:DescribeAllDataSource

Last Updated:Mar 15, 2024

Queries a list of databases, tables, and columns in a cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
adb:DescribeAllDataSourceRead
  • DBCluster
    acs:adb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The ID of the cluster.

am-bp1xxxxxxxx47
SchemaNamestringYes

The name of the database.

adb_demo
TableNamestringYes

The name of the table.

test

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

1AD222E9-E606-4A42-BF6D-8A4442913CEF
Tablesobject []

The queried tables.

TableNamestring

The name of the table.

test
DBClusterIdstring

The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.

am-bp1xxxxxxxx47
SchemaNamestring

The name of the database.

adb_demo
Columnsobject []

The queried columns.

Typestring

The data type of the column.

bigint
ColumnNamestring

The name of the column.

id
TableNamestring

The name of the table.

test
AutoIncrementColumnboolean

Indicates whether the column is an auto-increment column. Valid values:

  • true
  • false
true
DBClusterIdstring

The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.

am-bp1xxxxxxxx47
PrimaryKeyboolean

Indicates whether the column is the primary key of the table. Valid values:

  • true
  • false
false
SchemaNamestring

The name of the database.

adb_demo
Schemasobject []

The queried databases.

DBClusterIdstring

The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.

am-bp1xxxxxxxx47
SchemaNamestring

The name of the database.

adb_demo

Examples

Sample success responses

JSONformat

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "Tables": {
    "Table": [
      {
        "TableName": "test",
        "DBClusterId": "am-bp1xxxxxxxx47",
        "SchemaName": "adb_demo"
      }
    ]
  },
  "Columns": {
    "Column": [
      {
        "Type": "bigint",
        "ColumnName": "id",
        "TableName": "test",
        "AutoIncrementColumn": true,
        "DBClusterId": "am-bp1xxxxxxxx47",
        "PrimaryKey": false,
        "SchemaName": "adb_demo"
      }
    ]
  },
  "Schemas": {
    "Schema": [
      {
        "DBClusterId": "am-bp1xxxxxxxx47",
        "SchemaName": "adb_demo"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.

For a list of error codes, visit the Service error codes.