Queries details about a database that is deployed in a PolarDB-X 1.0 instance.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeDrdsDB |
The operation that you want to perform. Set the value to DescribeDrdsDB. |
DbName | String | Yes | db_test |
The name of the database. |
DrdsInstanceId | String | Yes | drds********* |
The ID of the PolarDB-X 1.0 instance. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Data | Struct |
Indicates the details about the database. |
|
CreateTime | String | 1602050276000 |
Indicates the time when the database was created. The value is in the UNIX timestamp format. Unit: ms. |
DbInstType | String | RDS |
Indicates the storage type of the database. |
DbName | String | db_test |
Indicates the name of the database. |
InstRole | String | MASTER |
Indicates the type of the instance in which the database is deployed. Valid values:
|
Mode | String | HORIZONTAL |
Indicates the database sharding method.
|
Schema | String | db_test******************* |
Indicates the schema name of the database. |
Status | String | NORMAL |
Indicates the state of the database. Valid values:
|
RequestId | String | 58FB0EC7-CF71-4E48-92FB-CF070D****** |
Indicates the ID of the request. |
Success | Boolean | true |
Indicates whether the request is successful. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=DescribeDrdsDB
&DbName=db_test
&DrdsInstanceId=drds*********
&<Common request parameters>
Sample success responses
XML
format
<RequestId>58FB0EC7-CF71-4E48-92FB-CF070D******</RequestId>
<Data>
<Status>NORMAL</Status>
<DbInstType>RDS</DbInstType>
<InstRole>MASTER</InstRole>
<Schema>db_test*******************</Schema>
<Mode>HORIZONTAL</Mode>
<CreateTime>1602050276000</CreateTime>
<DbName>db_test</DbName>
</Data>
<Success>true</Success>
JSON
format
{"RequestId":"58FB0EC7-CF71-4E48-92FB-CF070D******","Data":{"Status":"NORMAL","DbInstType":"RDS","InstRole":"MASTER","Schema":"db_test*******************","Mode":"HORIZONTAL","CreateTime":"1602050276000","DbName":"db_test"},"Success":"true"}
Error codes
For a list of error codes, visit the API Error Center.