分布式缓存服务 DCS-查询所有实例列表:URI

时间:2023-11-01 16:25:20

URI

GET /v1.0/{project_id}/instances?start={start}&limit={limit}&name={name}&status={status}&id={id}&include_failure={include_failure}&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地址。

include_failure

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=&include_failure=true&isExactMatchName=false  

或:

GET https://{dcs_endpoint}/v1.0/bd6b78e2ff9e4e47bc260803ddcc7a21/instances?tags=dcs001=001,dcs002=002
support.huaweicloud.com/api-dcs/dcs-api-0312006.html