最近更新时间：2022-09-26
请求路径：/v3/api/rds
请求方法：GET
接口描述：获取RDS实例列表
名称 | 类型 | 是否必选 | 示例值 | 描述 |
Action | String | 是 | DescribeDBInstances | 系统规定参数。取值：DescribeDBInstances |
Region | String | 是 | cn-beijing | 地域ID |
PageSize | Integer | 否 | 10 | 分页参数，每页大小,默认30 |
PageNumber | Integer | 否 | 1 | 分页参数，当前页 |
Filter.N | 数组 | 否 | Filter[0].Name=instance_mode Filter[0].Value=SE | 支持查询条件： engine 默认是全部的rds产品 instance_id 实例Id instance_name 实例名 status 状态 instance_mode 实例系列 engine_version 版本号 |
Order.N | 数组 | 否 | Order[0].Column=record_start_at Order[0].SortOrder=0 | 支持筛选条件： record_start_at 实例创建时间 0表示升序 1表示降序 |
状态码：200
名称 | 类型 | 示例值 | 描述 |
RequestId | String | rm-uf6wjk5xxxxxxxxxx | 请求ID。 |
PageNumber | Integer | 1 | 当前页。 |
PageSize | Integer | 30 | 每页实例个数。 |
TotalRecordCount | Integer | 100 | 总记录数。 |
TotalPageCount | Integer | 3 | 总页数。 |
Records | Array | [] | 由实例信息组成的数组 |
- DBInstanceId | String | mysql-lv1xxxxxxx | 数据库实例ID |
- InstanceName | String | mysql2318451345 | 数据库实例名称 |
- InstanceType | String | normal | 实例类型。取值：-normal：常规实例 -read_only：只读实例 |
- InstanceMode | String | SE | 数据库系列。取值：-SE：单机版 -HA：高可用版 |
-DBInstanceClass | String | db.s1.large | 实例规格码 |
- InstanceStatus | String | running | 实例状态, running-运行中，creating-创建中，failedtocreate-创建失败， restarting重启中，suspending-已过期，owing-已欠费， failed-失败 |
- Engine | String | mysql | 数据库类型 |
- EngineVersion | String | 5.7 | 数据库版本 |
- PayType | String | YEAR_MONTH | 计费方式。 |
- VpcId | String | vpc-wrxxxxxxxx | VpcId |
- CreateTime | String | 2019-02-27 16:00:00 | 创建时间，格式为“yyyy-mm-dd hh:mm:ss”。 |
- ExpireTime | String | 2019-02-27 16:00:00 | 过期时间，格式为“yyyy-mm-dd hh:mm:ss”。后付费无到期时间 |
- CreateUserName | String | testUser1 | 实例创建者 |
- ProjectName | String | projecttest | 企业用户的项目名称 |
- AvailabilityZone | String | cn-beining | 主节点地域ID |
GET https://api.unicloud.com/v3/api/rds? Action=DescribeDBInstances &PageNumber=1 &Region=cn-tianjin-yfb &PageSize=100 &Filter[0].Name=engine &Filter[0].Value=mysql &Order[0].Column=record_start_at &Order[0].SortOrder=0 |
{ "PageSize": 10, "PageNumber": 1, "TotalCount": 1, "TotalPage": 1, "Records": [ { "DBInstanceId": "mysql-xxxxxx", "DBInstanceName": "mysqlxxxxxx", "InstanceType": "normal", "InstanceMode": "HA", "DBInstanceClass": "db.c1.medium", "InstanceStatus": "failedtocreate", "Engine": "mysql", "EngineVersion": "8.0", "PayType": "YEAR_MONTH", "VpcId": "vpc-xxxxxx", "CreateTime": "2022-08-09 09:31:37", "ExpireTime": "2022-09-10 00:00:00", "CreateUserName": "dbstest", "ProjectName": "default", "AvailabilityZone": "cn-beijing-a" } ] } |
