ListInstances
ListInstancesRetrieves all RocketMQ instances in a Huawei Cloud region, with filters for name, status, and ID returning paginated read-only results so you can inspect and troubleshoot your messaging resources.
Instructions
查询所有实例列表(只读查询)
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"engine": "<engine>"
},
"name": "ListInstances"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | **参数解释**: 实例名称。 **约束限制**: 不涉及。 **取值范围**: 不涉及。 **默认取值**: 不涉及。 | |
| limit | No | **参数解释**: 当次查询返回的实例最大个数。 **约束限制**: 不涉及。 **取值范围**: 1~50。 **默认取值**: 10。 | |
| engine | Yes | **参数解释**: 消息引擎类型。 **约束限制**: 不涉及。 **取值范围**: - rocketmq:RocketMQ引擎。 - reliability:RocketMQ引擎别称。 **默认取值**: 不涉及。 | |
| offset | No | **参数解释**: 偏移量,表示从此偏移量开始查询。 **约束限制**: 不涉及。 **取值范围**: 大于等于0。 **默认取值**: 不涉及。 | |
| region | No | Overrides HUAWEI_REGION. | |
| status | No | **参数解释**: 实例状态。 **约束限制**: 不涉及。 **取值范围**: [详细状态说明请参考[实例状态说明](hrm-api-0010.xml)。](tag:hws,hws_hk,ctc,hws_eu,ocb,g42,hk_g42,tm,sbc,hk_sbc,cmcc,hk_tm,dt,ax,srg)[详细状态说明请参考[实例状态说明](kafka-api-180514012.xml)。](tag:hcs,fcs,hcs_oemout) **默认取值**: 不涉及。 | |
| project_id | No | Overrides HUAWEI_PROJECT_ID. | |
| instance_id | No | **参数解释**: 实例ID。获取方法如下:调用“查询所有实例列表”接口,从响应体中获取实例ID。 **约束限制**: 不涉及。 **取值范围**: 不涉及。 **默认取值**: 不涉及。 | |
| include_failure | No | **参数解释**: 是否返回创建失败的实例数。 **约束限制**: 不涉及。 **取值范围**: - 'true':返回创建失败的实例数。 - 'false':不返回创建失败的实例数。 **默认取值**: 不涉及。 | |
| exact_match_name | No | **参数解释**: 是否按照实例名称进行精确匹配查询。 **约束限制**: 不涉及。 **取值范围**: - 'true':表示按照实例名称进行精确匹配查询。 - 'false':表示模糊匹配实例名称查询。 **默认取值**: 'false'。 | |
| enterprise_project_id | No | **参数解释**: 企业项目ID。 **约束限制**: 不涉及。 **取值范围**: 不涉及。 **默认取值**: 不涉及。 |