通过DescribeDrdsInstances接口查询DRDS实例列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeDrdsInstances

系统规定参数,取值为DescribeDrdsInstances。

Type String 1

实例类型。

  • 共享实例:0
  • 专享实例:1
Tag.N.Key String acs:newretail:domain

第N个tag的键。

Tag.N.Value String NEW_RETAIL

第N个tag的值。

Description String drds_test

DRDS实例的描述。

Expired Boolean false

是否过期。

PageNumber Integer 1

页码。

PageSize Integer 20

每页大小。

返回数据

名称 类型 示例值 描述
Instances Array

实例列表。

Instance
CommodityCode String drdsPost

商品代码。

CreateTime Long 1568620311000

创建时间戳。

Description String drds_test

实例描述。

DrdsInstanceId String drdssen12****

实例ID。

ExpireDate Long 4724323200000

过期时间戳。

InstRole String MASTER

实例角色。

  • 主实例:MASTER
  • 分析型只读实例:SLAVE
  • 并发型只读实例:SLAVE_FLOW
InstanceSeries String drds.sn2.4c16g

实例规格系列。

InstanceSpec String drds.sn2.4c16g.8C32G

实例规格。

Label String NORMAL

实例标签。

  • 普通实例:NORMAL
  • 高可用实例:HA
  • VPC实例:VPC
MachineType String ecs

实例机器类型,只有ecs。

MasterInstanceId String drdssen12****

主实例ID。

NetworkType String CLASSIC

网络类型。

  • 经典网络:CLASSIC
  • 专有网络:VPC
OrderInstanceId String drdssen12****

购买的实例ID。

ReadOnlyDBInstanceIds List drdssen12****

只读实例ID列表。

RegionId String cn-hangzhou-e

地区ID。

Status String RUN

实例状态。

Type String PRIVATE

实例类型。

  • 共享实例:PUBLIC
  • 独享实例:PRIVATE
Version Long 0

实例版本。

VersionAction String Upgradable

实例版本可用操作。

Vips Array

VIP列表。

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

IP。

Port String 3306

VIP开放端口。

Type String intranet

VIP类型。

  • 内网:intranet
  • 外网:internet
VpcId String vpc-bpxxxxxxxxxxxy

虚拟专用网络ID。

VswitchId String vsw-bpxxxxxxxxxxxxx96

虚拟交换机ID。

VpcCloudInstanceId String drdssen12****

VPC集群中的实例ID。

VpcId String vpc-bpxxxxxxxxxxxy

虚拟专用网络ID。

ZoneId String vsw-bpxxxxxxxxxxxxx96

可用区。

PageNumber Integer 1

该页页码。

PageSize Integer 20

该页大小。

RequestId String 8734773E-7B21-4A22-9106-CBD245F8****

请求ID。

Total Integer 1

实例总数。

示例

请求示例

http(s)://drds.aliyuncs.com/?Action=DescribeDrdsInstances
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML 格式

<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 格式

{
    "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
}

错误码

HttpCode 错误码 错误信息 描述
400 ActionUnauthorized The specified action is not available for you 指定的action未授权,请您先做RAM授权再进行操作。

访问错误中心查看更多错误码。