通過DescribeDrdsInstances接口查詢實(shí)例列表。

調(diào)試

您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。

請(qǐng)求參數(shù)

名稱 類型 是否必選 示例值 描述
Action String 是 DescribeDrdsInstances

系統(tǒng)規(guī)定參數(shù)。取值：DescribeDrdsInstances。
Type String 否 1

實(shí)例類型。

  • 共享實(shí)例：0
  • 專享實(shí)例：1
Description String 否 drds_test

實(shí)例的描述。
Expired Boolean 否 false

是否過期。
PageNumber Integer 否 1

頁碼。
PageSize Integer 否 20

每頁大小。
ResourceGroupId String 否 NULL

資源組ID，可以為空。
RegionId String 是 cn-hangzhou

地域ID。
Mix Boolean 否 FALSE

是否支持混合查詢。
ProductVersion String 否 V1

產(chǎn)品版本號(hào)，可取值為V1或V2。
Tag.N.Key String 否 acs:newretail:domain

標(biāo)簽的鍵。
Tag.N.Value String 否 NEW_RETAIL

標(biāo)簽的值。

返回?cái)?shù)據(jù)

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

請(qǐng)求ID。
PageNumber Integer 1

頁碼。
PageSize Integer 20

每頁大小。
Total Integer 1

實(shí)例總數(shù)。
Instances Array of Instance

實(shí)例列表。
Instance
VpcId String vpc-bp**********

虛擬專用網(wǎng)絡(luò)ID。
Status String RUN

實(shí)例狀態(tài)。
Type String PRIVATE

實(shí)例類型。

  • PUBLIC：共享實(shí)例
  • PRIVATE：獨(dú)享實(shí)例
CommodityCode String drdsPost

商品代碼。
MachineType String ecs

實(shí)例機(jī)器類型，僅支持ecs。
CreateTime Long 1568620311000

創(chuàng)建時(shí)間戳。
VersionAction String Upgradable

實(shí)例版本可用操作。
InstanceSeries String drds.sn2.4c16g

實(shí)例規(guī)格系列。
NetworkType String CLASSIC

網(wǎng)絡(luò)類型。

  • CLASSIC：經(jīng)典網(wǎng)絡(luò)
  • VPC：專有網(wǎng)絡(luò)
Label String NORMAL

實(shí)例標(biāo)簽。

  • NORMAL：普通實(shí)例
  • HA：高可用實(shí)例
  • VPC：VPC實(shí)例
ProductVersion String V1

產(chǎn)品版本號(hào)。
InstanceSpec String drds.sn2.4c16g.8C32G

實(shí)例規(guī)格。
RegionId String cn-hangzhou-e

地域ID。
VpcCloudInstanceId String drdssen12****

VPC集群中的實(shí)例ID。
Description String drds_test

實(shí)例描述。
Version Long 0

實(shí)例版本。
ResourceGroupId String rg-aek2ljh3ye4****

資源組ID。
ZoneId String vsw-bpxxxxxxxxxxxxx96

可用區(qū)。
DrdsInstanceId String drdssen12****

實(shí)例ID。
ExpireDate Long 4724323200000

過期時(shí)間戳。
MasterInstanceId String drdssen12****

主實(shí)例ID。
OrderInstanceId String drdssen12****

購(gòu)買的實(shí)例ID。
InstRole String MASTER

實(shí)例角色。

  • MASTER：主實(shí)例
  • SLAVE：分析型只讀實(shí)例
  • SLAVE_FLOW：并發(fā)型只讀實(shí)例
Vips Array of Vip

VIP列表。
Vip
VpcId String vpc-bpxxxxxxxxxxxy

虛擬專用網(wǎng)絡(luò)ID。
Type String intranet

VIP類型。

  • intranet：內(nèi)網(wǎng)
  • internet：外網(wǎng)
VswitchId String vsw-bpxxxxxxxxxxxxx96

虛擬交換機(jī)ID。
Port String 3306

VIP開放端口。
IP String 10.23.***.***

IP地址。
dns String drdssen1243as.drds.aliyuncs.com

VIP綁定的域名。
ReadOnlyDBInstanceIds Array of String drdssen12****

只讀實(shí)例ID列表。
series String enterprise

實(shí)例系列，取值如下：

  • starter：入門版
  • enterprise：企業(yè)版
  • standard：標(biāo)準(zhǔn)版

示例

請(qǐng)求示例

http(s)://[drds.aliyuncs.com]/?Action=DescribeDrdsInstances
&Type=1
&Description=drds_test
&Expired=false
&PageNumber=1
&PageSize=20
&ResourceGroupId=NULL
&RegionId=cn-hangzhou
&Mix=false
&ProductVersion=V1
&Tag=[{"Key":"acs:newretail:domain","Value":"NEW_RETAIL"}]
&公共請(qǐng)求參數(shù)

正常返回示例

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</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",
    "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"
  } ]
}

錯(cuò)誤碼

HttpCode 錯(cuò)誤碼 錯(cuò)誤信息 描述
400 ActionUnauthorized The specified action is not available for you 指定的action未授權(quán)，請(qǐng)您先做RAM授權(quán)再進(jìn)行操作。
500 InternalError The request processing has failed due to some unknown error. 請(qǐng)求失敗，內(nèi)部錯(cuò)誤

訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。