备案 控制台 登录 注册
文档中心 > DescribeDBInstances
DescribeDBInstances

最近更新时间：2022-01-20

请求路径：/api/rds

请求方法：GET

接口描述：获取RDS实例列表

请求参数

名称

类型

是否必选

示例值

描述

Action

String

是

DescribeDBInstances

系统规定参数。取值：DescribeDBInstances

RegionId

String

是

cn-beijing

地域ID

PageSize

Integer

否

10

分页参数，每页大小,默认30

PageNumber

Integer

否

1

分页参数，当前页

返回参数

状态码：200

名称

类型

示例值

描述

RequestId

String

rm-uf6wjk5xxxxxxxxxx

请求ID。

PageNumber

Integer

1

当前页。

PageSize

Integer

30

每页实例个数。

TotalRecordCount

Integer

100

总记录数。

TotalPageCount

Integer

3

总页数。

Items

Array

[]

由实例信息组成的数组

- DBInstanceId

String

mysql-lv1xxxxxxx

数据库实例ID

- InstanceName

String

mysql2318451345

数据库实例名称

- InstanceType

String

normal

实例类型。取值：-normal：常规实例 -read_only：只读实例

- InstanceMode

String

SE

数据库系列。取值：-SE：单机版 -HA：高可用版

- InstanceClass

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

企业用户的项目名称

示例

请求示例

GET https://api.unicloud.com/api/rds?

Action=DescribeDBInstances

&PageNumber=1

&RegionId=cn-tianjin-yfb

&PageSize=100

返回示例

{

    "PageNumber": 1,

    "PageSize": 100,

    "TotalRecordCount": 2,

    "TotalPageCount": 1,

    "RequestId": "b9de1a62-d09e-4d34-9a61-38f0f56564b",

    "Items": [

        {

            "DBInstanceId": "mysql-xdnwcixxxxx",

            "InstanceName": "mysql1595575xxxxxx",

            "InstanceType": "normal",

            "InstanceMode": "HA",

            "InstanceClass": "db.c1.medium",

            "InstanceStatus": "running",

            "Engine": "mysql",

            "EngineVersion": "5.7",

            "PayType": "YEAR_MONTH",

            "VpcId": "vpc-ji0sh3xxxxxxx",

            "CreateTime": "2020-07-24 15:43:02",

            "ExpireTime": "2020-09-25 00:00:00"

        },

        {

            "DBInstanceId": "mysql-xdnvbxxxxxx",

            "InstanceName": "mysql1595575xxxxxx",

            "InstanceType": "normal",

            "InstanceMode": "SE",

            "InstanceClass": "db.c1.medium",

            "InstanceStatus": "running",

            "Engine": "mysql",

            "EngineVersion": "5.7",

            "PayType": "CHARGING_HOURS",

            "VpcId": "vpc-ji0sh3txxxxxx",

            "CreateTime": "2020-07-24 15:35:51",

            "ExpireTime": null

        }

    ]

}