Call the interface DescribeDrdsDbInstance to view RDS instance details for a DRDS 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 Required DescribeDrdsDbInstance

The operation that you want to perform. Set this parameter to DescribeDrdsDbInstance.

DbInstanceId String Required rm-bp13z14u0iyk9trrw

DRDS storage instance ID

DbName String Required drds_test

DRDS database name

DrdsInstanceId String Required drdssen1243as

DRDS instance ID

AccessKeyId String No ASU678UDIN9HdlahDHH

Access Key

Response parameters

Parameter Type Example Description
DbInstance

DRDS instance details

ConnectUrl String rm-**************.mysql.rds.aliyuncs.com

Connection URL

DBInstanceId String rm-**************

Instance ID

DBInstanceStatus String 1

Instance state

DbInstType String Primary

Instance Type

Engine String MySQL

Instance engine

EngineVersion String 5.7

The engine version of the instance.

ExpireTime String 12341434315

The timestamp when the instance expires.

NetworkType String VPC

The network type of the instance.

PayType String Postpaid

Instance purchase type

Port Integer 3306

Instance access port

RdsInstType String RDS

Instance Type

ReadOnlyInstances

Read-Only instances

ReadOnlyInstance

Read-Only instances

ConnectUrl String rm-*************.mysql.rds.aliyuncs.com

Connection URL

DBInstanceId String rm-**************

Instance ID

DBInstanceStatus String 1

Instance state

DbInstType String RDS

Instance Type

Engine String MySQL

Instance engine

EngineVersion String 5.7

The engine version of the instance.

ExpireTime String 1823487328173

The timestamp when the instance expires.

NetworkType String VPC

The network type of the instance.

PayType String Postpaid

Instance purchase type

Port Integer 3306

Instance access port

RdsInstType String RDS

Instance Type

ReadWeight Integer 30

Instance read ratio

RemainDays String 0

The remaining validity period of the instance.

VersionAction Integer 0

Invalid field

ReadWeight Integer 70

Instance read ratio

RemainDays String 0

The remaining validity period of the instance.

RequestId String 2F7F8080-9132-4279-85D0-B7E5C4******

The ID of the request.

Success Boolean true

Indicates whether the call is successful.

Examples

Sample requests


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

Sample success responses

XML format

<DescribeDrdsDbInstance>
	  <RequestId>2F7F8080-9132-4279-85D0-B7E5C4305162</RequestId>
	  <DbInstance>
		    <DbInstType>RDS</DbInstType>
		    <ReadOnlyInstances></ReadOnlyInstances>
		    <EngineVersion>5.7</EngineVersion>
		    <DBInstanceStatus>1</DBInstanceStatus>
		    <Port>3306</Port>
		    <PayType>Postpaid</PayType>
		    <ReadWeight>100</ReadWeight>
		    <ConnectUrl>rm-bp1ub71ct9skc3y.mysql.rds.aliyuncs.com</ConnectUrl>
		    <DBInstanceId>rm-bp1ub71ct9skc3y</DBInstanceId>
		    <NetworkType>VPC</NetworkType>
		    <RdsInstType>Primary</RdsInstType>
		    <ExpireTime></ExpireTime>
		    <RemainDays>0</RemainDays>
		    <Engine>MySQL</Engine>
	  </DbInstance>
	  <Success>true</Success>
</DescribeDrdsDbInstance>

JSON format

{
	"DbInstance":{
		"RemainDays":0,
		"ReadOnlyInstances":{
			"ReadOnlyInstance":[]
		},
		"DBInstanceId":"rm-bp1ub71ct9skc3y",
		"ReadWeight":100,
		"RdsInstType":"Primary",
		"DbInstType":"RDS",
		"ConnectUrl":"rm-bp1ub71ct9skc3y.mysql.rds.aliyuncs.com",
		"Engine":"MySQL",
		"NetworkType":"VPC",
		"Port":3306,
		"ExpireTime":"",
		"EngineVersion":"5.7",
		"DBInstanceStatus":1,
		"PayType":"Postpaid"
	},
	"RequestId":"2F7F8080-9132-4279-85D0-B7E5C4305162",
	"Success":true
}

Error codes

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