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

调试

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

请求参数

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

系统规定参数。取值:DescribeDrdsInstances

Type String 1

实例类型。

  • 共享实例:0
  • 专享实例:1
Description String drds_test

实例的描述。

Expired Boolean false

是否过期。

PageNumber Integer 1

页码。

PageSize Integer 20

每页大小。

ResourceGroupId String NULL

资源组ID,可以为空。

RegionId String cn-hangzhou

地域ID。

Mix Boolean FALSE

是否支持混合查询。

ProductVersion String V1/V2

产品版本号。

Tag.N.Key String acs:newretail:domain

标签的键。

Tag.N.Value String NEW_RETAIL

标签的值。

返回数据

名称 类型 示例值 描述
RequestId String 8734773E-7B21-4A22-9106-CBD245F8****

请求ID。

PageNumber Integer 1

页码。

PageSize Integer 20

每页大小。

Total Integer 1

实例总数。

Instances Array of Instance

实例列表。

Instance
VpcId String vpc-bp**********

虚拟专用网络ID。

Status String RUN

实例状态。

Type String PRIVATE

实例类型。

  • 共享实例:PUBLIC
  • 独享实例:PRIVATE
CommodityCode String drdsPost

商品代码。

MachineType String ecs

实例机器类型,仅支持ecs。

CreateTime Long 1568620311000

创建时间戳。

VersionAction String Upgradable

实例版本可用操作。

InstanceSeries String drds.sn2.4c16g

实例规格系列。

NetworkType String CLASSIC

网络类型。

  • 经典网络:CLASSIC
  • 专有网络:VPC
Label String NORMAL

实例标签。

  • 普通实例:NORMAL
  • 高可用实例:HA
  • VPC实例:VPC
ProductVersion String V1/V2

产品版本号。

InstanceSpec String drds.sn2.4c16g.8C32G

实例规格。

RegionId String cn-hangzhou-e

地域ID。

VpcCloudInstanceId String drdssen12****

VPC集群中的实例ID。

Description String drds_test

实例描述。

Version Long 0

实例版本。

ResourceGroupId String rg-aek2ljh3ye4****

资源组ID。

ZoneId String vsw-bpxxxxxxxxxxxxx96

可用区。

DrdsInstanceId String drdssen12****

实例ID。

ExpireDate Long 4724323200000

过期时间戳。

MasterInstanceId String drdssen12****

主实例ID。

OrderInstanceId String drdssen12****

购买的实例ID。

InstRole String MASTER

实例角色。

  • 主实例:MASTER
  • 分析型只读实例:SLAVE
  • 并发型只读实例:SLAVE_FLOW
Vips Array of Vip

VIP列表。

Vip
VpcId String vpc-bpxxxxxxxxxxxy

虚拟专用网络ID。

Type String intranet

VIP类型。

  • 内网:intranet
  • 外网:internet
VswitchId String vsw-bpxxxxxxxxxxxxx96

虚拟交换机ID。

Port String 3306

VIP开放端口。

IP String 10.23.***.***

IP。

dns String drdssen1243as.drds.aliyuncs.com

VIP绑定的域名。

ReadOnlyDBInstanceIds Array of String drdssen12****

只读实例ID列表。

series String enterprise

