文档中心 > DescribeDBInstances
DescribeDBInstances

最近更新时间:2023-05-18

请求路径:/api/redis

请求方法:GET

接口描述:获取Redis实例列表

请求参数

名称

类型

是否必选

示例值

描述

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

redis-lv1xxxxxxx

数据库实例ID。

- InstanceName

String

redis2318451345

数据库实例名称。

- InstanceType

String

normal

实例类型。

- InstanceMode

String

SE

数据库系列。

- InstanceClass

String

cache.s1.medium

实例规格码。

- InstanceStatus

String

running

实例状态, running-运行中,creating-创建中,failedtocreate-创建失败, restarting重启中,suspending-已过期,owing-已欠费, failed-失败

- Engine

String

redis

数据库类型。

- EngineVersion

String

3.2

数据库版本。

- 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”。后付费无到期时间。

示例

请求示例

GET https://api.unicloud.com/api/redis?
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": "redis-xnfo7xxxxxx",
           "InstanceName": "redis159581xxxxxx",
           "InstanceType": "normal",
           "InstanceMode": "SE",
           "InstanceClass": "cache.s1.medium",
           "InstanceStatus": "running",
           "Engine": "redis",
           "EngineVersion": "3.2",
           "PayType": "YEAR_MONTH",
           "VpcId": "vpc-rxtptt5xxxxxxx",
           "CreateTime": "2020-07-27 09:16:01",
           "ExpireTime": "2020-08-28 00:00:00"
      }
  ]
}