Queries the database details of a specified 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 DescribeDrdsDBs

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

DrdsInstanceId String Yes drds************

The ID of the instance.

PageNumber Integer No 1

The page number. The value must be a positive integer that does not exceed the maximum value of the Integer data type. Default value: 1.

PageSize Integer No 30

The number of entries to return on each page. Valid values: 30, 50, and 100.

Default value: 30.

Response parameters

Parameter Type Example Description
Data Array of Db

The list of databases.

Db
CreateTime String 1563773824000

The time when the database was created. The value is in the UNIX timestamp format. Unit: ms.

DbInstType String RDS

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

DbName String drds_test

The name of the database.

Mode String HORIZONTAL

The partition mode of the database. Valid values:

  • HORIZONTAL: horizontal partitioning
  • VERTICAL: vertical partitioning
Schema String drds_test_1563773871118kxqd

The schema ID that is assigned to the partitioned database by the system.

Status String NORMAL

The status of the database.

PageNumber String 1

The page number of the returned page.

PageSize String 30

The number of entries on the returned page.

RequestId String 006B7D19-8CDB-4AA6-AAE7-23C107******

The ID of the request.

Success Boolean true

Indicates whether the request is successful.

Total String 1

The number of database lists.

Examples

Sample requests

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

Sample success responses

XML format

<DescribeDrdsDBsResponse>
  <PageSize>30</PageSize>
  <RequestId>006B7D19-8CDB-4AA6-AAE7-23C107******</RequestId>
  <PageNumber>1</PageNumber>
  <Total>1</Total>
  <Data>
        <Db>
              <Status>NORMAL</Status>
              <DbInstType>RDS</DbInstType>
              <Schema>drds_test_1563773871118kxqd</Schema>
              <CreateTime>1563773824000</CreateTime>
              <Mode>HORIZONTAL</Mode>
              <DbName>drds_test</DbName>
        </Db>
  </Data>
  <Success>true</Success>
</DescribeDrdsDBsResponse>

JSON format

{
    "PageSize": 30,
    "RequestId": "006B7D19-8CDB-4AA6-AAE7-23C107******",
    "PageNumber": 1,
    "Total": 1,
    "Data": {
        "Db": [
            {
                "Status": "NORMAL",
                "DbInstType": "RDS",
                "Schema": "drds_test_1563773871118kxqd",
                "CreateTime": 1563773824000,
                "Mode": "HORIZONTAL",
                "DbName": "drds_test"
            }
        ]
    },
    "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.