查询指定实例
功能介绍
查询指定实例的详细信息。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/instances/{instance_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方式请参见获取项目ID。 |
instance_id |
是 |
String |
实例ID。 |
请求参数
无
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
access_user |
String |
认证用户名,只能由英文字母、数字、中划线组成,长度为4~64的字符。 |
broker_num |
Integer |
代理个数。 |
name |
String |
实例名称。 |
engine |
String |
消息引擎。 |
engine_version |
String |
消息引擎版本。 |
specification |
String |
实例规格。
|
storage_space |
Integer |
消息存储空间,单位:GB。 |
used_storage_space |
Integer |
已使用的消息存储空间,单位:GB。 |
dns_enable |
Boolean |
实例是否开启域名访问功能。
|
connect_address |
String |
实例内网连接IP地址。 |
connect_domain_name |
String |
实例内网连接域名。 |
public_connect_address |
String |
实例公网连接IP地址。 |
public_connect_domain_name |
String |
实例公网连接域名。 |
port |
Integer |
实例连接端口。 |
status |
String |
实例的状态。 |
description |
String |
实例描述。 |
instance_id |
String |
实例ID。 |
resource_spec_code |
String |
资源规格标识。
|
charging_mode |
Integer |
付费模式,1表示按需计费,0表示包年/包月计费。 |
vpc_id |
String |
VPC ID。 |
vpc_name |
String |
VPC的名称。 |
created_at |
String |
完成创建时间。格式为时间戳,指从格林威治时间 1970年01月01日00时00分00秒起至指定时间的偏差总毫秒数。 |
user_id |
String |
用户ID。 |
user_name |
String |
用户名。 |
order_id |
String |
订单ID,只有在包周期计费时才会有order_id值,其他计费方式order_id值为空。 |
maintain_begin |
String |
维护时间窗开始时间,格式为HH:mm:ss。 |
maintain_end |
String |
维护时间窗结束时间,格式为HH:mm:ss。 |
enable_publicip |
Boolean |
RabbitMQ实例是否开启公网访问功能。
|
publicip_address |
String |
RabbitMQ实例绑定的弹性IP地址。 如果未开启公网访问功能,该字段值为null。 |
publicip_id |
String |
RabbitMQ实例绑定的弹性IP地址的ID。 如果未开启公网访问功能,该字段值为null。 |
management_connect_address |
String |
RabbitMQ实例的管理地址。 |
management_connect_domain_name |
String |
RabbitMQ实例的管理域名。 |
public_management_connect_address |
String |
RabbitMQ实例的公网管理地址。 |
public_management_connect_domain_name |
String |
RabbitMQ实例的公网管理域名。 |
ssl_enable |
Boolean |
是否开启安全认证。
|
enterprise_project_id |
String |
企业项目ID。 |
is_logical_volume |
Boolean |
实例扩容时用于区分老实例与新实例。
|
extend_times |
Integer |
实例扩容磁盘次数,如果超过20次则无法扩容磁盘。 |
type |
String |
实例类型:集群,cluster。 |
product_id |
String |
产品标识。 |
security_group_id |
String |
安全组ID。 |
security_group_name |
String |
租户安全组名称。 |
subnet_id |
String |
子网ID。 |
available_zones |
Array of strings |
实例节点所在的可用区,返回“可用区ID”。 |
total_storage_space |
Integer |
总共消息存储空间,单位:GB。 |
storage_resource_id |
String |
存储资源ID。 |
storage_spec_code |
String |
IO规格。 |
ipv6_enable |
Boolean |
是否开启ipv6。 |
ipv6_connect_addresses |
Array of strings |
IPv6的连接地址。 |
tags |
Array of TagEntity objects |
标签列表。 |
请求示例
查询指定实例的详细信息。
GET https://{endpoint}/v2/{project_id}/instances/{instance_id}
响应示例
状态码: 200
查询指定实例成功。
-
查询指定实例成功。
{ "name" : "api-explorer", "engine" : "rabbitmq", "port" : 5672, "status" : "RUNNING", "type" : "single", "specification" : "2vCPUs 4GB", "engine_version" : "3.8.35", "connect_address" : "192.168.0.74", "instance_id" : "de873040-d661-4770-aa96-9329c71d7c8a", "resource_spec_code" : "dms.instance.rabbitmq.single.c3.2u4g", "charging_mode" : 1, "vpc_id" : "40a6501e-85ca-4449-a0db-b8bc7f0cec28", "vpc_name" : "vpc-a400", "created_at" : "1590047080687", "product_id" : "00300-30109-0--0", "security_group_id" : "bfd68e26-f8ef-4a91-a373-0a8f5c198601", "security_group_name" : "Sys-default", "subnet_id" : "a7f9a564-30dd-4059-8124-364ca6554578", "available_zones" : [ "9f1c5806706d4c1fb0eb72f0a9b18c77" ], "user_id" : "3df5acbc24a54fadb62a043c9000a307", "user_name" : "paas_dms_01", "maintain_begin" : "22:00:00", "maintain_end" : "02:00:00", "storage_space" : 88, "total_storage_space" : 100, "used_storage_space" : 4, "enable_publicip" : false, "ssl_enable" : false, "management_connect_address" : "http://192.168.0.74:15672", "storage_resource_id" : "52be287d-1d6a-4d30-937e-185b3f176fc4", "storage_spec_code" : "dms.physical.storage.normal", "enterprise_project_id" : "0", "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value2" } ], "is_logical_volume" : true, "extend_times" : 0, "ipv6_enable" : false, "ipv6_connect_addresses" : [ ], "broker_num" : 1, "access_user" : "root_01" }
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 48 |
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.rabbitmq.v2.region.RabbitMQRegion; import com.huaweicloud.sdk.rabbitmq.v2.*; import com.huaweicloud.sdk.rabbitmq.v2.model.*; public class ShowInstanceSolution { 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); RabbitMQClient client = RabbitMQClient.newBuilder() .withCredential(auth) .withRegion(RabbitMQRegion.valueOf("<YOUR REGION>")) .build(); ShowInstanceRequest request = new ShowInstanceRequest(); request.withInstanceId("{instance_id}"); try { ShowInstanceResponse response = client.showInstance(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 32 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkrabbitmq.v2.region.rabbitmq_region import RabbitMQRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkrabbitmq.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 = RabbitMQClient.new_builder() \ .with_credentials(credentials) \ .with_region(RabbitMQRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowInstanceRequest() request.instance_id = "{instance_id}" response = client.show_instance(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 38 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" rabbitmq "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rabbitmq/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rabbitmq/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rabbitmq/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 := rabbitmq.NewRabbitMQClient( rabbitmq.RabbitMQClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ShowInstanceRequest{} request.InstanceId = "{instance_id}" response, err := client.ShowInstance(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
查询指定实例成功。 |
错误码
请参见错误码。