You can call this operation to query the Distributed Relational Database Service (DRDS) instances in the specified region.

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 DescribeDrdsInstances

Required parameter. Value: DescribeDrdsInstances.

Type String No 1

The type of the Message Queue for Apache RocketMQ instance.

  • 0: the shared instance.
  • Dedicated instance: 1
Tag.N.Key String No acs:new******:domain

The key of the Nth tag.

Tag.N.Value String No NEW_RETAIL

The value of the Nth tag.

Description String No drds_test

The description of the DRDS instance.

Expired Boolean No false

Specifies whether the DRDS instance has expired.

PageNumber String Optional 1

The number of the returned page.

PageSize String Optional 20

The number of entries to return on each page.

Response parameters

Prameter Type Sample response Description
Instances Array

The list of instances.

Instance
CommodityCode String drdsPost

The commodity code.

CreateTime Long 1568620311000

The time when the DRDS instance was created.

Description String drds_test

The description of the DRDS instance.

DrdsInstanceId String drdssen12 supports automatic release *

The ID of the DRDS instance.

ExpireDate Long 4724323200000

The time when the DRDS instance expires.

InstRole String MASTER

The role of the DRDS instance.

  • MASTER: the primary instance.
  • SLAVE: the analytic read-only instance.
  • SLAVE_FLOW: the concurrent read-only instance.
InstanceSeries String drds.sn2.4c16g

The type of the DRDS instance.

InstanceSpec String drds.sn2.4c16g.8C32G The type of the instance.
Label String NORMAL

The tags of the instance.

  • NORMAL: the normal instance.
  • HA: the high-availability instance.
  • VPC: the Virtual Private Cloud (VPC) instance.
MachineType String ecs

The type of machine where the DRDS instance is deployed. Valid value: ecs.

MasterInstanceId String drdssen12 supports automatic release *

The ID of the primary instance.

NetworkType String CLASSIC

The network type of the instance.

  • CLASSIC: the classic network.
  • VPC
OrderInstanceId String drdssen12 supports automatic release *

The ID of the purchased instance.

ReadOnlyDBInstanceIds List drdssen12 supports automatic release *

The list of IDs of read-only instances.

RegionId Boolean cn-hangzhou-e

The ID of the region.

Status String RUN

The status of the DRDS instance.

Type String PRIVATE

The type of the Message Queue for Apache RocketMQ instance.

  • PUBLIC: the shared instance.
  • PRIVATE: the dedicated instance.
Version Long 0

The version of the DRDS instance.

VersionAction String Upgradable

The available actions for the DRDS instance version.

Vips Array

The returned list of virtual IP addresses (VIPs).

Vip
IP address String 10.23. ***. ***

the instance on which the configuration center is started.

Port String 3306

The open port of the VIP.

Type String intranet

The VIP type.

  • intranet: the internal network.
  • internet: the public network.
VpcId String vpc-bpxxxxxxxxxxxy

The virtual private network ID.

VswitchId String vsw-bpxxxxxxxxxxxxx96

The ID of the VSwitch.

VpcCloudInstanceId String drdssen12 supports automatic release *

The ID of the instance in the VPC cluster.

VpcId String vpc-bpxxxxxxxxxxxy

The virtual private network ID.

ZoneId String vsw-bpxxxxxxxxxxxxx96

The zone ID.

PageNumber Integer 1

The page number of the returned page.

PageSize Integer 20

The number of entries returned per page.

RequestId String 8734773 E-7B21-4A22-9106-CB****** automatic snapshot policies *

The ID of the instance.

Total Interger 1

The total number of DRDS instances.

Examples

Sample request

http(s)://[Endpoint]/? Action=DescribeDrdsInstances
&RegionId=cn-hangzhou
&<Common request parameter>

Sample success responses

XML format

<Instances>
    <Instance>
        <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>Upgradable</VersionAction>
        <Type>PRIVATE</Type>
        <VpcId/>
        <DrdsInstanceId>drdssen12****</DrdsInstanceId>
        <OrderInstanceId>drdssen12****</OrderInstanceId>
        <InstRole>MASTER</InstRole>
        <NetworkType>CLASSIC</NetworkType>
        <CommodityCode>drdsPost</CommodityCode>
        <RegionId>cn-hangzhou</RegionId>
        <Vips>
        </Vips>
    </Instance>
</Instances>
<PageSize>20</PageSize>
<RequestId>8734773E-7B21-4A22-9106-CBD245F8****</RequestId>
<PageNumber>1</PageNumber>
<Total>1</Total>

JSON format

{
    "Instances": {
        "Instance": [
            {
                "Status": "RUN",
                "Description": "drds_test",
                "InstanceSpec": "drds.sn2.4c16g.8C32G",
                "ZoneId": "cn-hangzhou-e",
                "ExpireDate": 4724323200000,
                "CreateTime": 1568620311000,
                "MachineType": "ecs",
                "Label": "NORMAL",
                "InstanceSeries": "drds.sn2.4c16g",
                "VersionAction": "Upgradable",
                "Type": "PRIVATE",
                "VpcId":"",
                "DrdsInstanceId": "drdssen12****",
                "OrderInstanceId": "drdssen12****",
                "InstRole": "MASTER",
                "NetworkType": "CLASSIC",
                "CommodityCode": "drdsPost",
                "RegionId": "cn-hangzhou",
                "Vips": {
                    "Vip": []
                }
            }
        ]
    },
    "PageSize": 20,
    "RequestId": "8734773E-7B21-4A22-9106-CBD245F8****",
    "PageNumber": 1,
    "Total": 1
}

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.