# 查询所有实例列表 - ListInstances #### 功能介绍 查询租户的实例列表，支持按照条件查询。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-hrm/api-call-process.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-hrm/api-grant-policy.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | dms:instance:list | List | rocketmq \* | g:EnterpriseProjectId | - | - | #### URI GET /v2/{project_id}/instances 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID，获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-hrm/hrm-api-0011.html)。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | engine | 否 | String | **参数解释**： 消息引擎类型。 **约束限制**： 不涉及。 **取值范围**： - rocketmq：RocketMQ消息引擎。 - reliability：RocketMQ消息引擎别称。 **默认取值**： 不涉及。 | | name | 否 | String | **参数解释**： 实例名称。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | instance_id | 否 | String | **参数解释**： 实例ID。获取方法如下：调用"查询所有实例列表"接口，从响应体中获取实例ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | status | 否 | String | **参数解释**： 实例状态。 **约束限制**： 不涉及。 **取值范围**： 详细状态说明请参考[实例状态说明](https://support.huaweicloud.com/api-hrm/hrm-api-0010.html)。 **默认取值**： 不涉及。 | | include_failure | 否 | String | **参数解释**： 是否返回创建失败的实例数。 **约束限制**： 不涉及。 **取值范围**： - 'true'：返回创建失败的实例数。 - 'false'：不返回创建失败的实例数。 **默认取值**： 不涉及。 | | exact_match_name | 否 | String | **参数解释**： 是否按照实例名称进行精确匹配查询。 **约束限制**： 不涉及。 **取值范围**： - 'true'：表示按照实例名称进行精确匹配查询。 - 'false'：表示模糊匹配实例名称查询。 **默认取值**： 'false'。 | | enterprise_project_id | 否 | String | **参数解释**： 企业项目ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | limit | 否 | Integer | **参数解释**： 查询返回实例的个数。 **约束限制**： 不涉及。 **取值范围**： 1\~50。 **默认取值**： 10。 | | offset | 否 | Integer | **参数解释**： 偏移量，表示从此偏移量开始查询。 **约束限制**： 不涉及。 **取值范围**： 大于等于0。 **默认取值**： 不涉及。 | #### 请求参数 无 #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | instances | Array of [InstanceDetail] objects | **参数解释**： 实例列表。 **取值范围**： 不涉及。 | | instance_num | Integer | **参数解释**： 实例数量。 **取值范围**： 不涉及。 | 表4InstanceDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释**： 实例名称。 **取值范围**： 不涉及。 | | engine | String | **参数解释**： 消息引擎类型。 **取值范围**： - rocketmq：RocketMQ消息引擎。 - reliability：RocketMQ消息引擎别称。 | | status | String | **参数解释**： 实例状态。 **取值范围**： 详细状态说明请参考[实例状态说明](https://support.huaweicloud.com/api-hrm/hrm-api-0010.html)。 | | description | String | **参数解释**： 实例描述。 **取值范围**： 不涉及。 | | type | String | **参数解释**： 实例类型。 **取值范围**： - single：4.8.0单机。 - cluster：4.8.0集群。 - single.basic：5.x单机基础版。 - cluster.basic：5.x集群基础版。 - single.professional：5.x单机专业版。 - cluster.professional：5.x集群专业版。 | | specification | String | **参数解释**： 规格说明。 **取值范围**： - 4.8.0版本时，该参数取值由"资源规格"和"代理（个）"组成，如：rocketmq.4u8g.cluster.small \* 1 broker。 - 5.x基础版时，该参数取值由"资源规格"和"实例TPS"，如：rocketmq.b2.large.4, 2000 tps。 - 5.x单机专业版时，该参数取值由"资源规格"和"实例TPS"，如：rocketmq.p1.large.1, 500 tps。 - 5.x集群专业版时，该参数取值由"资源规格"、"实例TPS"和"弹性TPS"，如：rocketmq.p2.large.8, 4000 tps, 2000 elastic_tps。 资源规格和其他参数取值请参考[产品规格](https://support.huaweicloud.com/productdesc-hrm/hrm-pd-004.html)章节中对应版本的实例规格说明表。 | | engine_version | String | **参数解释**： 实例版本。 **取值范围**： - 4.8.0 - 5.x | | instance_id | String | **参数解释**： 实例ID。 **取值范围**： 不涉及。 | | arch_type | String | **参数解释**： 架构类型。 **取值范围**： - X86。 - ARM。 | | charging_mode | Integer | **参数解释**： 付费模式。 **取值范围**： 1表示按需计费，0表示包年/包月计费。 | | vpc_id | String | **参数解释**： 虚拟私有云ID。 **取值范围**： 不涉及。 | | vpc_name | String | **参数解释**： 虚拟私有云名称。 **取值范围**： 不涉及。 | | created_at | String | **参数解释**： 完成创建时间。 格式为时间戳，指从格林威治时间1970年01月01日00时00分00秒起至指定时间的偏差总毫秒数。 **取值范围**： 不涉及。 | | product_id | String | **参数解释**： RocketMQ实例规格。 **取值范围**： - c6.4u8g.cluster.small：单个代理最大Topic数2000，单个代理最大消费组数2000 - c6.4u8g.cluster：单个代理最大Topic数4000，单个代理最大消费组数4000 - c6.8u16g.cluster：单个代理最大Topic数8000，单个代理最大消费组数8000 - c6.12u24g.cluster：单个代理最大Topic数12000，单个代理最大消费组数12000 - c6.16u32g.cluster：单个代理最大Topic数16000，单个代理最大消费组数16000 - rocketmq.b1.large.1：RocketMQ 5.x 基础版单机规格，实例TPS 500 - rocketmq.b2.large.4：RocketMQ 5.x 基础版集群规格，实例TPS 2000 - rocketmq.b2.large.8：RocketMQ 5.x 基础版集群规格，实例TPS 4000 - rocketmq.b2.large.12：RocketMQ 5.x 基础版集群规格，实例TPS 6000 - rocketmq.p1.large.1：RocketMQ 5.x 专业版单机规格，实例TPS 500 - rocketmq.p2.large.8：RocketMQ 5.x 专业版集群规格，实例TPS 4000 - rocketmq.p2.large.12：RocketMQ 5.x 专业版集群规格，实例TPS 6000 - rocketmq.p2.large.20：RocketMQ 5.x 专业版集群规格，实例TPS 10000 - rocketmq.p2.large.40：RocketMQ 5.x 专业版集群规格，实例TPS 20000 - rocketmq.p2.large.100：RocketMQ 5.x 专业版集群规格，实例TPS 50000 - rocketmq.p2.large.150：RocketMQ 5.x 专业版集群规格，实例TPS 75000 - rocketmq.p2.large.200：RocketMQ 5.x 专业版集群规格，实例TPS 100000 - rocketmq.p2.large.300：RocketMQ 5.x 专业版集群规格，实例TPS 150000 | | security_group_id | String | **参数解释**： 安全组ID。 **取值范围**： 不涉及。 | | security_group_name | String | **参数解释**： 安全组名称。 **取值范围**： 不涉及。 | | subnet_id | String | **参数解释**： 子网ID。 **取值范围**： 不涉及。 | | subnet_cidr | String | **参数解释**： 子网路由。 **取值范围**： 不涉及。 | | available_zones | Array of strings | **参数解释**： 可用区ID列表。 **取值范围**： 不涉及。 | | available_zone_names | Array of strings | **参数解释**： 可用区名称列表。 **取值范围**： 不涉及。 | | user_id | String | **参数解释**： 用户ID。 **取值范围**： 不涉及。 | | user_name | String | **参数解释**： 用户名。 **取值范围**： 不涉及。 | | maintain_begin | String | **参数解释**： 维护时间窗开始时间，格式为HH:mm:ss。 **取值范围**： 不涉及。 | | maintain_end | String | **参数解释**： 维护时间窗结束时间，格式为HH:mm:ss。 **取值范围**： 不涉及。 | | enable_log_collection | Boolean | **参数解释**： 是否开启消息收集功能。 **取值范围**： - true：开启。 - false：不开启。 | | storage_space | Integer | **参数解释**： 存储空间，单位：GB。 **取值范围**： 不同的实例规格支持不同的存储配置。 | | used_storage_space | Integer | **参数解释**： 已用消息存储空间，单位：GB。 **取值范围**： 不涉及。 | | enable_publicip | Boolean | **参数解释**： 是否开启公网。 **取值范围**： - true：开启公网。 - false：不开启公网。 | | publicip_id | String | **参数解释**： 实例绑定的弹性IP地址的ID。 以英文逗号隔开多个弹性IP地址的ID。 如果开启了公网访问功能（即enable_publicip为true），该字段为必选。 **取值范围**： 不涉及。 | | publicip_address | String | **参数解释**： 公网IP地址。 **取值范围**： 不涉及。 | | ssl_enable | Boolean | **参数解释**： 是否开启SSL。 **取值范围**： - true：开启。 - false：未开启。 | | cross_vpc_info | String | **参数解释**： 跨VPC访问信息。 **取值范围**： 不涉及。 | | storage_resource_id | String | **参数解释**： 存储资源ID。 **取值范围**： 不涉及。 | | storage_spec_code | String | **参数解释**： 存储规格代码。 **取值范围**： - dms.physical.storage.high.v2：高IO类型磁盘。RocketMQ 5.x专业版不支持该取值。 - dms.physical.storage.ultra.v2：超高IO类型磁盘。 - dms.physical.storage.general：使用通用型SSD的磁盘类型。 - dms.physical.storage.extreme：使用极速型SSD的磁盘类型。 | | service_type | String | **参数解释**： 服务类型。 **取值范围**： - advanced：华为云服务类型。 - dec：专属云服务类型。 | | storage_type | String | **参数解释**： 存储类型。 **取值范围**： - hec：华为云存储类型。 - dss：专属云存储类型。 | | extend_times | Long | **参数解释**： 扩展时间。 **取值范围**： 不涉及。 | | ipv6_enable | Boolean | **参数解释**： 是否开启IPv6。 **取值范围**： - true：开启。 - false：未开启。 | | support_features | String | **参数解释**： 实例支持的特性功能。 **取值范围**： 不涉及。 | | disk_encrypted | Boolean | **参数解释**： 是否开启磁盘加密。 **取值范围**： - true：开启。 - false：不开启。 | | disk_encrypted_key | String | **参数解释**： 磁盘加密key，未开启磁盘加密时为空。 **取值范围**： 不涉及。 | | ces_version | String | **参数解释**： 云监控版本。 **取值范围**： 不涉及。 | | node_num | Integer | **参数解释**： 节点数。（仅RocketMQ 4.8.0版本会显示此字段） **取值范围**： 不涉及。 | | new_spec_billing_enable | Boolean | **参数解释**： 是否启用新规格计费。 **取值范围**： - true：开启。 - false：未开启。 | | enable_acl | Boolean | **参数解释**： 是否开启访问控制列表。 **取值范围**： - true：开启。 - false：未开启。 | | broker_num | Integer | **参数解释**： Broker节点数。 **取值范围**： 不涉及。 | | dns_enable | Boolean | **参数解释**： 实例是否开启域名访问功能。 **取值范围**： - true：开启。 - false：不开启。 | | namesrv_address | String | **参数解释**： 元数据地址。 **取值范围**： 不涉及。 | | namesrv_domain_name | String | **参数解释**： 元数据域名。 **取值范围**： 不涉及。 | | broker_address | String | **参数解释**： 业务数据地址。 **取值范围**： 不涉及。 | | ipv6_broker_address | String | **参数解释**： 业务数据IPv6的地址。 **取值范围**： 不涉及。 | | public_namesrv_address | String | **参数解释**： 公网元数据地址。 **取值范围**： 不涉及。 | | ipv6_namesrv_address | String | **参数解释**： 元数据IPv6的地址。 **取值范围**： 不涉及。 | | public_namesrv_domain_name | String | **参数解释**： 公网元数据域名。 **取值范围**： 不涉及。 | | public_broker_address | String | **参数解释**： 公网业务数据地址。 **取值范围**： 不涉及。 | | grpc_address | String | **参数解释**： gRPC连接地址（仅RocketMQ 5.x版本会显示此字段）。 **取值范围**： 不涉及。 | | grpc_domain_name | String | **参数解释**： gRPC连接域名（仅RocketMQ 5.x版本会显示此字段）。 **取值范围**： 不涉及。 | | public_grpc_address | String | **参数解释**： 公网gRPC连接地址（仅RocketMQ 5.x版本会显示此字段）。 **取值范围**： 不涉及。 | | public_grpc_domain_name | String | **参数解释**： 公网gRPC连接域名（仅RocketMQ 5.x版本会显示此字段）。 **取值范围**： 不涉及。 | | enterprise_project_id | String | **参数解释**： 企业项目ID。 **取值范围**： 不涉及。 | | tags | Array of [TagEntity] objects | **参数解释**： 标签列表。 **取值范围**： 不涉及。 | | total_storage_space | Integer | **参数解释**： 总存储空间。 **取值范围**： 不涉及。 | | resource_spec_code | String | **参数解释**： 资源规格。 **取值范围**： 不涉及。 | | produce_portion | Integer | **参数解释**： 生产TPS占比。 **取值范围**： 不涉及。 | | consume_portion | Integer | **参数解释**： 消费TPS占比。 **取值范围**： 不涉及。 | | dr_enable | Boolean | **参数解释**： 是否为容灾实例。 **取值范围**： - true：容灾实例。 - false：非容灾实例。 | | quota_address | String | **参数解释**： 流控地址。 **取值范围**： 不涉及。 | | max_msg_process_tps | Integer | **参数解释**： 最大消息TPS。 **取值范围**： 不涉及。 | | config_ssl_need_restart_process | Boolean | **参数解释**： 配置SSL是否需要重启。 **取值范围**： - true：需要重启。 - false：不需要重启。 | | tls_mode | String | **参数解释**： 实例使用的安全协议。 **取值范围**： 不涉及。 | | enable_elastic_tps | Boolean | **参数解释**： 弹性TPS开关状态。 **取值范围**： - true：开启弹性TPS。 - false：不开启弹性TPS。 | 表5TagEntity | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释**： 标签键。 **取值范围**： 不涉及。 | | value | String | **参数解释**： 标签值。 **取值范围**： 不涉及。 | #### 请求示例 查询所有实例的列表。 ``` GET https://{endpoint}/v2/{project_id}/instances?engine=reliability ``` #### 响应示例 **状态码：200** 查询所有实例列表成功。 ``` { "instances" : [ { "name" : "reliability-ztest", "engine" : "reliability", "status" : "RUNNING", "description" : "", "type" : "cluster", "specification" : "rocketmq.4u8g.cluster * 1 broker", "engine_version" : "4.8.0", "instance_id" : "68fdc9a8-805e-439d-8dd9-25adc1c58bf6", "resource_spec_code" : "", "charging_mode" : 1, "vpc_id" : "3db8490c-4d6d-4d8f-8d3f-047b0de4c5cf", "vpc_name" : "vpc-1101840", "created_at" : "1636699753874", "product_id" : "c6.4u8g.cluster", "security_group_id" : "23c5977f-ff33-4b95-a73e-08d8a0bc4e6c", "security_group_name" : "Sys-default", "subnet_id" : "0a0f1fcb-f019-458d-b9e5-301867394d50", "subnet_cidr" : "192.168.0.0/24", "available_zones" : [ "9f1c5806706d4c1fb0eb72f0a9b18c77" ], "available_zone_names" : [ "AZ3" ], "user_id" : "0b01fbb53600d4671fa8c00673c71260", "user_name" : "", "maintain_begin" : "02:00:00", "maintain_end" : "06:00:00", "enable_log_collection" : false, "storage_space" : 558, "total_storage_space" : 600, "used_storage_space" : 28, "enable_publicip" : false, "ssl_enable" : false, "arch_type" : "X86", "cross_vpc_info" : "{\"192.168.1.21\":{\"advertised_ip\":\"192.168.1.21\",\"broker_port\":\"-\",\"port_id\":\"fa020857-d899-497c-a5f8-8dd90ed67ff7\",\"namesrv_port\":\"8301\"},\"192.168.1.246\":{\"advertised_ip\":\"192.168.1.246\",\"broker_port\":\"10100\",\"port_id\":\"c0f0586f-a4ee-41b5-a7f1-b4e554bbf12d\",\"namesrv_port\":\"-\"},\"192.168.1.77\":{\"advertised_ip\":\"192.168.1.77\",\"broker_port\":\"10101\",\"port_id\":\"8eb1d144-4315-402f-8498-37c9a10b630c\",\"namesrv_port\":\"-\"},\"192.168.1.159\":{\"advertised_ip\":\"192.168.1.159\",\"broker_port\":\"-\",\"port_id\":\"d35b22af-a202-4329-bda4-26e1bdf2aa8e\",\"namesrv_port\":\"8300\"},\"192.168.1.14\":{\"advertised_ip\":\"192.168.1.14\",\"broker_port\":\"10102\",\"port_id\":\"5fcb50fd-3af5-4123-a455-a67f1b926026\",\"namesrv_port\":\"-\"}}", "storage_resource_id" : "164bdaef-2e67-4fd5-be8b-a18f91d455a2", "storage_spec_code" : "dms.physical.storage.ultra.v2", "service_type" : "advanced", "storage_type" : "hec", "enterprise_project_id" : "0", "extend_times" : 0, "ipv6_enable" : false, "support_features" : "features.log.collection", "disk_encrypted" : true, "disk_encrypted_key" : "********-b953-4875-a743-************", "enable_acl" : true, "ces_version" : "linux,v1,v2", "node_num" : 5, "new_spec_billing_enable" : true, "broker_num" : 1, "dr_enable" : false, "namesrv_address" : "***", "config_ssl_need_restart_process" : false, "broker_address" : "***", "public_namesrv_address" : "***", "public_broker_address" : "***", "grpc_address" : "***", "public_grpc_address" : "***" } ], "instance_num" : 1 } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.rocketmq.v2.region.RocketMQRegion; import com.huaweicloud.sdk.rocketmq.v2.*; import com.huaweicloud.sdk.rocketmq.v2.model.*; public class ListInstancesSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); RocketMQClient client = RocketMQClient.newBuilder() .withCredential(auth) .withRegion(RocketMQRegion.valueOf("")) .build(); ListInstancesRequest request = new ListInstancesRequest(); try { ListInstancesResponse response = client.listInstances(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` - [Python] ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkrocketmq.v2.region.rocketmq_region import RocketMQRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkrocketmq.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = RocketMQClient.new_builder() \ .with_credentials(credentials) \ .with_region(RocketMQRegion.value_of("")) \ .build() try: request = ListInstancesRequest() response = client.list_instances(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" rocketmq "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := rocketmq.RocketMQClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := rocketmq.NewRocketMQClient(hcClient) request := &model.ListInstancesRequest{} response, err := client.ListInstances(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/sdk?api=ListInstances)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询所有实例列表成功。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-hrm/ErrorCode.html)。