更新时间:2022-05-09 GMT+08:00
分享

查询所有实例列表

功能介绍

查询租户的缓存实例列表,支持按照条件查询。

URI

GET /v1.0/{project_id}/instances?start={start}&limit={limit}&name={name}&status={status}&id={id}&includeFailure={includeFailure}&isExactMatchName={isExactMatchName}&ip={ip}&tags={key}={value}

参数说明见表1
表1 参数说明

参数

类型

必选

说明

project_id

String

项目ID。

start

Integer

数据的起始序号,默认起始序号为1。

limit

Integer

每页显示条数,最小值为1,最大值为1000,若不设置该参数,则为最大显示条数1000。

name

String

实例名称。

id

String

实例ID。

status

String

实例状态。详细状态说明见缓存实例状态说明

ip

String

连接缓存实例的IP地址。

includeFailure

String

是否返回创建失败的实例数。

当参数值为“true”时,返回创建失败的实例数。参数值为“false”或者其他值,不返回创建失败的实例数。

isExactMatchName

String

是否按照实例名称进行精确匹配查询。

默认为“false”,表示模糊匹配实例名称查询。若参数值为“true”表示按照实例名称进行精确匹配查询。

tags

Array of objects

根据实例标签键值对进行查询。{key}表示标签键,{value}表示标签值。

如果同时使用多个标签键值对进行查询,中间使用逗号分隔开,表示查询同时包含指定标签键值对的实例。

示例

GET https://{dcs_endpoint}/v1.0/bd6b78e2ff9e4e47bc260803ddcc7a21/instances?start=1&limit=10&name=&status=&id=&includeFailure=true&isExactMatchName=false  

或:

GET https://{dcs_endpoint}/v1.0/bd6b78e2ff9e4e47bc260803ddcc7a21/instances?tags=dcs001=001,dcs002=002

请求消息

请求参数

无。

请求示例

无。

响应消息

响应参数

参数说明见表2
表2 参数说明

参数

类型

说明

instances

Array

实例的详情数组。

instance_num

Integer

实例个数。

表3 instance参数说明

参数

类型

说明

name

String

实例名称。

engine

String

缓存引擎。

capacity

Integer

缓存容量(G Byte)。

ip

String

连接缓存实例的IP地址。如果是集群实例,返回多个IP地址,使用逗号分隔。如:192.168.0.1,192.168.0.2。

domainName

String

实例的域名。

port

Integer

缓存的端口。

status

String

缓存实例的状态。详细状态说明见缓存实例状态说明

max_memory

Integer

总内存,单位:MB。

used_memory

Integer

已使用的内存,单位:MB。

instance_id

String

实例ID。

resource_spec_code

String

资源规格标识。

  • dcs.single_node:表示实例类型为单机
  • dcs.master_standby:表示实例类型为主备
  • dcs.cluster:表示实例类型为集群

engine_version

String

缓存版本。

internal_version

String

DCS内部版本号。

charging_mode

Integer

付费模式,0表示按需计费,1表示包年/包月计费。

capacity_minor

String

小规格缓存容量(G Byte)。

vpc_id

String

VPC ID。

vpc_name

String

VPC的名称。

created_at

String

创建时间。格式为:2017-03-31T12:24:46.297Z

error_code

String

实例创建失败或状态异常时的错误码,错误码的说明见表3

user_id

String

用户id。

user_name

String

用户名。

maintain_begin

String

维护时间窗开始时间,格式为HH:mm:ss。

maintain_end

String

维护时间窗结束时间,格式为HH:mm:ss。

no_password_access

String

是否允许免密码访问缓存实例。

  • true:该实例无需密码即可访问。
  • false:该实例必须通过密码认证才能访问。

access_user

String

通过密码认证访问缓存实例的认证用户名。

enable_publicip

Boolean

Redis缓存实例是否开启公网访问功能。

  • true:开启
  • false:不开启

publicip_address

String

Redis缓存实例绑定的弹性IP地址。

如果未开启公网访问功能,该字段值为null。

publicip_id

String

Redis缓存实例绑定的弹性IP地址的id。

如果未开启公网访问功能,该字段值为null。

enable_ssl

Boolean

Redis缓存实例开启公网访问功能时,是否选择支持ssl。

  • true:开启
  • false:不开启

service_upgrade

Boolean

实例是否存在升级任务。

  • true:存在
  • false:不存在

service_task_id

String

升级任务的ID。

  • 当service_upgrade为true时,该参数为升级任务的ID。
  • 当service_upgrade为false时,该参数为空。

enterprise_project_id

String

企业项目ID。

security_group_id

String

租户安全组名称。

tags

Array of objects

实例标签键值。

响应示例

{
    "instances": [
        {           
            "name": "dcs-lxy",            
            "engine": "Redis",
            "capacity": 4,
            "ip": "192.168.7.146",
            "domainName": null,
            "port": 6379,
            "status": "CREATING",
            "max_memory": 3277,
            "used_memory": 0,
            "instance_id": "a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71",
             "resource_spec_code": "dcs.master_standby",
            "engine_version": "3.0",
            "internal_version": null,
            "charging_mode": 0,          
            "capacity_minor": null,
            "vpc_id": "c71d9731-9b0c-43e9-ab2a-716af9d9fd55",
            "vpc_name": "CCE-AutoCreate-VPC-7qvs1",       
            "created_at": "2019-09-23T02:40:06.123Z",
            "error_code": null,
            "user_id": "50a4156d334a4a82b8745dc730dc1e00",
            "user_name": "hwstaff_f00443635",
            "maintain_begin": "02:00:00",
            "maintain_end": "06:00:00",
            "no_password_access": "true",
            "access_user": null,
            "enable_publicip": false,
            "publicip_id": null,
            "publicip_address": null,
            "enable_ssl": false,
            "service_upgrade": false,
            "service_task_id": "",
            "enterprise_project_id": "0",
            "tags": [
                {
                    "key": "dcs001",
                    "value": "001"
                },
                {
                    "key": "dcs002",
                    "value": "002"
                }
            ],
            "security_group_id": "0cc8fdb7-872a-49da-a062-88ccc39463b5"
        }],
    "instance_num": 1
}

状态码

操作成功的状态码如表4所示,其他响应见表1

表4 状态码

状态码

描述

200

查询所有实例列表成功。

分享:

    相关文档

    相关产品

关闭导读