Listing All Instances

project_id

Yes

String

Definition

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

Constraints

N/A

Range

N/A

Default Value

N/A

engine

Yes

String

Definition:

Message engine type. The value is rabbitmq.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

name

No

String

Definition:

Instance name. You can call the API for querying all instances to obtain the instance name. The instance name is in the response body.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

instance_id

No

String

Definition:

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

status

No

String

Definition

Instance status. For details, see Instance Status.

Constraints

N/A

Range

N/A

Default Value

N/A

include_failure

No

String

Definition:

Indicates whether to return the number of instances that fail to be created.

Constraints:

N/A

Range:

• true: yes

• false: no

Default Value:

N/A

exact_match_name

No

String

Definition:

Whether to search for the instance that precisely matches a specified instance name.

Constraints:

N/A

Range:

• true: yes

• false: no

Default Value:

false

enterprise_project_id

No

String

Definition:

Enterprise project ID.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

offset

No

String

Definition:

Offset, which is the position where the query starts.

Constraints:

N/A

Range:

≥ 0

Default Value:

N/A

limit

No

String

Definition:

Maximum number of instances that can be returned in a query.

Constraints:

N/A

Range:

1–50

Default Value:

10

instances

Array of ShowInstanceResp objects

Definition:

Instance list.

instance_num

Integer

Definition:

Number of instances.

Range:

N/A

access_user

String

Definition:

Authentication username.

Range:

N/A

broker_num

Integer

Definition:

Number of brokers.

Range:

• 1

• 3

• 5

• 7

name

String

Definition:

Instance name.

Range:

N/A

engine

String

Definition:

Engine type.

Range:

rabbitmq: RabbitMQ engine.

engine_version

String

Definition

Message engine version.

Range

• 3.8.35

• AMQP-0-9-1

specification

String

Definition:

Instance flavor.

Range:

• Single-node instance: VM flavor is returned.

• Cluster instance: VM flavor and number of brokers are returned.

storage_space

Integer

Definition:

Message storage space, in GB.

Range:

N/A

used_storage_space

Integer

Definition:

Used message storage space, in GB.

Range:

N/A

dns_enable

Boolean

Definition:

Whether to enable domain name access to an instance.

Range:

• true: yes

• false: no

connect_address

String

Definition:

Instance IP address for private access.

Range:

N/A

connect_domain_name

String

Definition:

Instance domain name for private access.

Range:

N/A

public_connect_address

String

Definition:

Instance IP address for public access.

Range:

N/A

public_connect_domain_name

String

Definition:

Instance domain name for public access.

Range:

N/A

port

Integer

Definition:

Instance port.

Range:

N/A

status

String

Definition

Instance status.

Range

For details, see Instance Status.

description

String

Definition:

Instance description.

Range:

N/A

instance_id

String

Definition:

Instance ID.

Range:

N/A

resource_spec_code

String

Definition

Resource specification ID.

Range

• 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

Definition:

Billing mode.

Range:

• 1: Pay-per-use

• 0: Yearly/Monthly

vpc_id

String

Definition:

VPC ID.

Range:

N/A

vpc_name

String

Definition:

VPC name.

Range:

N/A

created_at

String

Definition:

Time when the creation is complete. 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.

Range:

N/A

user_id

String

Definition:

User ID.

Range:

N/A

user_name

String

Definition:

Username.

Range:

N/A

order_id

String

Definition:

Indicates an order ID. This parameter has a value only when the billing mode is yearly/monthly mode.

Range:

N/A

maintain_begin

String

Definition:

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

Range:

N/A

maintain_end

String

Definition:

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

Range:

N/A

enable_publicip

Boolean

Definition:

Indicates whether to enable public access for a RabbitMQ instance.

Range:

• true: yes

• false: no

publicip_address

String

Definition:

Indicates the EIP bound to a RabbitMQ instance.

The value of this parameter is null if public access is disabled.

Range:

• true: yes

• false: no

publicip_id

String

Definition:

Indicates the ID of the EIP bound to a RabbitMQ instance.

The value of this parameter is null if public access is disabled.

Range:

N/A

management_connect_address

String

Definition:

Management address of a RabbitMQ instance.

Range:

N/A

management_connect_domain_name

String

Definition:

Management domain name of a RabbitMQ instance.

Range:

N/A

public_management_connect_address

String

Definition:

Public management address of a RabbitMQ instance.

Range:

N/A

public_management_connect_domain_name

String

Definition:

Public management domain name of a RabbitMQ instance.

Range:

N/A

ssl_enable

Boolean

Definition:

Whether security authentication is enabled.

Range:

• true: yes

• false: no

enterprise_project_id

String

Definition:

Enterprise project ID.

Range:

N/A

is_logical_volume

Boolean

Definition:

Distinguishes old instances from new instances during instance capacity expansion.

Range:

• true: New instance, which allows dynamic disk capacity expansion without restarting the instance.

• false: Some old instance, which does not support disk capacity expansion.

extend_times

Integer

Definition

Times of scaling up the instance disk.

Range

N/A

type

String

Definition:

Instance type.

Range:

• single: single-node

• cluster: cluster

product_id

String

Definition:

Product ID.

Range:

N/A

security_group_id

String

Definition:

Security group ID.

Range:

N/A

security_group_name

String

Definition:

Name of the tenant security group.

Range:

N/A

subnet_id

String

Definition:

Subnet ID.

Range:

N/A

available_zones

Array of strings

Definition:

ID of the AZ where an instance node is located.

available_zone_names

Array of strings

Definition:

Name of the AZ where an instance node is located.

total_storage_space

Integer

Definition:

Total message storage space, in GB.

Range:

N/A

storage_resource_id

String

Definition:

Storage resource ID.

Range:

N/A

storage_spec_code

String

Definition:

I/O specification.

Range:

N/A

ipv6_enable

Boolean

Definition:

Whether IPv6 is enabled.

Range:

• true: yes

• false: no

ipv6_connect_addresses

Array of strings

Definition:

IPv6 connection address.

tags

Array of TagEntity objects

Definition:

Tag list.

service_type

String

Definition

Service type.

Range

advanced

storage_type

String

Definition

Storage type.

Range

hec

key

String

Definition:

Tag key.

Range:

N/A

value

String

Definition:

Tag value.

Range:

N/A

200

All instances are listed successfully.