Queries all databases that are deployed in a PolarDB-X instance.
Request parameters
Parameter | Type | Required | Description |
|---|---|---|---|
Action | String | Yes | The operation that you want to perform. Set the value to DescribeDrdsDBs. |
DrdsInstanceId | String | Yes | The ID of the PolarDB-X instance. |
Response parameters
Parameter | Type | Description |
|---|---|---|
Items | List<DrdsDB> | The list that contains the details about each PolarDB-X database. |
Parameters returned for each Distributed Relational Database Service (DRDS) database
Parameter | Type | Description |
|---|---|---|
DbName | String | The name of the database. |
Status | String |
|
CreateTime | Long | The time when the database was created. |
Msg | String | The state details. If the value of the Status parameter is 2, 4, or 6, an error message is returned. |
Mode | String | The running mode of the database. |
Error codes
Error code | Error message | Description | HTTP status code |
|---|---|---|---|
InvalidDrdsInstanceId.NotFound | The DrdsInstanceId provided does not exist in our records. | The error message returned because the instance does not exist. | 404 |