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

调试

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

请求参数

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

系统规定参数。取值为DescribeDbInstances

DrdsInstanceId String drds************

DRDS实例ID。

Search String pc-***************

存储层实例ID或集群ID。

DbInstType String POLARDB

存储层类型,取值为POLARDBRDS

PageNumber Integer 1

分页页码。

PageSize Integer 10

分页每页大小。

返回数据

名称 类型 示例值 描述
Items Array

实例详情列表。

DBInstance
DBInstanceDescription String test

存储层实例描述。

DBInstanceId String rm-****************

存储层实例ID。

DBInstanceStatus Integer 1

存储层实例状态,取值范围如下:

  • 0:创建中
  • 1:使用中
  • 3:删除中
  • 5:重启中
  • 6:升降级中
  • 7:恢复中
  • 8:内外网切换中
DBInstanceType String Primary

存储层实例类型。

Engine String MySQL

存储层实例内核。

EngineVersion String 5.7

存储层实例内核版本。

InstanceNetworkType String VPC

存储层实例网络类型,取值范围如下:

  • VPC:专有网络
  • CLASSIC:经典网络
ReadOnlyDBInstanceId List []

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

RegionId String cn-hangzhou

存储层实例所属地域ID。

ZoneId String cn-hangzhou-a

存储层实例所属可用区ID。

RequestId String 293275B3-8FC0-4619-A26E-6F062F******

请求ID。

示例

请求示例

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

正常返回示例

XML 格式

<RequestId>293275B3-8FC0-4619-A26E-6F062F******</RequestId>
<Items>
    <DBInstance>
        <EngineVersion>5.7</EngineVersion>
        <DBInstanceStatus>1</DBInstanceStatus>
        <ZoneId>cn-hangzhou-e</ZoneId>
        <DBInstanceId>rm-**************</DBInstanceId>
        <ReadOnlyDBInstanceId>
        </ReadOnlyDBInstanceId>
        <DBInstanceType>Primary</DBInstanceType>
        <RegionId>cn-hangzhou</RegionId>
        <Engine>MySQL</Engine>
        <DBInstanceDescription>test</DBInstanceDescription>
        <InstanceNetworkType>Classic</InstanceNetworkType>
    </DBInstance>
    <DBInstance>
        <EngineVersion>5.7</EngineVersion>
        <DBInstanceStatus>1</DBInstanceStatus>
        <ZoneId>cn-hangzhou-e</ZoneId>
        <DBInstanceId>rm-**************</DBInstanceId>
        <ReadOnlyDBInstanceId>
        </ReadOnlyDBInstanceId>
        <DBInstanceType>Primary</DBInstanceType>
        <RegionId>cn-hangzhou</RegionId>
        <Engine>MySQL</Engine>
        <DBInstanceDescription>test</DBInstanceDescription>
        <InstanceNetworkType>Classic</InstanceNetworkType>
    </DBInstance>
</Items>

JSON 格式

{
	"RequestId": "293275B3-8FC0-4619-A26E-6F062F******",
	"Items": {
		"DBInstance": [
			{
				"EngineVersion": "5.7",
				"DBInstanceStatus": 1,
				"ZoneId": "cn-hangzhou-e",
				"DBInstanceId": "rm-**************",
				"ReadOnlyDBInstanceId": {
					"ReadOnlyDBInstanceId": []
				},
				"DBInstanceType": "Primary",
				"RegionId": "cn-hangzhou",
				"Engine": "MySQL",
				"DBInstanceDescription": "test",
				"InstanceNetworkType": "Classic"
			},
			{
				"EngineVersion": "5.7",
				"DBInstanceStatus": 1,
				"ZoneId": "cn-hangzhou-e",
				"DBInstanceId": "rm-**************",
				"ReadOnlyDBInstanceId": {
					"ReadOnlyDBInstanceId": []
				},
				"DBInstanceType": "Primary",
				"RegionId": "cn-hangzhou",
				"Engine": "MySQL",
				"DBInstanceDescription": "test",
				"InstanceNetworkType": "Classic"
			}
		]
	}
}

错误码

HttpCode 错误码 错误信息 描述
400 ActionUnauthorized The specified action is not available for you 指定的action未授权,请您先做RAM授权再进行操作。

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