调用DescribeDrdsDbInstance接口查询存储层私有定制RDS实例的详情。

调试

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

请求参数

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

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

DrdsInstanceId String 是 drdshbga1138****

实例名称。
DbName String 是 drds_test

数据库名称。
DbInstanceId String 是 rm-bp1t1mk5a5bdj****

私有定制RDS实例ID。

返回数据

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

请求是否成功。
RequestId String 4FE09970-CA69-4144-88CA-67FB4BTY56G3

请求ID。
DbInstance Object

私有定制RDS实例详情。
ExpireTime String 12341434315

实例过期时间，格式为Unix时间戳，单位为秒。

说明 仅预付费实例支持该参数。
PayType String Postpaid

实例付费类型，取值范围如下：

  • Prepaid：包年包月（即预付费）
  • Postaid：按量付费（即后付费或按小时付费）
DBInstanceStatus String 1

实例状态。
NetworkType String VPC

实例网络类型，目前仅支持专有网络VPC。

Port Integer 3306

实例访问端口。
EngineVersion String 5.7

实例引擎版本，目前仅支持5.7版本。

DmInstanceId String dm-*************

资源ID。
ConnectUrl String rm-***************.mysql.rds.aliyuncs.com

私有定制RDS连接地址。
ReadWeight Integer 70

实例读比例。
RdsInstType String RDS

实例类型。
RemainDays String 0

实例过期剩余天数。
DBInstanceId String rm-***************

私有定制RDS实例ID。
DbInstType String Primary

实例类型，取值范围如下：

  • Primary：主实例
  • ReadOnly：只读实例
Engine String MySQL

实例引擎，目前仅支持MySQL。

ReadOnlyInstances Array of ReadOnlyInstance

只读实例列表。
ReadOnlyInstance
ExpireTime String 1823487328173

实例过期时间戳。
PayType String Postpaid

实例购买类型。
VersionAction Integer 0

无效字段
DBInstanceStatus String 1

实例状态。
NetworkType String VPC

实例网络类型。
Port Integer 3306

实例访问端口。
EngineVersion String 5.7

实例引擎版本。
DmInstanceId String dm-*************

资源ID。
ConnectUrl String rm-bp1ub71ct9skc3yxx.mysql.rds.aliyuncs.com

只读实例连接地址。
ReadWeight Integer 30

实例读比例。
RdsInstType String RDS

实例类型。
RemainDays String 0

实例过期剩余天数。
DBInstanceId String rm-bp1ub71ct9skc****

只读实例ID。
DbInstType String RDS

实例类型。
Engine String MySQL

实例引擎。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeDrdsDbInstance
&DrdsInstanceId=drdshbga1138****
&DbName=drds_test
&DbInstanceId=rm-bp1t1mk5a5bdj****
&公共请求参数

正常返回示例

XML格式 

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

<DescribeDrdsDbInstanceResponse>
    <Success>true</Success>
    <RequestId>4FE09970-CA69-4144-88CA-67FB4BTY56G3</RequestId>
    <DbInstance>
        <ExpireTime>12341434315</ExpireTime>
        <PayType>Postpaid</PayType>
        <DBInstanceStatus>1</DBInstanceStatus>
        <NetworkType>VPC</NetworkType>
        <Port>3306</Port>
        <EngineVersion>5.7</EngineVersion>
        <DmInstanceId>dm-*************</DmInstanceId>
        <ConnectUrl>rm-***************.mysql.rds.aliyuncs.com</ConnectUrl>
        <ReadWeight>70</ReadWeight>
        <RdsInstType>RDS</RdsInstType>
        <RemainDays>0</RemainDays>
        <DBInstanceId>rm-***************</DBInstanceId>
        <DbInstType>Primary</DbInstType>
        <Engine>MySQL</Engine>
        <ReadOnlyInstances>
            <ExpireTime>1823487328173</ExpireTime>
            <PayType>Postpaid</PayType>
            <VersionAction>0</VersionAction>
            <DBInstanceStatus>1</DBInstanceStatus>
            <NetworkType>VPC</NetworkType>
            <Port>3306</Port>
            <EngineVersion>5.7</EngineVersion>
            <DmInstanceId>dm-*************</DmInstanceId>
            <ConnectUrl>rm-bp1ub71ct9skc3yxx.mysql.rds.aliyuncs.com</ConnectUrl>
            <ReadWeight>30</ReadWeight>
            <RdsInstType>RDS</RdsInstType>
            <RemainDays>0</RemainDays>
            <DBInstanceId>rm-bp1ub71ct9skc****</DBInstanceId>
            <DbInstType>RDS</DbInstType>
            <Engine>MySQL</Engine>
        </ReadOnlyInstances>
    </DbInstance>
</DescribeDrdsDbInstanceResponse>

JSON格式 

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

{
  "Success" : true,
  "RequestId" : "4FE09970-CA69-4144-88CA-67FB4BTY56G3",
  "DbInstance" : {
    "ExpireTime" : "12341434315",
    "PayType" : "Postpaid",
    "DBInstanceStatus" : "1",
    "NetworkType" : "VPC",
    "Port" : 3306,
    "EngineVersion" : "5.7",
    "DmInstanceId" : "dm-*************",
    "ConnectUrl" : "rm-***************.mysql.rds.aliyuncs.com",
    "ReadWeight" : 70,
    "RdsInstType" : "RDS",
    "RemainDays" : "0",
    "DBInstanceId" : "rm-***************",
    "DbInstType" : "Primary",
    "Engine" : "MySQL",
    "ReadOnlyInstances" : [ {
      "ExpireTime" : "1823487328173",
      "PayType" : "Postpaid",
      "VersionAction" : 0,
      "DBInstanceStatus" : "1",
      "NetworkType" : "VPC",
      "Port" : 3306,
      "EngineVersion" : "5.7",
      "DmInstanceId" : "dm-*************",
      "ConnectUrl" : "rm-bp1ub71ct9skc3yxx.mysql.rds.aliyuncs.com",
      "ReadWeight" : 30,
      "RdsInstType" : "RDS",
      "RemainDays" : "0",
      "DBInstanceId" : "rm-bp1ub71ct9skc****",
      "DbInstType" : "RDS",
      "Engine" : "MySQL"
    } ]
  }
}

错误码

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

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