All Products
Search
Document Center

AnalyticDB:DescribeAdbMySqlSchemas

Last Updated:Sep 11, 2024

Queries a list of databases for an AnalyticDB for MySQL cluster.

Operation description

  • Regional public endpoint: adb.<region-id>.aliyuncs.com. Example: adb.cn-hangzhou.aliyuncs.com.
  • Regional Virtual Private Cloud (VPC) endpoint: adb-vpc.<region-id>.aliyuncs.com. Example: adb-vpc.cn-hangzhou.aliyuncs.com.

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:DescribeAdbMySqlSchemaslist
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID.

Note You can call the DescribeRegions operation to query the most recent region list.
cn-hangzhou
DBClusterIdstringYes

The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.

amv-bp1r053byu48p****

Response parameters

ParameterTypeDescriptionExample
object
Messagestring

The returned message.

  • If the request was successful, a success message is returned.
  • If the request failed, an error message is returned.
Success
RequestIdstring

The request ID.

1AD222E9-E606-4A42-BF6D-8A4442913CEF
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
Schemasarray

The queried databases.

string

The name of the database.

adb_demo,adb_test,mysql

Examples

Sample success responses

JSONformat

{
  "Message": "Success",
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "Success": true,
  "Schemas": [
    "adb_demo,adb_test,mysql"
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history