Listing All Instances

Function

This API is used to query the instances of an account by the specified conditions.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/instances

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details, see Obtaining a Project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
engine	Yes	String	Message engine type. The value is rabbitmq.
name	No	String	Instance name.
instance_id	No	String	Instance ID.
status	No	String	Instance status. For details, see Instance Status.
include_failure	No	String	Whether to return the number of instances that fail to be created. If the value is true, the number of instances that failed to be created is returned. If the value is not true, the number is not returned.
exact_match_name	No	String	Whether to search for the instance that precisely matches a specified instance name. The default value is false, indicating that a fuzzy search is performed based on a specified instance name. If the value is true*, the instance that precisely matches a specified instance name is queried.
enterprise_project_id	No	String	Enterprise project ID.
offset	No	String	Offset, which is the position where the query starts. The value must be greater than or equal to 0.
limit	No	String	Maximum number of instances returned in the current query. The default value is 10. The value ranges from 1 to 50.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
instances	Array of ShowInstanceResp objects	Instance list.
instance_num	Integer	Number of instances.

**Table 4** ShowInstanceResp
Parameter	Type	Description
access_user	String	The username must be 4 to 64 characters long and can contain only letters, digits, and hyphens (-).
broker_num	Integer	Number of brokers.
name	String	Instance name.
engine	String	Message engine.
engine_version	String	Version of the message engine.
specification	String	Instance specifications. For a single-node RabbitMQ instance, VM specifications are returned. For a cluster RabbitMQ instance, VM specifications and the number of nodes are returned.
storage_space	Integer	Message storage space in GB.
used_storage_space	Integer	Used message storage space in GB.
connect_address	String	IP address of an instance.
port	Integer	Port of an instance.
status	String	Instance status.
description	String	Instance description
instance_id	String	Instance ID.
resource_spec_code	String	Resource specifications. dms.instance.rabbitmq.single.c3.2u4g: single-node RabbitMQ instance, 2 vCPUs 4 GB (VM specifications) dms.instance.rabbitmq.single.c3.4u8g: single-node RabbitMQ instance, 4 vCPUs 8 GB (VM specifications) dms.instance.rabbitmq.single.c3.8u16g: single-node RabbitMQ instance, 8 vCPUs 16 GB (VM specifications) dms.instance.rabbitmq.single.c3.16u32g: single-node RabbitMQ instance, 16 vCPUs 32 GB (VM specifications) dms.instance.rabbitmq.cluster.c3.4u8g.3: cluster RabbitMQ instance, 4 vCPUs 8 GB (VM specifications), 3 nodes dms.instance.rabbitmq.cluster.c3.4u8g.5: cluster RabbitMQ instance, 4 vCPUs 8 GB (VM specifications), 5 nodes dms.instance.rabbitmq.cluster.c3.4u8g.7: cluster RabbitMQ instance, 4 vCPUs 8 GB (VM specifications), 7 nodes dms.instance.rabbitmq.cluster.c3.8u16g.3: cluster RabbitMQ instance, 8 vCPUs 16 GB (VM specifications), 3 nodes dms.instance.rabbitmq.cluster.c3.8u16g.5: cluster RabbitMQ instance, 8 vCPUs 16 GB (VM specifications), 5 nodes dms.instance.rabbitmq.cluster.c3.8u16g.7: cluster RabbitMQ instance, 8 vCPUs 16 GB (VM specifications), 7 nodes dms.instance.rabbitmq.cluster.c3.16u32g.3: cluster RabbitMQ instance, 16 vCPUs 32 GB (VM specifications), 3 nodes dms.instance.rabbitmq.cluster.c3.16u32g.5: cluster RabbitMQ instance, 16 vCPUs 32 GB (VM specifications), 5 nodes dms.instance.rabbitmq.cluster.c3.16u32g.7: cluster RabbitMQ instance, 16 vCPUs 32 GB (VM specifications), 7 nodes
charging_mode	Integer	Billing mode. The value 1 means pay-per-use, and 0 means yearly/monthly.
vpc_id	String	VPC ID.
vpc_name	String	VPC name.
created_at	String	Time when an 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.
user_id	String	User ID.
user_name	String	Username.
order_id	String	Order ID. This parameter has a value only when the billing mode is yearly/monthly.
maintain_begin	String	Time at which the maintenance time window starts. The format is HH:mm:ss.
maintain_end	String	Time at which the maintenance time window ends. The format is HH:mm:ss.
enable_publicip	Boolean	Whether to enable public access for the RabbitMQ instance. true: enable false: disable
publicip_address	String	EIP bound to the RabbitMQ instance. The value of this parameter is null if public access is disabled.
publicip_id	String	ID of the EIP bound to the RabbitMQ instance. The value of this parameter is null if public access is disabled.
management_connect_address	String	Management address of a RabbitMQ instance.
ssl_enable	Boolean	Whether security authentication is enabled. true: enabled false: disabled
enterprise_project_id	String	Enterprise project ID.
is_logical_volume	Boolean	Whether the instance is a new instance. This parameter is used to distinguish old instances from new instances during instance capacity expansion. true: New instance, which allows dynamic disk capacity expansion without restarting the instance. false: old instance
extend_times	Integer	Number of disk expansion times. If the value exceeds 20, disk expansion is no longer allowed.
type	String	Instance type. The value can be cluster.
product_id	String	Product ID.
security_group_id	String	Security group ID.
security_group_name	String	Security group name.
subnet_id	String	Subnet ID.
available_zones	Array of strings	AZ to which the instance nodes belong. The AZ ID is returned.
total_storage_space	Integer	Message storage space in GB.
storage_resource_id	String	Storage resource ID.
storage_spec_code	String	I/O specifications.
ipv6_enable	Boolean	Whether IPv6 is enabled.
ipv6_connect_addresses	Array of strings	IPv6 connection address.
tags	Array of TagEntity objects	Tag list.

**Table 5** 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 with _sys_ 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 _.:=+-@

Example Requests

Listing all instances

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

Example Responses

Status code: 200

All instances are listed successfully.

{
  "instances" : [ {
    "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" : "********",
    "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" : [ ]
  } ],
  "instance_num" : 1
}

SDK Sample Code

The SDK sample code is as follows.

      
       
         
         
           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 ListInstancesDetailsSolution {

    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();
        ListInstancesDetailsRequest request = new ListInstancesDetailsRequest();
        try {
            ListInstancesDetailsResponse response = client.listInstancesDetails(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());
        }
    }
}

          

        

      
     

      
       
         
         
           # 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 = ListInstancesDetailsRequest()
        response = client.list_instances_details(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

          

        

      
     

      
       
         
         
           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.ListInstancesDetailsRequest{}
	response, err := client.ListInstancesDetails(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

          

        

      
     