Queries a list of databases.
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| DBInstanceId | string | Yes | The instance ID. Note
You can call the DescribeDBInstances operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.
| gp-xxxxxxxxx |
| RegionId | string | Yes | The region ID of the instance. | cn-beijing |
| SecretArn | string | Yes | The Alibaba Cloud Resource Name (ARN) of the access credential for the created Data API account. You can call the CreateSecret operation to create an access credential. Note
To call the DescribeTable operation as a Resource Access Management (RAM) user, the RAM user must have the permissions to call the UseSecret or GetSecretValue operation on the ARN of the access credential.
| acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ |
| Database | string | Yes | The name of the database. | testdb |
| MaxResults | integer | No | The maximum number of entries per page. Valid values: 1 to 100. | 50 |
| NextToken | string | No | The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken. | caeba0bbb2be03f84eb48b699f0a4883 |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
"Message": "success",
"Status": "success",
"NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
"Databases": {
"Databases": [
"acc_001"
]
}
}Error codes
For a list of error codes, visit the Service error codes.