调用DescribeDrdsRdsInstancesu查看目标PolarDB-X实例下所有的私有定制RDS实例详情。

调试

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

请求参数

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

系统规定参数。取值：DescribeDrdsRdsInstances。
DrdsInstanceId String 是 drds*************

PolarDB-X实例ID。

说明 您可以调用DescribeDrdsInstances查看目标账号下所有实例详情，包括实例ID。

返回数据

名称 类型 示例值 描述
RequestId String 123DB16B-02F2-45F7-A571-843991******

请求ID。
Success Boolean true

请求是否成功。
DbInstances Array of DbInstance

存储层私有定制RDS实例信息详情。
DbInstance
DBInstanceCPU String 8

存储层私有定制RDS实例的CPU核数。
DBInstanceMemory Long 8192

存储层私有定制RDS实例的内存，单位：M。
PayType String PostPaid

存储层私有定制RDS实例的付费方式，取值范围如下：

  • Postpaid：按量付费（即后付费）
  • Prepaid：包年包月（即预付费）
DBInstanceStatus String 1

存储层私有定制RDS实例的状态，取值范围如下：

  • 0：创建中
  • 1：运行中
  • 3：删除中
  • 5：重启中
  • 6：升降级中
  • 7：备份中
  • 8：内外网切换中
  • 9：迁移中
  • 11：迁移数据中
  • 12：生成灾备实例中
  • 13：数据导入中
  • 14：从其他RDS实例导入数据中
  • 15：容灾切换中
  • 16：创建临时实例中
  • 17：网络创建中
  • 18：实例克隆中
  • 19：链路切换中
  • 20：只读实例迁移中
NetworkType String VPC

存储层私有定制RDS实例的网络类型，固定为VPC（专有网络）。
Port Integer 3306

内网连接端口。
EngineVersion String 8.0

存储层私有定制RDS实例的引擎版本号，固定为8.0。
DmInstanceId String dm-*************

资源ID。
DBInstanceStorage Long 20

存储层私有定制RDS实例的存储空间，单位：GB。
ConnectUrl String rm-***************.mysql.rds.aliyuncs.com

存储层私有定制RDS实例的内网连接地址。
ReadWeight Integer 0

目标存储层私有定制RDS实例的读写权重。
RdsInstType String Primary

存储层私有定制RDS实例的类型，取值范围如下：

  • Primary：主实例
  • Readonly：只读实例
DBInstanceClassType String x

实例规格族，取值范围如下：

  • x：通用型
  • d：独享套餐
  • h：独占物理机
DBInstanceId String rm-*****************

存储层私有定制RDS实例ID。
Engine String MySQL

存储层私有定制RDS实例的引擎类型，固定为MySQL。
DbInstType String RDS

存储层实例类型，固定为RDS。
LockMode Integer 1

RDS的锁定状态，取值范围：0|1|2|3|4|5

0，正常

1，手动触发锁

2，实例过期自动锁定

3，实例回滚前的自动锁定

4，实例空间满自动锁定

5，只读实例空间满自动锁定
LockReason String 手动触发锁

RDS锁定的原因

示例

请求示例

http(s)://drds.aliyuncs.com/?Action=DescribeDrdsRdsInstances
&DrdsInstanceId=drds*************
&<公共请求参数>

正常返回示例

XML格式

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

<RequestId>123DB16B-02F2-45F7-A571-843991******</RequestId>
<DbInstances>
    <DbInstance>
        <DbInstType>RDS</DbInstType>
        <DBInstanceMemory>8192</DBInstanceMemory>
        <EngineVersion>8</EngineVersion>
        <DBInstanceStatus>6</DBInstanceStatus>
        <Port>3306</Port>
        <PayType>PostPaid</PayType>
        <DBInstanceCPU>4</DBInstanceCPU>
        <DBInstanceClassType>x</DBInstanceClassType>
        <ConnectUrl>rm-************.mysql.rds.aliyuncs.com</ConnectUrl>
        <ReadWeight>0</ReadWeight>
        <DBInstanceId>rm-************</DBInstanceId>
        <NetworkType>VPC</NetworkType>
        <DBInstanceStorage>20</DBInstanceStorage>
        <RdsInstType>Primary</RdsInstType>
        <DmInstanceId>dm-************</DmInstanceId>
        <Engine>MySQL</Engine>
    </DbInstance>
</DbInstances>
<Success>true</Success>

JSON格式

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

{
  "RequestId" : "123DB16B-02F2-45F7-A571-843991******",
  "DbInstances" : {
    "DbInstance" : {
      "DbInstType" : "RDS",
      "DBInstanceMemory" : 8192,
      "EngineVersion" : 8,
      "DBInstanceStatus" : 6,
      "Port" : 3306,
      "PayType" : "PostPaid",
      "DBInstanceCPU" : 4,
      "DBInstanceClassType" : "x",
      "ConnectUrl" : "rm-************.mysql.rds.aliyuncs.com",
      "ReadWeight" : 0,
      "DBInstanceId" : "rm-************",
      "NetworkType" : "VPC",
      "DBInstanceStorage" : 20,
      "RdsInstType" : "Primary",
      "DmInstanceId" : "dm-************",
      "Engine" : "MySQL"
    }
  },
  "Success" : true
}

错误码

HttpCode 错误码 错误信息 描述
500 InternalError The request processing has failed due to some unknown error. 请求失败，内部错误

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