实例系列,取值如下:

  • enterprise:企业版
  • standard:标准版

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeDrdsInstances
&Type=1
&Description=drds_test
&Expired=false
&PageNumber=1
&PageSize=20
&ResourceGroupId=NULL
&RegionId=cn-hangzhou
&Mix=false
&ProductVersion=V1/V2
&Tag=[{"Key":"acs:newretail:domain","Value":"NEW_RETAIL"}]
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDrdsInstancesResponse>
    <RequestId>8734773E-7B21-4A22-9106-CBD245F8****</RequestId>
    <PageNumber>1</PageNumber>
    <PageSize>20</PageSize>
    <Total>1</Total>
    <Instances>
        <VpcId>vpc-bp**********</VpcId>
        <Status>RUN</Status>
        <Type>PRIVATE</Type>
        <CommodityCode>drdsPost</CommodityCode>
        <MachineType>ecs</MachineType>
        <CreateTime>1568620311000</CreateTime>
        <VersionAction>Upgradable</VersionAction>
        <InstanceSeries>drds.sn2.4c16g</InstanceSeries>
        <NetworkType>CLASSIC</NetworkType>
        <Label>NORMAL</Label>
        <ProductVersion>V1/V2</ProductVersion>
        <InstanceSpec>drds.sn2.4c16g.8C32G</InstanceSpec>
        <RegionId>cn-hangzhou-e</RegionId>
        <VpcCloudInstanceId>drdssen12****</VpcCloudInstanceId>
        <Description>drds_test</Description>
        <Version>0</Version>
        <ResourceGroupId>rg-aek2ljh3ye4****</ResourceGroupId>
        <ZoneId>vsw-bpxxxxxxxxxxxxx96</ZoneId>
        <DrdsInstanceId>drdssen12****</DrdsInstanceId>
        <ExpireDate>4724323200000</ExpireDate>
        <MasterInstanceId>drdssen12****</MasterInstanceId>
        <OrderInstanceId>drdssen12****</OrderInstanceId>
        <InstRole>MASTER</InstRole>
        <Vips>
            <VpcId>vpc-bpxxxxxxxxxxxy</VpcId>
            <Type>intranet</Type>
            <VswitchId>vsw-bpxxxxxxxxxxxxx96</VswitchId>
            <Port>3306</Port>
            <IP>10.23.***.***</IP>
            <dns>drdssen1243as.drds.aliyuncs.com</dns>
        </Vips>
        <ReadOnlyDBInstanceIds>drdssen12****</ReadOnlyDBInstanceIds>
        <series>enterprise</series>
    </Instances>
</DescribeDrdsInstancesResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "8734773E-7B21-4A22-9106-CBD245F8****",
  "PageNumber" : 1,
  "PageSize" : 20,
  "Total" : 1,
  "Instances" : [ {
    "VpcId" : "vpc-bp**********",
    "Status" : "RUN",
    "Type" : "PRIVATE",
    "CommodityCode" : "drdsPost",
    "MachineType" : "ecs",
    "CreateTime" : 1568620311000,
    "VersionAction" : "Upgradable",
    "InstanceSeries" : "drds.sn2.4c16g",
    "NetworkType" : "CLASSIC",
    "Label" : "NORMAL",
    "ProductVersion" : "V1/V2",
    "InstanceSpec" : "drds.sn2.4c16g.8C32G",
    "RegionId" : "cn-hangzhou-e",
    "VpcCloudInstanceId" : "drdssen12****",
    "Description" : "drds_test",
    "Version" : 0,
    "ResourceGroupId" : "rg-aek2ljh3ye4****",
    "ZoneId" : "vsw-bpxxxxxxxxxxxxx96",
    "DrdsInstanceId" : "drdssen12****",
    "ExpireDate" : 4724323200000,
    "MasterInstanceId" : "drdssen12****",
    "OrderInstanceId" : "drdssen12****",
    "InstRole" : "MASTER",
    "Vips" : [ {
      "VpcId" : "vpc-bpxxxxxxxxxxxy",
      "Type" : "intranet",
      "VswitchId" : "vsw-bpxxxxxxxxxxxxx96",
      "Port" : "3306",
      "IP" : "10.23.***.***",
      "dns" : "drdssen1243as.drds.aliyuncs.com"
    } ],
    "ReadOnlyDBInstanceIds" : [ "drdssen12****" ],
    "series" : "enterprise"
  } ]
}

错误码

HttpCode 错误码 错误信息 描述
400 ActionUnauthorized The specified action is not available for you 指定的action未授权,请您先做RAM授权再进行操作。
500 InternalError The request processing has failed due to some unknown error. 请求失败,内部错误

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