分布式消息服务KAFKA版-查询所有实例列表:URI

时间:2024-01-24 16:40:33

URI

GET /v2/{project_id}/instances

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方式请参见获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

engine

String

消息引擎:kafka。

缺省值:kafka

name

String

实例名称。

instance_id

String

实例ID。

status

String

实例状态。 详细状态说明请参考实例状态说明

include_failure

String

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

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

exact_match_name

String

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

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

enterprise_project_id

String

企业项目ID。

offset

String

偏移量,表示从此偏移量开始查询, offset大于等于0。

limit

String

当次查询返回的最大实例个数,默认值为10,取值范围为1~50。

support.huaweicloud.com/api-kafka/ListInstances.html