調(diào)用DescribeDrdsDbInstances接口查詢數(shù)據(jù)庫(kù)下的RDS列表。

調(diào)試

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

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

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

系統(tǒng)規(guī)定參數(shù)。取值：DescribeDrdsDbInstances。
DbName String 是 dbname

數(shù)據(jù)庫(kù)名稱。
DrdsInstanceId String 是 drdshbga1138****

實(shí)例ID。
PageNumber Integer 否 1

頁(yè)碼。
PageSize Integer 否 30

每頁(yè)數(shù)量。

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

名稱 類型 示例值 描述
DbInstances Array of DbInstance

數(shù)據(jù)庫(kù)下的存儲(chǔ)實(shí)例列表。
DbInstance
ConnectUrl String rm-m5**********82.mysql.rds.aliyuncs.com

存儲(chǔ)實(shí)例的鏈接地址。
DBInstanceId String rm-m5*********82

存儲(chǔ)實(shí)例ID。
DBInstanceStatus String 1

存儲(chǔ)實(shí)例狀態(tài)：

  • 0：創(chuàng)建中
  • 1：運(yùn)行中
  • 3：刪除中
  • 5：重啟中
  • 6：升降級(jí)中
  • 7：備份中
  • 8：內(nèi)外網(wǎng)切換中
  • 9：遷移中
  • 11：遷移數(shù)據(jù)中
  • 12：生成災(zāi)備實(shí)例中
  • 13：數(shù)據(jù)導(dǎo)入中
  • 14：從其他 RDS 實(shí)例導(dǎo)入數(shù)據(jù)中
  • 15：容災(zāi)切換中
  • 16：創(chuàng)建臨時(shí)實(shí)例中
  • 17：網(wǎng)絡(luò)創(chuàng)建中
  • 18：實(shí)例克隆中
  • 19：鏈路切換中
  • 20：只讀實(shí)例遷移中
DbInstType String RDS

存儲(chǔ)實(shí)例類型，固定為RDS。
DmInstanceId String dm-hbgau1zp****

資源ID。
Engine String MySQL

存儲(chǔ)引擎。
EngineVersion String 5.7

存儲(chǔ)引擎版本。
ExpireTime String 1568620311000

存儲(chǔ)實(shí)例過(guò)期時(shí)間。
NetworkType String VPC

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

付費(fèi)類型。取值范圍如下：

  • drdsPre：包年包月（也稱預(yù)付費(fèi)）。
  • drdsPost：按量付費(fèi)（也稱后付費(fèi)）。
Port Integer 3306

端口。
RdsInstType String Primary

標(biāo)識(shí)是RDS主實(shí)例還是只讀實(shí)例，取值如下：

  • Primary：主實(shí)例
  • Readonly：只讀實(shí)例
ReadOnlyInstances Array of ReadOnlyInstance

存儲(chǔ)實(shí)例的只讀實(shí)例列表。
ReadOnlyInstance
ConnectUrl String rm-m5*********82.mysql.rds.aliyuncs.com

存儲(chǔ)實(shí)例的鏈接地址。
DBInstanceStatus String 1

存儲(chǔ)實(shí)例狀態(tài)：

  • 0：創(chuàng)建中
  • 1：運(yùn)行中
  • 3：刪除中
  • 5：重啟中
  • 6：升降級(jí)中
  • 7：備份中
  • 8：內(nèi)外網(wǎng)切換中
  • 9：遷移中
  • 11：遷移數(shù)據(jù)中
  • 12：生成災(zāi)備實(shí)例中
  • 13：數(shù)據(jù)導(dǎo)入中
  • 14：從其他 RDS 實(shí)例導(dǎo)入數(shù)據(jù)中
  • 15：容災(zāi)切換中
  • 16：創(chuàng)建臨時(shí)實(shí)例中
  • 17：網(wǎng)絡(luò)創(chuàng)建中
  • 18：實(shí)例克隆中
  • 19：鏈路切換中
  • 20：只讀實(shí)例遷移中
DbInstType String RDS

存儲(chǔ)實(shí)例類型，固定為RDS。
DmInstanceId String dm-*************

資源ID。
Engine String MySQL

存儲(chǔ)實(shí)例引擎。
EngineVersion String 5.7

存儲(chǔ)實(shí)例引擎版本。
ExpireTime String 1603209690000

存儲(chǔ)實(shí)例過(guò)期時(shí)間戳。
InstanceName String rm-m5xxxxxxxxx82

保留字段。
NetworkType String VPC

實(shí)例網(wǎng)絡(luò)類型。
PayType String Postpaid

實(shí)例付費(fèi)類型：

  • drdsPre：包年包月（也稱預(yù)付費(fèi)）。
  • drdsPost：按量付費(fèi)（也稱后付費(fèi)）。
Port Integer 3306

實(shí)例訪問(wèn)端口。
RdsInstType String RDS

實(shí)例類型。
ReadWeight Integer 70

實(shí)例讀比例。
RemainDays Integer 0

實(shí)例過(guò)期剩余天數(shù)。
ReadWeight Integer 30

在數(shù)據(jù)庫(kù)中的權(quán)重。
RemainDays Integer 0

預(yù)付費(fèi)實(shí)例剩余過(guò)期天數(shù)。
PageNumber String 1

頁(yè)碼。
PageSize String 10

該頁(yè)大小。
RequestId String 2F7F8080-9132-4279-85D0-B7E5C4305162

請(qǐng)求ID。
Success Boolean true

請(qǐng)求是否成功。
Total String 1

RDS主實(shí)例總數(shù)。

示例

請(qǐng)求示例

http(s)://[Endpoint]/?Action=DescribeDrdsDbInstances
&DbName=dbname
&DrdsInstanceId=drdshbga1138****
&<公共請(qǐng)求參數(shù)>

正常返回示例

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"}

錯(cuò)誤碼

HttpCode 錯(cuò)誤碼 錯(cuò)誤信息 描述
500 InternalError The request processing has failed due to some unknown error. 請(qǐng)求失敗，內(nèi)部錯(cuò)誤

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