Queries the database list in a specific storage instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeDbInstanceDbs

The operation that you want to perform. Set the value to DescribeDbInstanceDbs.

DbInstanceId String Yes pc-****************

The ID of the instance to which the storage-layer database belongs.
DrdsInstanceId String Yes drds************

The ID of the instance.
AccountName String No test

The name of the privileged account of Distributed Relational Database Service (DRDS). You do not need to specify this parameter if you have no privileged account.

Password String No pwd_111111

The password of the privileged account of DRDS. You do not need to specify this parameter if you have no privileged account.

DbInstType String No POLARDB

The storage type of the database. Valid values: POLARDB and RDS.

Response parameters

Parameter Type Example Description
Databases Array of Database

The list of database details.
Database
DbName String db_test

The name of the database.
Description String test

The description of the database.
Status Integer 1

The status of the database. Valid values:

  • 0: creating
  • 1: available
  • 3: deleting
RequestId String E9F3D991-08DE-4B74-BE0E-06B809******

The ID of the request.
Success Boolean true

The result of the request.
Total String 1

The total number of databases.

Examples

Sample requests

http(s)://drds.cn-hangzhou.aliyuncs.com/? Action=DescribeDbInstanceDbs
&DbInstanceId=pc-****************
&DrdsInstanceId=drds************
&<Common request parameters>

Sample success responses

XML format 

<Databases>
    <Database>
        <Status>1</Status>
        <Description>test</Description>
        <DbName>db_test</DbName>
    </Database>
</Databases>
<total>1</total>
<RequestId>E9F3D991-08DE-4B74-BE0E-06B809******</RequestId>
<Success>true</Success>

JSON format 

{
    "Databases": {
        "Database": [
        {
        "Status": 1,
        "Description": "test",
        "DbName": "db_test"
        }
        ]
    },
    "total":1,
    "RequestId": "E9F3D991-08DE-4B74-BE0E-06B809******",
    "Success": true
}

Error codes

HttpCode Error code Error message Description
400 ActionUnauthorized The specified action is not available for you The error message returned because you are not authorized to perform this action. Perform Resource Access Management (RAM) authorization first.

For a list of error codes, visit the API Error Center.