Query details about 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 Yes DescribeDrdsInstance

The parameter specified by the system. Value: DescribeDrdsInstance

DrdsInstanceId String Yes drdssen******

DRDS instance ID

AccessKeyId String No ASU678UDIN9Hd******

Access Key

Response parameters

Prameter Type Sample response Description
Data

DRDS instance details

CommodityCode String drdsPost

Commodity code

CreateTime Long 1568620311000

Create timestamp

Description String drds_test

The description of the instance.

DrdsInstanceId String drdssen******

The ID of the SaaS instance.

ExpireDate Long 4724323200000

Expiration timestamp

InstRole String MASTER

The instance role. Valid values: primary instance and secondary instance.

InstanceSeries String drds.sn2.4c16g

Instance family

InstanceSpec String drds.sn2.4c16g.8C32G

Instance type

Label String NORMAL

The label of the DRDS instance.

  • Common instance: NORMAL
  • High-availability instance: HA
  • VPC instance: VPC
MachineType String ecs

The type of the ecs instance. Only ecs is available.

MasterInstanceId String drdssen******

The ID of the primary instance, only available for read-only instances.

NetworkType String CLASSIC

The network type. Valid values: CLASSIC and VPC. CLASSIC network value: CLASSIC.

OrderInstanceId String drdssen******

The ID of the purchased instance.

ReadOnlyDBInstanceIds drdssen******

The ID of the read-only instance.

ReadOnlyDBInstanceId

The ID of the read-only instance.

RegionId Boolean cn-hangzhou

Instance Region

Status String RUN

instance status

Type String PRIVATE

The instance type. Valid values: exclusive and PUBLIC.

Version Long 0

The version of the instance. It is currently empty.

VersionAction String Upgradeable

The available action for the DRDS instance version.

Vips

VIP list

Vip

VIP list

Dns String drdssen******.drds.aliyuncs.com

The domain name bound to the VIP.

ExpireDays Long 0

VIP expiration days

Port String 3306

VIP open port

Type String intranet

VIP type, intranet intranet, internet

VpcId String vpc-bpxxxxxxxxxxxy

The ID of the VPC.

VswitchId String vsw-bpxxxxxxxxxxxxx96

VSWITCH ID

VpcCloudInstanceId String drdssen******

The ID of the instance in the VPC cluster.

ZoneId String cn-hangzhou-e

The ID of the zone.

RequestId String B4F76641-BA45-4320-BE7C-9C62CF******

The ID of the request.

Success Boolean true

Indicates whether the call is successful.

Examples

Sample request


http(s)://[Endpoint]/? Action=DescribeDrdsInstance
&DrdsInstanceId=drdssen******
& <Common request parameters>

Sample success responses

XML format

<DescribeDrdsInstance>
	  <RequestId>B4F76641-BA45-4320-BE7C-9C62CF******</RequestId>
	  <Data>
		    <Status>RUN</Status>
		    <Description>drds_test</Description>
		    <InstanceSpec>drds.sn2.4c16g.8C32G</InstanceSpec>
		    <ZoneId>cn-hangzhou-e</ZoneId>
		    <ExpireDate>4724323200000</ExpireDate>
		    <CreateTime>1568620311000</CreateTime>
		    <MachineType>ecs</MachineType>
		    <Label>NORMAL</Label>
		    <InstanceSeries>drds.sn2.4c16g</InstanceSeries>
		    <VersionAction>Can_Be_Rolled_Back</VersionAction>
		    <Type>PRIVATE</Type>
		    <DrdsInstanceId>drdssen******</DrdsInstanceId>
		    <OrderInstanceId>drdssen******</OrderInstanceId>
		    <InstRole>MASTER</InstRole>
		    <NetworkType>CLASSIC</NetworkType>
		    <CommodityCode>drdsPost</CommodityCode>
		    <RegionId>cn-hangzhou</RegionId>
		    <Vips>
			      <Vip>
				        <Type>intranet</Type>
				        <VpcId></VpcId>
				        <Port>3306</Port>
				        <Dns>drdssen******.drds.aliyuncs.com</Dns>
			      </Vip>
		    </Vips>
	  </Data>
	  <Success>true</Success>
</DescribeDrdsInstance>

JSON format

{
	"Data":{
		"MachineType":"ecs",
		"Description":"drds_test",
		"OrderInstanceId":"drdssen******",
		"Type":"PRIVATE",
		"ZoneId":"cn-hangzhou-e",
		"InstRole":"MASTER",
		"NetworkType":"CLASSIC",
		"Status":"RUN",
		"ExpireDate":4724323200000,
		"Vips":{
			"Vip":[
				{
					"Dns":"drdssen******.drds.aliyuncs.com",
					"Port":3306,
					"Type":"intranet",
					"VpcId":""
				}
			]
		},
		"VersionAction":"Can_Be_Rolled_Back",
		"RegionId":"cn-hangzhou",
		"CommodityCode":"drdsPost",
		"InstanceSpec":"drds.sn2.4c16g.8C32G",
		"CreateTime":1568620311000,
		"InstanceSeries":"drds.sn2.4c16g",
		"Label":"NORMAL",
		"DrdsInstanceId":"drdssen******"
	},
	"RequestId":"B4F76641-BA45-4320-BE7C-9C62CF******",
	"Success":true
}

Error codes

HTTP status code 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 RAM authorization first.

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