View the database details under an 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 DescribeDrdsDB

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

DbName String Yes db_test

Database Name

DrdsInstanceId String Yes drdshbgadm******

Instance id

AccessKeyId String No xxxxxxxxxx

The ID key. For more information, see Common parameters.

Response parameters

Prameter Type Sample response Description
Data

Database details

CreateTime String 1568949855000

Database creation timestamp

DbInstType String RDS

Database storage type: RDS or POLARDB

DbName String db_0

Database Name

InstRole String MASTER

Database type: primary instance, SLAVE read-only instance

Mode String HORIZONTAL

HORIZONTAL indicates HORIZONTAL partitioning, and VERTICAL indicates VERTICAL partitioning.

Schema String db_0_15689499065******

The physical name of the database.

Status String NORMAL

The format is database-shaped. TO_BE_INIT: Creating. NORMAL: running.

RequestId String 05203D07-8447-48D0-BED5-2F00BF******

The ID of the request.

Success Boolean true

The result of the operation.

Examples

Sample request


http(s)://[Endpoint]/? Action=DescribeDrdsDB
&DbName=db_test
&DrdsInstanceId=drdshbgadm******
& <Common request parameters>

Sample success responses

XML format

<DescribeDrdsDBResponse>
	  <RequestId>45203D07-8447-48D0-BED5-2F00BF******</RequestId>
	  <Data>
		    <Status>NORMAL</Status>
		    <DbInstType>RDS</DbInstType>
		    <InstRole>MASTER</InstRole>
		    <Schema>db_0_15689499065******</Schema>
		    <CreateTime>1568949855000</CreateTime>
		    <Mode>HORIZONTAL</Mode>
		    <DbName>db_0</DbName>
	  </Data>
	  <Success>true</Success>
</DescribeDrdsDBResponse>

JSON format

{
	"Data":{
		"Status":"NORMAL",
		"DbName":"db_0",
		"CreateTime":1568949855000,
		"Schema":"db_0_15689499065******",
		"DbInstType":"RDS",
		"Mode":"HORIZONTAL",
		"InstRole":"MASTER"
	},
	"RequestId":"45203D07-8447-48D0-BED5-2F00BF******",
	"Success":true
}

Error codes

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