Use DescribeAllDataSource to query databases, tables, and columns - AnalyticDB - Alibaba Cloud - AnalyticDB

Enumerates all databases, tables, and columns in a specified cluster.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

adb:DescribeAllDataSource

get

DBCluster

acs:adb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The ID of the Data Warehouse Edition cluster. Note You can call the DescribeDBClusters operation to query the IDs of all Data Warehouse Edition clusters in a region.	am-bp1pke2pcfavw****
SchemaName	string	Yes	The name of the database.	adb_demo
TableName	string	Yes	The name of the table.	test

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	421794A3-72A5-5D27-9E8B-A75A4C503E17
Tables	object
Table	array<object>	The table information.
	object	The list of tables.
TableName	string	The name of the table.	test
DBClusterId	string	The ID of the Data Warehouse Edition cluster.	am-bp1pke2pcfavw****
SchemaName	string	The name of the database.	adb_demo
Columns	object
Column	array<object>	The column information.
	object	The list of columns.
Type	string	The data type of the column.	bigint
ColumnName	string	The name of the column.	id
TableName	string	The name of the table.	test
AutoIncrementColumn	boolean	Indicates whether the column is an auto-increment column. Valid values: true: The column is an auto-increment column. false: The column is not an auto-increment column.	true
DBClusterId	string	The ID of the Data Warehouse Edition cluster.	am-bp1pke2pcfavw****
PrimaryKey	boolean	Indicates whether the column is a primary key column. Valid values: true: The column is a primary key column. false: The column is not a primary key column.	false
SchemaName	string	The name of the database.	adb_demo
Schemas	object
Schema	array<object>	The database information.
	object	The list of databases.
DBClusterId	string	The ID of the Data Warehouse Edition cluster.	am-bp1pke2pcfavw****
SchemaName	string	The name of the database.	adb_demo

Examples

Success response

JSON format

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "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"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.