Updated on 2024-07-05 GMT+08:00

Querying an Instance

Function

This API is used to query the details about a specified instance.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/instances/{instance_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details, see Obtaining a Project ID.

instance_id

Yes

String

Instance ID.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

name

String

Instance name.

engine

String

Message engine.

status

String

Status.

description

String

Message description.

type

String

Instance type. Value: cluster.

specification

String

Instance specification.

engine_version

String

Version.

instance_id

String

Instance ID.

charging_mode

Integer

Billing mode. Options: 1: pay-per-use; 0: yearly/monthly.

vpc_id

String

VPC ID.

vpc_name

String

VPC name.

created_at

String

Time when the instance was created.

The time is in the format of timestamp, that is, the offset milliseconds from 1970-01-01 00:00:00 UTC to the specified time.

product_id

String

Product ID.

security_group_id

String

Security group ID.

security_group_name

String

Security group name.

subnet_id

String

Subnet ID.

subnet_name

String

Subnet name.

subnet_cidr

String

Subnet route. This field is available only for RocketMQ 5.x instances.

available_zones

Array of strings

IDs of AZs.

available_zone_names

Array of strings

Names of AZs.

user_id

String

User ID.

user_name

String

Username.

maintain_begin

String

Time at which the maintenance window starts. The format is HH:mm:ss.

maintain_end

String

Time at which the maintenance window ends. The format is HH:mm:ss.

enable_log_collection

Boolean

Whether log collection is enabled.

storage_space

Integer

Storage space. Unit: GB.

used_storage_space

Integer

Used message storage space. Unit: GB.

enable_publicip

Boolean

Whether public access is enabled.

publicip_id

String

ID of the EIP bound to the instance.Use commas (,) to separate multiple EIP IDs.This parameter is mandatory if public access is enabled (that is, enable_publicip is set to true).

publicip_address

String

Public IP address.

ssl_enable

Boolean

Whether SSL is enabled.

cross_vpc_info

String

Cross-VPC access information.

storage_resource_id

String

Storage resource ID.

storage_spec_code

String

Storage specification code.

service_type

String

Service type.

storage_type

String

Storage category.

extend_times

Long

Extension time.

ipv6_enable

Boolean

Whether IPv6 is enabled.

support_features

String

Features supported by the instance.

disk_encrypted

Boolean

Whether disk encryption is enabled.

ces_version

String

Cloud Eye version.

node_num

Integer

Node quantity.

new_spec_billing_enable

Boolean

Whether billing based on new specifications is enabled.

enable_acl

Boolean

Whether access control is enabled.

broker_num

Integer

Number of nodes. This field is available only for RocketMQ 4.8.0 instances.

namesrv_address

String

Metadata address.

broker_address

String

Service data address.

public_namesrv_address

String

Public network metadata address.

public_broker_address

String

Public network service data address.

grpc_address

String

gRPC address. This field is available only for RocketMQ 5.x instances.

public_grpc_address

String

gRPC address (public). This field is available only for RocketMQ 5.x instances.

enterprise_project_id

String

Enterprise project ID.

tags

Array of TagEntity objects

Tag list.

total_storage_space

Integer

Total storage space.

resource_spec_code

String

Resource specifications.

Table 3 TagEntity

Parameter

Type

Description

key

String

Tag key.

  • Must be specified.

  • Must be unique for the same instance.

  • Can contain 1 to 128 characters.

  • Can contain letters, digits, spaces, and special characters _.:=+-@

  • Cannot start or end with a space.

value

String

Tag value.

  • Can contain 0 to 255 characters.

  • Can contain letters, digits, spaces, and special characters _.:=+-@

  • Cannot start or end with a space.

Example Requests

Querying details of a specified instance

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}

Example Responses

Status code: 200

Instance queried successfully.

  • {
      "name" : "reliability-test",
      "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",
      "subnet_name" : "subnet-boce",
      "subnet_cidr" : "192.168.1.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" : true,
      "publicip_id" : "7e6b7beb-ef13-4805-878d-285890b17a12,87827295-84e1-4118-9ab3-a90dd8c9dace,91306a18-5781-4529-b739-5aeec10ec4e6,a68e8f0e-a24f-4521-910e-39696a56fcdf,bb1cd147-a7af-46ca-9548-99fec4034ba2",
      "publicip_address" : "***",
      "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,
      "enable_acl" : false,
      "broker_num" : 1,
      "namesrv_address" : "***",
      "broker_address" : "***",
      "public_namesrv_address" : "***",
      "public_broker_address" : "***",
      "grpc_address" : "***",
      "public_grpc_address" : "***"
    }

SDK Sample Code

The SDK sample code is as follows.

 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.rocketmq.v2.region.RocketMQRegion;
import com.huaweicloud.sdk.rocketmq.v2.*;
import com.huaweicloud.sdk.rocketmq.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);

        RocketMQClient client = RocketMQClient.newBuilder()
                .withCredential(auth)
                .withRegion(RocketMQRegion.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 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 = 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"
    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.ShowInstanceRequest{}
	request.InstanceId = "{instance_id}"
	response, err := client.ShowInstance(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Instance queried successfully.

Error Codes

See Error Codes.