查询所有实例列表
功能介绍
查询租户的实例列表,支持按照条件查询。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/instances
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方式请参见获取项目ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
engine |
是 |
String |
消息引擎:rocketmq。 |
name |
否 |
String |
实例名称。 |
instance_id |
否 |
String |
实例ID。 |
status |
否 |
String |
实例状态,详细状态说明请参考实例状态说明。 |
include_failure |
否 |
String |
是否返回创建失败的实例数。 当参数值为“true”时,返回创建失败的实例数。参数值为“false”或者其他值,不返回创建失败的实例数。 |
exact_match_name |
否 |
String |
是否按照实例名称进行精确匹配查询。 默认为“false”,表示模糊匹配实例名称查询。若参数值为“true”表示按照实例名称进行精确匹配查询。 |
enterprise_project_id |
否 |
String |
企业项目ID。 |
limit |
否 |
Integer |
当次查询返回的最大个数,默认值为10,取值范围为1~50。 |
offset |
否 |
Integer |
偏移量,表示从此偏移量开始查询,offset大于等于0。 |
请求参数
无
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
instances |
Array of ShowInstanceResp objects |
实例列表。 |
instance_num |
Integer |
实例数量。 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
实例名称。 |
engine |
String |
引擎。 |
status |
String |
状态。 |
description |
String |
消息描述。 |
type |
String |
实例类型:集群,cluster。 |
specification |
String |
实例规格。 |
engine_version |
String |
版本。 |
instance_id |
String |
实例ID。 |
charging_mode |
Integer |
付费模式,1表示按需计费,0表示包年/包月计费。 |
vpc_id |
String |
私有云ID。 |
vpc_name |
String |
私有云名称。 |
created_at |
String |
完成创建时间。 格式为时间戳,指从格林威治时间1970年01月01日00时00分00秒起至指定时间的偏差总毫秒数。 |
product_id |
String |
产品标识。 |
security_group_id |
String |
安全组ID。 |
security_group_name |
String |
租户安全组名称。 |
subnet_id |
String |
子网ID。 |
subnet_name |
String |
子网名称。 |
subnet_cidr |
String |
子网路由(仅RocketMQ 5.x版本会显示此字段)。 |
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 |
是否开启消息收集功能。 |
storage_space |
Integer |
存储空间,单位:GB。 |
used_storage_space |
Integer |
已用消息存储空间,单位:GB。 |
enable_publicip |
Boolean |
是否开启公网。 |
publicip_id |
String |
实例绑定的弹性IP地址的ID。以英文逗号隔开多个弹性IP地址的ID。如果开启了公网访问功能(即enable_publicip为true),该字段为必选。 |
publicip_address |
String |
公网IP地址。 |
ssl_enable |
Boolean |
是否开启SSL。 |
cross_vpc_info |
String |
跨VPC访问信息。 |
storage_resource_id |
String |
存储资源ID。 |
storage_spec_code |
String |
存储规格代码。 |
service_type |
String |
服务类型。 |
storage_type |
String |
存储类型。 |
extend_times |
Long |
扩展时间。 |
ipv6_enable |
Boolean |
是否开启IPv6。 |
support_features |
String |
实例支持的特性功能。 |
disk_encrypted |
Boolean |
是否开启磁盘加密。 |
ces_version |
String |
云监控版本。 |
node_num |
Integer |
节点数。 |
new_spec_billing_enable |
Boolean |
是否启用新规格计费。 |
enable_acl |
Boolean |
是否开启访问控制列表。 |
broker_num |
Integer |
节点数(仅RocketMQ 4.8.0版本会显示此字段)。 |
namesrv_address |
String |
元数据地址。 |
broker_address |
String |
业务数据地址。 |
public_namesrv_address |
String |
公网元数据地址。 |
public_broker_address |
String |
公网业务数据地址。 |
grpc_address |
String |
grpc连接地址(仅RocketMQ 5.x版本会显示此字段)。 |
public_grpc_address |
String |
公网grpc连接地址(仅RocketMQ 5.x版本会显示此字段)。 |
enterprise_project_id |
String |
企业项目ID。 |
tags |
Array of TagEntity objects |
标签列表。 |
total_storage_space |
Integer |
总存储空间。 |
resource_spec_code |
String |
资源规格。 |
请求示例
查询所有实例的列表。
GET https://{endpoint}/v2/{project_id}/instances?engine=reliability
响应示例
状态码: 200
查询所有实例列表成功。
-
{ "instances" : [ { "name" : "reliability-ztest", "engine" : "reliability", "status" : "RUNNING", "description" : "", "type" : "cluster", "specification" : "c6.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", "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, "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" : "kafka.crossvpc.domain.enable,feature.physerver.kafka.topic.accesspolicy,rabbitmq.plugin.management,rocketmq.acl,roma_app_enable,auto_topic_switch,feature.physerver.kafka.user.manager,enable.new.authinfo,route,kafka.config.dynamic.modify.enable,kafka.new.pod.port,feature.physerver.kafka.topic.modify,message_trace_enable,features.pod.token.access,kafka.ssl.cert.modify.enable,roma.user.manage.no.support,feature.physerver.kafka.pulbic.dynamic,features.log.collection,kafka.config.static.modify.enable", "disk_encrypted" : false, "ces_version" : "linux,v1,v2", "node_num" : 5, "new_spec_billing_enable" : true, "broker_num" : 1, "namesrv_address" : "***", "broker_address" : "***", "public_namesrv_address" : "***", "public_broker_address" : "***", "grpc_address" : "***", "public_grpc_address" : "***" } ], "instance_num" : 1 }
SDK代码示例
SDK代码示例如下。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
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("<YOUR REGION>")) .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()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# 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("<YOUR REGION>")) \ .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) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
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 := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := rocketmq.NewRocketMQClient( rocketmq.RocketMQClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListInstancesRequest{} response, err := client.ListInstances(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
查询所有实例列表成功。 |
错误码
请参见错误码。