# 查询指定实例 - ShowInstance #### 功能介绍 查询指定实例的详细信息。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-rabbitmq/rabbitmq-api-190611003.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-rabbitmq/api-grant-policy.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | dms:instance:getDetail | Read | rabbitmq \* | - g:ResourceTag/\ - g:EnterpriseProjectId | dms:instance:get | - vpc:vpcs:get - vpc:ports:get - vpc:securityGroups:get - vpc:subnets:get - eip:publicIps:get | #### URI GET /v2/{project_id}/instances/{instance_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID，获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-rabbitmq/rabbitmq-api-190611012.html)。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | instance_id | 是 | String | **参数解释**： 实例ID。获取方法如下：调用[查询所有实例列表](https://support.huaweicloud.com/api-rabbitmq/ListInstances.html)接口，从响应体中获取实例ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | #### 请求参数 无 #### 响应参数 **状态码：200** 表2响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | access_user | String | **参数解释**： 认证用户名。 **取值范围**： 不涉及。 | | broker_num | Integer | **参数解释**： 代理个数。 **取值范围**： - 1 - 3 - 5 - 7 | | name | String | **参数解释**： 实例名称。 **取值范围**： 不涉及。 | | engine | String | **参数解释**： 消息引擎类型。 **取值范围**： rabbitmq：RabbitMQ引擎。 | | engine_version | String | **参数解释**： 消息引擎版本。 **取值范围**： - 3.8.35 - AMQP-0-9-1 | | specification | String | **参数解释**： 实例规格。 **取值范围**： - 单机实例：返回vm规格。 - 集群实例：返回vm规格和节点数。 | | storage_space | Integer | **参数解释**： 消息存储空间，单位：GB。 **取值范围**： 不涉及。 | | used_storage_space | Integer | **参数解释**： 已使用的消息存储空间，单位：GB。 **取值范围**： 不涉及。 | | dns_enable | Boolean | **参数解释**： 实例是否开启域名访问功能。 **取值范围**： - true：开启 - false：未开启 | | connect_address | String | **参数解释**： 实例内网连接IP地址。 **取值范围**： 不涉及。 | | connect_domain_name | String | **参数解释**： 实例内网连接域名。 **取值范围**： 不涉及。 | | public_connect_address | String | **参数解释**： 实例公网连接IP地址。 **取值范围**： 不涉及。 | | public_connect_domain_name | String | **参数解释**： 实例公网连接域名。 **取值范围**： 不涉及。 | | port | Integer | **参数解释**： 实例连接端口。 **取值范围**： 不涉及。 | | status | String | **参数解释**： 实例状态。 **取值范围**： 详细状态说明请参考[实例状态说明](https://support.huaweicloud.com/api-rabbitmq/rabbitmq-api-180514012.html)。 | | description | String | **参数解释**： 实例描述。 **取值范围**： 不涉及。 | | instance_id | String | **参数解释**： 实例ID。 **取值范围**： 不涉及。 | | resource_spec_code | String | **参数解释**： 资源规格标识。 **取值范围**： - dms.instance.rabbitmq.single.c3.2u4g：RabbitMQ单机，vm规格2u4g - dms.instance.rabbitmq.single.c3.4u8g：RabbitMQ单机，vm规格4u8g - dms.instance.rabbitmq.single.c3.8u16g：RabbitMQ单机，vm规格8u16g - dms.instance.rabbitmq.single.c3.16u32g：RabbitMQ单机，vm规格16u32g - dms.instance.rabbitmq.cluster.c3.4u8g.3：RabbitMQ集群，vm规格4u8g，3个节点 - dms.instance.rabbitmq.cluster.c3.4u8g.5：RabbitMQ集群，vm规格4u8g，5个节点 - dms.instance.rabbitmq.cluster.c3.4u8g.7：RabbitMQ集群，vm规格4u8g，7个节点 - dms.instance.rabbitmq.cluster.c3.8u16g.3：RabbitMQ集群，vm规格8u16g，3个节点 - dms.instance.rabbitmq.cluster.c3.8u16g.5：RabbitMQ集群，vm规格8u16g，5个节点 - dms.instance.rabbitmq.cluster.c3.8u16g.7：RabbitMQ集群，vm规格8u16g，7个节点 - dms.instance.rabbitmq.cluster.c3.16u32g.3：RabbitMQ集群，vm规格16u32g，3个节点 - dms.instance.rabbitmq.cluster.c3.16u32g.5：RabbitMQ集群，vm规格16u32g，5个节点 - dms.instance.rabbitmq.cluster.c3.16u32g.7：RabbitMQ集群，vm规格16u32g，7个节点 | | charging_mode | Integer | **参数解释**： 付费模式。 **取值范围**： - 0表示包年/包月计费。 - 1表示按需计费。 | | 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实例是否开启公网访问功能。 **取值范围**： - true：开启 - false：未开启 | | 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 | **参数解释**： 是否开启安全认证。 **取值范围**： - true：开启 - false：未开启 | | enterprise_project_id | String | **参数解释**： 企业项目ID。 **取值范围**： 不涉及。 | | is_logical_volume | Boolean | **参数解释**： 实例扩容时用于区分老实例与新实例。 **取值范围**： - true：新创建的实例，允许磁盘动态扩容不需要重启。 - false：特别老的实例不支持磁盘扩容。 | | extend_times | Integer | **参数解释**： 实例扩容磁盘次数。 **取值范围**： 不涉及。 | | type | String | **参数解释**： 实例类型。 **取值范围**： - single：单机。 - cluster：集群。 | | product_id | String | **参数解释**： 产品标识。 **取值范围**： 不涉及。 | | security_group_id | String | **参数解释**： 安全组ID。 **取值范围**： 不涉及。 | | security_group_name | String | **参数解释**： 租户安全组名称。 **取值范围**： 不涉及。 | | subnet_id | String | **参数解释**： 子网ID。 **取值范围**： 不涉及。 | | available_zones | Array of strings | **参数解释**： 实例节点所在的可用区ID。 | | available_zone_names | Array of strings | **参数解释**： 实例节点所在的可用区名称。 | | total_storage_space | Integer | **参数解释**： 总共消息存储空间，单位：GB。 **取值范围**： 不涉及。 | | storage_resource_id | String | **参数解释**： 存储资源ID。 **取值范围**： 不涉及。 | | storage_spec_code | String | **参数解释**： IO规格。 **取值范围**： 不涉及。 | | ipv6_enable | Boolean | **参数解释**： 是否开启IPv6。 **取值范围**： - true：开启。 - false：不开启。 | | ipv6_connect_addresses | Array of strings | **参数解释**： IPv6的连接地址。 | | tags | Array of [TagEntity] objects | **参数解释**： 标签列表。 | | service_type | String | **参数解释**： 服务类型。 **取值范围**： advanced：服务类型。 | | storage_type | String | **参数解释**： 存储类型。 **取值范围**： hec：存储类型。 | | disk_encrypted | Boolean | **参数解释**： 是否开启磁盘加密。 **取值范围**： - true：开启 - false：不开启 | | disk_encrypted_key | String | **参数解释**： 磁盘加密key，未开启磁盘加密时为空。 **取值范围**： 不涉及。 | 表3TagEntity | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释**： 标签键。 **取值范围**： 不涉及。 | | value | String | **参数解释**： 标签值。 **取值范围**： 不涉及。 | #### 请求示例 查询指定实例的详细信息。 ``` 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" ], "available_zone_names" : [ "AZ1" ], "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, "dns_enable" : false, "connect_domain_name" : "", "public_connect_address" : "", "public_connect_domain_name" : "", "description" : "", "order_id" : "", "publicip_address" : null, "publicip_id" : null, "management_connect_domain_name" : "", "public_management_connect_address" : "", "public_management_connect_domain_name" : "", "service_type" : "advanced", "storage_type" : "hec", "disk_encrypted" : false, "disk_encrypted_key" : "", "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代码示例如下。 - [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.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("")) .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()); } } } ``` - [Python] ``` # 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("")) \ .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) ``` - [Go] ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := rabbitmq.RabbitMQClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := rabbitmq.NewRabbitMQClient(hcClient) 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](https://console.huaweicloud.com/apiexplorer/#/openapi/RabbitMQ/sdk?api=ShowInstance)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询指定实例成功。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-rabbitmq/ErrorCode.html)。