调用DescribeDbInstances接口查看存储层（如RDS或PolarDB）的实例列表。

调试

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

请求参数

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

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

实例ID。
Search String 否 pc-***************

存储层实例ID或集群ID。
DbInstType String 否 POLARDB

存储层类型，取值为POLARDB或RDS。
PageNumber Integer 否 1

分页页码。
PageSize Integer 否 10

分页每页大小。
RegionId String 否 cn-hangzhou

地域ID。

返回数据

名称 类型 示例值 描述
RequestId String 293275B3-8FC0-4619-A26E-6F062FASD56R

请求ID。
Items Array of DBInstance

实例详情列表。
DBInstance
InstanceNetworkType String VPC

存储层实例网络类型，取值范围如下：

  • VPC：专有网络
  • CLASSIC：经典网络
DBInstanceType String Primary

存储层实例类型。
ZoneId String cn-hangzhou-a

可用区ID。
DBInstanceStatus Integer 0

存储层实例状态，取值范围如下：

  • 0：创建中
  • 1：使用中
  • 3：删除中
  • 5：重启中
  • 6：升降级中
  • 7：恢复中
  • 8：内外网切换中
DBInstanceId String rm-****************

存储层实例ID。
Engine String 存储层实例内核。

存储层实例内核。
DBInstanceDescription String test

存储层实例描述。
EngineVersion String 5.7

存储层实例内核版本。
RegionId String cn-hangzhou

地域ID。
ReadOnlyDBInstanceId Array of String []

存储层实例下的只读实例。

示例

请求示例

http(s)://[drds.aliyuncs.com]/?Action=DescribeDbInstances
&DrdsInstanceId=drds************
&Search=pc-***************
&DbInstType=POLARDB
&PageNumber=1
&PageSize=10
&RegionId=cn-hangzhou
&公共请求参数

正常返回示例

XML格式

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

<DescribeDbInstancesResponse>
    <RequestId>293275B3-8FC0-4619-A26E-6F062FASD56R</RequestId>
    <Items>
        <InstanceNetworkType>VPC</InstanceNetworkType>
        <DBInstanceType>Primary</DBInstanceType>
        <ZoneId>cn-hangzhou-a</ZoneId>
        <DBInstanceStatus>0</DBInstanceStatus>
        <DBInstanceId>rm-****************</DBInstanceId>
        <Engine>存储层实例内核。</Engine>
        <DBInstanceDescription>test</DBInstanceDescription>
        <EngineVersion>5.7</EngineVersion>
        <RegionId>cn-hangzhou</RegionId>
        <ReadOnlyDBInstanceId>[]</ReadOnlyDBInstanceId>
    </Items>
</DescribeDbInstancesResponse>

JSON格式

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

{
  "RequestId" : "293275B3-8FC0-4619-A26E-6F062FASD56R",
  "Items" : [ {
    "InstanceNetworkType" : "VPC",
    "DBInstanceType" : "Primary",
    "ZoneId" : "cn-hangzhou-a",
    "DBInstanceStatus" : 0,
    "DBInstanceId" : "rm-****************",
    "Engine" : "存储层实例内核。",
    "DBInstanceDescription" : "test",
    "EngineVersion" : "5.7",
    "RegionId" : "cn-hangzhou",
    "ReadOnlyDBInstanceId" : [ "[]" ]
  } ]
}

错误码

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

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