调用DescribeDrdsDbInstances接口查询数据库下的RDS列表。

调试

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

请求参数

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

系统规定参数。取值：DescribeDrdsDbInstances。
DbName String 是 dbname

数据库名称。
DrdsInstanceId String 是 drdshbga1138****

实例ID。
PageNumber Integer 否 1

页码。
PageSize Integer 否 30

每页数量。

返回数据

名称 类型 示例值 描述
DbInstances Array of DbInstance

数据库下的存储实例列表。
DbInstance
ConnectUrl String rm-m5**********82.mysql.rds.aliyuncs.com

存储实例的链接地址。
DBInstanceId String rm-m5*********82

存储实例ID。
DBInstanceStatus String 1

存储实例状态：

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

存储实例类型，固定为RDS。
DmInstanceId String dm-hbgau1zp****

资源ID。
Engine String MySQL

存储引擎。
EngineVersion String 5.7

存储引擎版本。
ExpireTime String 1568620311000

存储实例过期时间。
NetworkType String VPC

网络类型。
PayType String PostPaid

付费类型。取值范围如下：

  • drdsPre：包年包月（也称预付费）。
  • drdsPost：按量付费（也称后付费）。
Port Integer 3306

端口。
RdsInstType String Primary

标识是RDS主实例还是只读实例，取值如下：

  • Primary：主实例
  • Readonly：只读实例
ReadOnlyInstances Array of ReadOnlyInstance

存储实例的只读实例列表。
ReadOnlyInstance
ConnectUrl String rm-m5*********82.mysql.rds.aliyuncs.com

存储实例的链接地址。
DBInstanceStatus String 1

存储实例状态：

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

存储实例类型，固定为RDS。
DmInstanceId String dm-*************

资源ID。
Engine String MySQL

存储实例引擎。
EngineVersion String 5.7

存储实例引擎版本。
ExpireTime String 1603209690000

存储实例过期时间戳。
InstanceName String rm-m5xxxxxxxxx82

保留字段。
NetworkType String VPC

实例网络类型。
PayType String Postpaid

实例付费类型：

  • drdsPre：包年包月（也称预付费）。
  • drdsPost：按量付费（也称后付费）。
Port Integer 3306

实例访问端口。
RdsInstType String RDS

实例类型。
ReadWeight Integer 70

实例读比例。
RemainDays Integer 0

实例过期剩余天数。
ReadWeight Integer 30

在数据库中的权重。
RemainDays Integer 0

预付费实例剩余过期天数。
PageNumber String 1

页码。
PageSize String 10

该页大小。
RequestId String 2F7F8080-9132-4279-85D0-B7E5C4305162

请求ID。
Success Boolean true

请求是否成功。
Total String 1

RDS主实例总数。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeDrdsDbInstances
&DbName=dbname
&DrdsInstanceId=drdshbga1138****
&<公共请求参数>

正常返回示例

XML格式 

<RequestId>2F7F8080-9132-4279-85D0-B7E5C4305162</RequestId>
<PageSize>10</PageSize>
<PageNumber>1</PageNumber>
<Total>1</Total>
<DbInstances>
    <DbInstance>
        <DbInstType>RDS</DbInstType>
        <EngineVersion>5.7</EngineVersion>
        <DBInstanceStatus>1</DBInstanceStatus>
        <Port>3306</Port>
        <PayType>PostPaid</PayType>
        <ReadWeight>30</ReadWeight>
        <ConnectUrl>rm-m5**********82.mysql.rds.aliyuncs.com</ConnectUrl>
        <DBInstanceId>rm-m5*********82</DBInstanceId>
        <NetworkType>VPC</NetworkType>
        <RdsInstType>Primary</RdsInstType>
        <DmInstanceId>dm-hbgau1zp****</DmInstanceId>
        <ExpireTime>1568620311000</ExpireTime>
        <Engine>MySQL</Engine>
        <RemainDays>0</RemainDays>
        <ReadOnlyInstances>
            <ReadOnlyInstance>
                <DbInstType>RDS</DbInstType>
                <EngineVersion>5.7</EngineVersion>
                <DBInstanceStatus>1</DBInstanceStatus>
                <Port>3306</Port>
                <PayType>Postpaid</PayType>
                <InstanceName>rm-m5xxxxxxxxx82</InstanceName>
                <ReadWeight>70</ReadWeight>
                <ConnectUrl>rm-m5*********82.mysql.rds.aliyuncs.com</ConnectUrl>
                <NetworkType>VPC</NetworkType>
                <RdsInstType>RDS</RdsInstType>
                <DmInstanceId>dm-*************</DmInstanceId>
                <ExpireTime>1603209690000</ExpireTime>
                <Engine>MySQL</Engine>
                <RemainDays>0</RemainDays>
            </ReadOnlyInstance>
        </ReadOnlyInstances>
    </DbInstance>
</DbInstances>
<Success>true</Success>

JSON格式 

{"RequestId":"2F7F8080-9132-4279-85D0-B7E5C4305162","PageSize":"10","PageNumber":"1","Total":"1","DbInstances":{"DbInstance":[{"DbInstType":"RDS","EngineVersion":"5.7","DBInstanceStatus":"1","Port":"3306","PayType":"PostPaid","ReadWeight":"30","ConnectUrl":"rm-m5**********82.mysql.rds.aliyuncs.com","DBInstanceId":"rm-m5*********82","NetworkType":"VPC","RdsInstType":"Primary","DmInstanceId":"dm-hbgau1zp****","ExpireTime":"1568620311000","Engine":"MySQL","RemainDays":"0","ReadOnlyInstances":{"ReadOnlyInstance":[{"DbInstType":"RDS","EngineVersion":"5.7","DBInstanceStatus":"1","Port":"3306","PayType":"Postpaid","InstanceName":"rm-m5xxxxxxxxx82","ReadWeight":"70","ConnectUrl":"rm-m5*********82.mysql.rds.aliyuncs.com","NetworkType":"VPC","RdsInstType":"RDS","DmInstanceId":"dm-*************","ExpireTime":"1603209690000","Engine":"MySQL","RemainDays":"0"}]}}]},"Success":"true"}

错误码

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

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