DescribeDbInstances
查看存储层实例列表,例如RDS或POLARDB
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeDbInstances |
系统规定参数。取值:DescribeDbInstances。 |
DrdsInstanceId | String | 是 | drdshbgadmcop1i7 |
DRDS实例id |
AccessKeyId | String | 否 | xxxxxxxxx |
身份key,参考公共参数 |
DbInstType | String | 否 | POLARDB |
存储层类型。POLARDB 或者 RDS |
PageNumber | Integer | 否 | 1 |
分页页码 |
PageSize | Integer | 否 | 10 |
分页每页大小 |
Search | String | 否 | pc-bp1m3wl4zr0032lq9 |
按照存储层实例id查询 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Items |
实例详情列表 |
||
DBInstance |
实例详情列表 |
||
DBInstanceDescription | String | pc-bp1q20h2ml1s407ki |
存储层实例描述 |
DBInstanceId | String | pc-bp1q20h2ml1s407ki |
存储层实例id |
DBInstanceStatus | Integer | 1 |
存储层实例状态:0:创建中; 1:使用中; 3:删除中; 5重启中; 6升降级中; 7恢复中; 8内外网切换中 |
DBInstanceType | String | POLARDB |
存储层实例类型:POLARDB 或者 RDS |
Engine | String | mysql |
存储层实例内核 |
EngineVersion | String | 8.0 |
存储层实例内核版本 |
InstanceNetworkType | String | VPC |
存储层实例网络类型:VPC 或者 CLASSIC |
ReadOnlyDBInstanceId | [] |
存储层实例下的只读实例 |
|
ReadOnlyDBInstanceId |
存储层实例下的只读实例 |
||
RegionId | String | cn-hangzhou |
存储层实例所属地域id |
ZoneId | String | cn-hangzhou-a |
存储层实例所属可用区id |
RequestId | String | 05670C01-093E-4DF4-99FA-0C63FF60250D |
请求id |
示例
请求示例
http(s)://[Endpoint]/?Action=DescribeDbInstances
&DrdsInstanceId=drdshbgadmcop1i7
&<公共请求参数>
正常返回示例
XML
格式
<DescribeDbInstancesResponse>
<RequestId>05670C01-093E-4DF4-99FA-0C63FF60250D</RequestId>
<Items>
<DBInstance>
<EngineVersion>8.0</EngineVersion>
<DBInstanceStatus>1</DBInstanceStatus>
<DBInstanceId>pc-bp1q20h2ml1s407ki</DBInstanceId>
<ReadOnlyDBInstanceId></ReadOnlyDBInstanceId>
<DBInstanceType>Primary</DBInstanceType>
<RegionId>cn-hangzhou</RegionId>
<DBInstanceDescription>pc-bp1q20h2ml1s407ki</DBInstanceDescription>
<Engine>POLARDB</Engine>
<InstanceNetworkType>VPC</InstanceNetworkType>
</DBInstance>
</Items>
</DescribeDbInstancesResponse>
JSON
格式
{
"Items":{
"DBInstance":[
{
"RegionId":"cn-hangzhou",
"DBInstanceType":"Primary",
"DBInstanceId":"pc-bp1q20h2ml1s407ki",
"InstanceNetworkType":"VPC",
"DBInstanceDescription":"pc-bp1q20h2ml1s407ki",
"EngineVersion":"8.0",
"DBInstanceStatus":1,
"Engine":"POLARDB",
"ReadOnlyDBInstanceId":{
"ReadOnlyDBInstanceId":[]
}
}
]
},
"RequestId":"05670C01-093E-4DF4-99FA-0C63FF60250D"
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | ActionUnauthorized | The specified action is not available for you | 指定的action未授权,请您先做RAM授权再进行操作。 |
访问错误中心查看更多错误码。
版权声明
本文仅代表作者观点,不代表本站立场。
本文系作者授权发表,未经许可,不得转载。
评论