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

时间：2024-01-24 16:40:32

分布式消息服务KAFKA版实例管理类接口

URI

GET /v1.0/{project_id}/instances?engine={engine}&name={name}&status={status}&id={id}&includeFailure={includeFailure}&exactMatchName={exactMatchName}&enterprise_project_id={enterprise_project_id}

参数说明见表1。

表1 参数说明
参数	类型	必选	说明
project_id	String	是	项目ID。
engine	String	否	消息引擎：kafka。
name	String	否	实例名称。
id	String	否	实例ID。
status	String	否	实例状态。详细状态说明见实例状态说明。
includeFailure	String	否	是否返回创建失败的实例数。当参数值为“true”时，返回创建失败的实例数。参数值为“false”或者其他值，不返回创建失败的实例数。
exactMatchName	String	否	是否按照实例名称进行精确匹配查询。默认为“false”，表示模糊匹配实例名称查询。若参数值为“true”表示按照实例名称进行精确匹配查询。
enterprise_project_id	String	否	企业项目ID。