Querying the Instance List

project_id

Yes

String

Parameter description:

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

Constraints:

N/A

Value range:

N/A

Default value:

N/A

engine

Yes

String

Parameter description:

Message engine.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

name

No

String

Parameter description:

Instance name.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

instance_id

No

String

Parameter description:

Instance ID. To obtain it, log in to the RocketMQ console and find the instance ID on the RocketMQ instance details page.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

status

No

String

Parameter description:

Instance status. For details, see Instance Status.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

include_failure

No

String

Parameter description:

Whether to return the number of instances that fail to be created.

Constraints:

N/A

Value range:

• 'true': yes

• 'false': no

Default value:

N/A

exact_match_name

No

String

Parameter description:

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

Constraints:

N/A

Value range:

• 'true': yes

• 'false': no

Default value:

'false'

enterprise_project_id

No

String

Parameter description:

Enterprise project ID.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

limit

No

Integer

Parameter description:

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

Constraints:

N/A

Value range:

1–50

Default value:

10

offset

No

Integer

Parameter description:

Offset where the query starts.

Constraints:

N/A

Value range:

≥ 0

Default value:

N/A

instances

Array of InstanceDetail objects

Parameter description:

Instance list.

Value range:

N/A

instance_num

Integer

Parameter description:

Number of instances.

Value range:

N/A

name

String

Parameter description:

Instance name.

Value range:

N/A

engine

String

Parameter description:

Message engine.

Value range:

N/A

status

String

Parameter description:

Status.

Value range:

N/A

description

String

Parameter description:

Message description.

Value range:

N/A

type

String

Parameter description:

Instance type.

Value range:

• single: single-node

• cluster: cluster

specification

String

Parameter description:

Instance specification.

Value range:

N/A

engine_version

String

Parameter description:

Instance version.

Value range:

N/A

instance_id

String

Parameter description:

Instance ID.

Value range:

N/A

charging_mode

Integer

Parameter description:

Billing mode.

Value range:

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

vpc_id

String

Parameter description:

VPC ID.

Value range:

N/A

vpc_name

String

Parameter description:

VPC name.

Value range:

N/A

created_at

String

Parameter description:

Time when 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.

Value range:

N/A

product_id

String

Parameter description:

Product ID.

Value range:

N/A

security_group_id

String

Parameter description:

Security group ID.

Value range:

N/A

security_group_name

String

Parameter description:

Security group name.

Value range:

N/A

subnet_id

String

Parameter description:

Subnet ID.

Value range:

N/A

subnet_cidr

String

Parameter description:

Subnet route. This field is displayed only for RocketMQ 5.x.

Value range:

N/A

available_zones

Array of strings

Parameter description:

List of AZ IDs.

Value range:

N/A

available_zone_names

Array of strings

Parameter description:

List of AZ names.

user_id

String

Parameter description:

User ID.

Value range:

N/A

user_name

String

Parameter description:

Username.

Value range:

N/A

maintain_begin

String

Parameter description:

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

Value range:

N/A

maintain_end

String

Parameter description:

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

Value range:

N/A

enable_log_collection

Boolean

Parameter description:

Whether log collection is enabled.

Value range:

• true: yes

• false: no

storage_space

Integer

Parameter description:

Storage space, in GB.

Value range:

N/A

used_storage_space

Integer

Parameter description:

Used message storage space, in GB.

Value range:

N/A

enable_publicip

Boolean

Parameter description:

Whether to enable public access.

Value range:

• true: yes

• false: no

publicip_id

String

Parameter description:

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).

Value range:

N/A

publicip_address

String

Parameter description:

Public IP address.

Value range:

N/A

ssl_enable

Boolean

Parameter description:

Whether SSL is enabled.

Value range:

• true: yes

• false: no

cross_vpc_info

String

Parameter description:

Cross-VPC access information.

Value range:

N/A

storage_resource_id

String

Parameter description:

Storage resource ID.

Value range:

N/A

storage_spec_code

String

Parameter description:

Storage specification code.

Value range:

N/A

service_type

String

Parameter description:

Service type.

Value range:

N/A

storage_type

String

Parameter description:

Storage type.

Value range:

N/A

extend_times

Long

Parameter description:

Extension time.

Value range:

N/A

ipv6_enable

Boolean

Parameter description:

Whether IPv6 is enabled.

Value range:

• true: yes

• false: no

support_features

String

Parameter description:

Features supported by the instance.

Value range:

N/A

disk_encrypted

Boolean

Parameter description:

Whether disk encryption is enabled.

Value range:

• true: yes

• false: no

ces_version

String

Parameter description:

Cloud Eye version.

Value range:

N/A

node_num

Integer

Parameter description:

Number of nodes.

Value range:

N/A

new_spec_billing_enable

Boolean

Parameter description:

Whether billing based on new specifications is enabled.

Value range:

• true: yes

• false: no

enable_acl

Boolean

Parameter description:

Whether access control is enabled.

Value range:

• true: yes

• false: no

broker_num

Integer

Parameter description:

Number of brokers (displayed only for RocketMQ 4.8.0).

Value range:

N/A

dns_enable

Boolean

Parameter description:

Whether to enable domain name access to an instance.

Value range:

• true: yes

• false: no

namesrv_address

String

Parameter description:

Metadata address.

Value range:

N/A

namesrv_domain_name

String

Parameter description:

Metadata domain name.

Value range:

N/A

broker_address

String

Parameter description:

Service data address.

Value range:

N/A

public_namesrv_address

String

Parameter description:

Public network metadata address.

Value range:

N/A

public_namesrv_domain_name

String

Parameter description:

Public metadata domain name.

Value range:

N/A

public_broker_address

String

Parameter description:

Public network service data address.

Value range:

N/A

grpc_address

String

Parameter description:

gRPC connection address (displayed only for RocketMQ 5.x).

Value range:

N/A

grpc_domain_name

String

Parameter description:

gRPC connection domain name (displayed only for RocketMQ 5.x).

Value range:

N/A

public_grpc_address

String

Parameter description:

Public gRPC connection address (displayed only for RocketMQ 5.x).

Value range:

N/A

public_grpc_domain_name

String

Parameter description:

Public gRPC domain name (displayed only for RocketMQ 5.x).

Value range:

N/A

enterprise_project_id

String

Parameter description:

Enterprise project ID.

Value range:

N/A

tags

Array of TagEntity objects

Parameter description:

Tag list.

Value range:

N/A

total_storage_space

Integer

Parameter description:

Total storage space.

Value range:

N/A

resource_spec_code

String

Parameter description:

Resource flavor.

Value range:

N/A

produce_portion

Integer

Parameter description:

Production TPS proportion.

Value range:

N/A

consume_portion

Integer

Parameter description:

Consumption TPS proportion.

Value range:

N/A

dr_enable

Boolean

Parameter description:

Whether DR is enabled.

Value range:

N/A

config_ssl_need_restart_process

Boolean

Parameter description:

Whether a restart is required to configure SSL.

Value range:

N/A

tls_mode

String

Parameter description:

Security protocol used by the instance.

Value range:

N/A

key

String

Definition:

Tag key.

Constraints:

• Cannot be left blank.

• 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.

Range:

N/A

Default Value:

N/A

value

String

Definition:

Tag value.

Constraints:

• Can contain 0 to 255 characters.

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

• Cannot start or end with a space.

Range:

N/A

Default Value:

N/A

200

Instance list queried successfully.