调用DescribeRdsList接口查询PolarDB-X数据库的所有RDS。
请求参数
| 参数名 |
类型 |
是否必须 |
说明 |
| Action |
String |
是 |
系统规定参数，取值：DescribeRdsList。 |
| DrdsInstanceId |
String |
是 |
PolarDB-X实例ID。 |
| DbName |
String |
是 |
数据库名。 |
返回值
| 参数名 |
类型 |
描述 |
| Data |
List<RdsInstance> |
由RdsInstance组成的数组。 |
RdsInstance组成
| 参数名 |
类型 |
描述 |
| InstanceId |
Integer |
RDS实例ID。 |
| InstanceName |
String |
RDS实例名，在PolarDB-X中使用的是RDS实例名。 |
| ConnectUrl |
String |
RDS数据库连接串。 |
| Port |
Integer |
端口。 |
| InstanceStatus |
String |
实例状态，0：创建中； 1：使用中； 3：删除中； 5：重启中； 6：升降级中； 7：恢复中； 8：内外网切换中； 9：迁移中； 10：迁移版本中； 11：迁移数据到其他RDS中；
12：生产灾备实例中； 13：数据导入中； 14：从其他RDS实例导入数据中；15：容灾切换中。
|
| DbType |
String |
数据库类型，暂时只支持MySQL。 |
| ReadWeight |
Integer |
读权重。 |
| ReadOnlyChild |
List<Child> |
该RDS的只读实例，其属性与RdsInstance相同，但是没有ReadOnlyChildren属性。 |
错误码
| 错误码 |
报错信息 |
错误描述 |
HTTP 状态码 |
| InvalidDrdsInstanceId.NotFound |
The DrdsInstanceId provided does not exist in our records. |
实例不存在。 |
404 |
| InvalidDbName.NotFound |
The Drds DbName provided does not exist in our records. |
数据库不存在。 |
404 |
| InvalidParameter.Mismatch |
The specified parameter does not match. |
参数错误。 |
400 |