调用DescribeDrdsInstance接口查询实例详情。

调试

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

请求参数

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

系统规定参数。取值：DescribeDrdsInstance。

DrdsInstanceId String 是 drdshbga1138****

实例ID。
RegionId String 是 cn-hangzhou

地域ID。

返回数据

名称 类型 示例值 描述
Success Boolean true

请求是否成功。
RequestId String B4F76641-BA45-4320-BE7C-9C62CFDAC9B2

请求ID。
Data Object

实例详情列表。
Type String PRIVATE

实例类型，独享实例PRIVATE，共享实例PUBLIC。
Status String RUN

实例状态。
CreateTime Long 1568620311000

实例创建的时间戳。
VersionAction String Upgradeable

实例版本可用操作。
StorageType String RDS

存储实例类型。
NetworkType String CLASSIC

网络类型，经典网络CLASSIC，VPC网络为VPC。
Label String NORMAL

实例标签：

  • 普通实例： NORMAL
  • 高可用实例： HA
  • VPC实例：VPC
MysqlVersion Integer 5

实例支持的MySQL版本。
InstanceSpec String drds.sn2.4c16g.8C32G

实例规格。
VpcCloudInstanceId String drdssen12****

VPC集群中的实例ID。
Description String drds_test

实例描述。
Version Long 0

实例版本，目前为空。
ExpireDate Long 4724323200000

实例过期的时间戳。
MasterInstanceId String drdssen1243as

主实例ID。

说明 当实例类型为只读实例时，才会返回该参数。
CommodityCode String drdsPost

商品代码。
MachineType String ecs

实例机器类型，固定为ecs。

InstanceSeries String drds.sn2.4c16g

实例规格系列。
ProductVersion String 5.3.*

产品版本。
RegionId String cn-hangzhou

地域ID。
ResourceGroupId String NULL

资源组ID，可以为空。
DrdsInstanceId String drdssen1243as

实例ID。
ZoneId String cn-hangzhou-e

可用区ID。
InstRole String MASTER

实例角色，取值如下：

  • 主实例： MASTER
  • 分析型只读实例：SLAVE
  • 并发型只读实例：SLAVE_FLOW
OrderInstanceId String drdssen12****

购买的实例ID。
Vips Array of Vip

VIP列表。
Vip
Type String intranet

VIP 类型，内网 intranet，外网 internet
VpcId String vpc-bp**********

VPC的ID。
VswitchId String vsw-bp***********

虚拟交换机的ID。
Dns String drdssen1243as.drds.aliyuncs.com

VIP绑定的域名。
Port String 3306

VIP开放端口。
ExpireDays Long 0

VIP过期剩余天数。
ReadOnlyDBInstanceIds Array of String drdssen12****

只读实例ID列表。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeDrdsInstance
&DrdsInstanceId=drdshbga1138****
&RegionId=cn-hangzhou
&公共请求参数

正常返回示例

XML格式 

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

<DescribeDrdsInstanceResponse>
    <Success>true</Success>
    <RequestId>B4F76641-BA45-4320-BE7C-9C62CFDAC9B2</RequestId>
    <Data>
        <Type>PRIVATE</Type>
        <Status>RUN</Status>
        <CreateTime>1568620311000</CreateTime>
        <VersionAction>Upgradeable</VersionAction>
        <StorageType>RDS</StorageType>
        <NetworkType>CLASSIC</NetworkType>
        <Label>NORMAL</Label>
        <MysqlVersion>5</MysqlVersion>
        <InstanceSpec>drds.sn2.4c16g.8C32G</InstanceSpec>
        <VpcCloudInstanceId>drdssen12****</VpcCloudInstanceId>
        <Description>drds_test</Description>
        <Version>0</Version>
        <ExpireDate>4724323200000</ExpireDate>
        <MasterInstanceId>drdssen1243as</MasterInstanceId>
        <CommodityCode>drdsPost</CommodityCode>
        <MachineType>ecs</MachineType>
        <InstanceSeries>drds.sn2.4c16g</InstanceSeries>
        <ProductVersion>5.3.*</ProductVersion>
        <RegionId>cn-hangzhou</RegionId>
        <ResourceGroupId>NULL</ResourceGroupId>
        <DrdsInstanceId>drdssen1243as</DrdsInstanceId>
        <ZoneId>cn-hangzhou-e</ZoneId>
        <InstRole>MASTER</InstRole>
        <OrderInstanceId>drdssen12****</OrderInstanceId>
        <Vips>
            <Type>intranet</Type>
            <VpcId>vpc-bp**********</VpcId>
            <VswitchId>vsw-bp***********</VswitchId>
            <Dns>drdssen1243as.drds.aliyuncs.com</Dns>
            <Port>3306</Port>
            <ExpireDays>0</ExpireDays>
        </Vips>
        <ReadOnlyDBInstanceIds>drdssen12****</ReadOnlyDBInstanceIds>
    </Data>
</DescribeDrdsInstanceResponse>

JSON格式 

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

{
  "Success" : true,
  "RequestId" : "B4F76641-BA45-4320-BE7C-9C62CFDAC9B2",
  "Data" : {
    "Type" : "PRIVATE",
    "Status" : "RUN",
    "CreateTime" : 1568620311000,
    "VersionAction" : "Upgradeable",
    "StorageType" : "RDS",
    "NetworkType" : "CLASSIC",
    "Label" : "NORMAL",
    "MysqlVersion" : 5,
    "InstanceSpec" : "drds.sn2.4c16g.8C32G",
    "VpcCloudInstanceId" : "drdssen12****",
    "Description" : "drds_test",
    "Version" : 0,
    "ExpireDate" : 4724323200000,
    "MasterInstanceId" : "drdssen1243as",
    "CommodityCode" : "drdsPost",
    "MachineType" : "ecs",
    "InstanceSeries" : "drds.sn2.4c16g",
    "ProductVersion" : "5.3.*",
    "RegionId" : "cn-hangzhou",
    "ResourceGroupId" : "NULL",
    "DrdsInstanceId" : "drdssen1243as",
    "ZoneId" : "cn-hangzhou-e",
    "InstRole" : "MASTER",
    "OrderInstanceId" : "drdssen12****",
    "Vips" : [ {
      "Type" : "intranet",
      "VpcId" : "vpc-bp**********",
      "VswitchId" : "vsw-bp***********",
      "Dns" : "drdssen1243as.drds.aliyuncs.com",
      "Port" : "3306",
      "ExpireDays" : 0
    } ],
    "ReadOnlyDBInstanceIds" : [ "drdssen12****" ]
  }
}

错误码

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. 请求失败，内部错误

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