yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
719d8b18deddea0cfce1cc197a49d2a2b6db8c71
doc-exports/docs/dms_rocketmq/api-ref/ShowInstance.html
chenjunjie 719d8b18de RocketMQ API 20250723 version 
Reviewed-by: Ziuzko, Stanislav <stanislav.ziuzko@t-systems.com>
Co-authored-by: chenjunjie <chenjunjie@huawei.com>
Co-committed-by: chenjunjie <chenjunjie@huawei.com>
2026-03-18 20:25:09 +00:00

43 KiB
Raw Blame History

Querying an Instance

Function

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

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. For details about how to obtain it, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

instance_id

Yes

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

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

name

String

Definition

Instance name.

Constraints

N/A

Range

N/A

Default Value

N/A

engine

String

Definition

Message engine type.

Constraints

N/A

Range

  • rocketmq: RocketMQ message engine.

  • reliability: RocketMQ message engine alias.

Default Value

N/A

status

String

Definition

Message status.

Constraints

N/A

Range

For details, see Instance Status.

Default Value

N/A

description

String

Definition

Message description.

Constraints

N/A

Range

N/A

Default Value

N/A

type

String

Definition

Message description.

Constraints

N/A

Range

  • single.basic: 5.x single-node basic edition.

  • cluster.basic: 5.x cluster basic edition

Default Value

N/A

specification

String

Definition

Instance specification.

Constraints

N/A

Range

N/A

Default Value

N/A

engine_version

String

Definition

Instance version.

Constraints

N/A

Range

  • 5.x

Default Value

N/A

instance_id

String

Definition

Instance ID.

Constraints

N/A

Range

N/A

Default Value

N/A

charging_mode

Integer

Definition

Billing mode.

Constraints

N/A

Range

1 indicates pay-per-use.

Default Value

N/A

vpc_id

String

Definition

VPC ID.

Constraints

N/A

Range

N/A

Default Value

N/A

vpc_name

String

Definition

VPC name.

Constraints

N/A

Range

N/A

Default Value

N/A

created_at

String

Definition

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.

Constraints

N/A

Range

N/A

Default Value

N/A

product_id

String

Definition

RocketMQ instance flavors.

Constraints

N/A

Range

If type is single.basic, select single-node flavors. If type is cluster.basic, select cluster flavors.

  • rocketmq.b1.large.1: RocketMQ 5.x basic edition single-node flavor, instance TPS 500

  • rocketmq.b2.large.4: RocketMQ 5.x basic edition cluster flavor, instance TPS 2,000

  • rocketmq.b2.large.8: RocketMQ 5.x basic edition cluster flavor, instance TPS 4,000

  • rocketmq.b2.large.12: RocketMQ 5.x basic edition cluster flavor, instance TPS 6,000

Default Value

N/A

security_group_id

String

Definition

Security group ID.

Constraints

N/A

Range

N/A

Default Value

N/A

security_group_name

String

Definition

Security group name.

Constraints

N/A

Range

N/A

Default Value

N/A

subnet_id

String

Definition

Subnet ID.

Constraints

N/A

Range

N/A

Default Value

N/A

subnet_name

String

Definition

Subnet name.

Constraints

N/A

Range

N/A

Default Value

N/A

subnet_cidr

String

Definition

Subnet route.

Constraints

N/A

Range

N/A

Default Value

N/A

available_zones

Array of strings

Definition

List of AZ IDs.

Constraints

N/A

Range

N/A

Default Value

N/A

available_zone_names

Array of strings

Definition

List of AZ names.

Constraints

N/A

Range

N/A

Default Value

N/A

user_id

String

Definition

User ID.

Constraints

N/A

Range

N/A

Default Value

N/A

user_name

String

Definition

Username.

Constraints

N/A

Range

N/A

Default Value

N/A

maintain_begin

String

Definition

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

Constraints

N/A

Range

N/A

Default Value

N/A

maintain_end

String

Definition

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

Constraints

N/A

Range

N/A

Default Value

N/A

storage_space

Integer

Definition

Storage space, in GB.

Constraints

N/A

Range

Different instance specifications support different storage configurations.

  • RocketMQ 5.x single-node storage range: 100–30000

  • RocketMQ 5.x cluster storage range: 200–60000

Default Value

N/A

used_storage_space

Integer

Definition

Used message storage space, in GB.

Constraints

N/A

Range

Different instance specifications support different storage configurations.

  • RocketMQ 5.x single-node storage range: 100–30000

  • RocketMQ 5.x cluster storage range: 200–60000

Default Value

N/A

enable_publicip

Boolean

Definition

Whether to enable public access.

Constraints

N/A

Range

  • true: Yes

  • false: No

Default Value

N/A

publicip_id

String

Definition

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

Constraints

N/A

Range

  • true: Yes

  • false: No

Default Value

N/A

publicip_address

String

Definition

Public IP address.

Constraints

N/A

Range

N/A

Default Value

N/A

ssl_enable

Boolean

Definition

Whether SSL is enabled.

Constraints

N/A

Range

  • true: Yes

  • false: No

Default Value

N/A

cross_vpc_info

String

Definition

Cross-VPC access information.

Constraints

N/A

Range

  • true: Yes

  • false: No

Default Value

N/A

storage_resource_id

String

Definition

Storage resource ID.

Constraints

N/A

Range

N/A

Default Value

N/A

storage_spec_code

String

Definition

Storage specification code.

Constraints

N/A

Range

  • dms.physical.storage.high.v2: high I/O disk

  • dms.physical.storage.ultra.v2: ultra-high I/O disk

  • dms.physical.storage.general: general-purpose SSD

  • dms.physical.storage.extreme: extreme SSD

Default Value

N/A

service_type

String

Definition

Service type.

Constraints

N/A

Range

  • advanced: Service type.

Default Value

N/A

storage_type

String

Definition

Storage type.

Constraints

N/A

Range

  • hec: Storage type.

Default Value

N/A

ipv6_enable

Boolean

Definition

Whether IPv6 is enabled.

Constraints

N/A

Range

  • true: Yes

  • false: No

Default Value

N/A

disk_encrypted

Boolean

Definition

Whether disk encryption is enabled.

Constraints

N/A

Range

  • true: Yes

  • false: No

Default Value

N/A

enable_acl

Boolean

Definition

Whether to enable access control.

Constraints

N/A

Range

  • true: Yes

  • false: No

Default Value

N/A

broker_num

Integer

Definition

Number of brokers.

Constraints

N/A

Range

N/A

Default Value

N/A

dns_enable

Boolean

Definition

Whether to enable domain name access to an instance.

Constraints

N/A

Range

  • true: Yes

  • false: No

Default Value

N/A

namesrv_address

String

Definition

Metadata address.

Constraints

N/A

Range

N/A

Default Value

N/A

namesrv_domain_name

String

Definition

Metadata domain name.

Constraints

N/A

Range

N/A

Default Value

N/A

broker_address

String

Definition

Service data address.

Constraints

N/A

Range

N/A

Default Value

N/A

public_namesrv_address

String

Definition

Public network metadata address.

Constraints

N/A

Range

N/A

Default Value

N/A

public_namesrv_domain_name

String

Definition

Public metadata domain name.

Constraints

N/A

Range

N/A

Default Value

N/A

public_broker_address

String

Definition

Public network service data address.

Constraints

N/A

Range

N/A

Default Value

N/A

grpc_address

String

Definition

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

Constraints

N/A

Range

N/A

Default Value

N/A

grpc_domain_name

String

Definition

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

Constraints

N/A

Range

N/A

Default Value

N/A

public_grpc_address

String

Definition

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

Constraints

N/A

Range

N/A

Default Value

N/A

public_grpc_domain_name

String

Definition

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

Constraints

N/A

Range

N/A

Default Value

N/A

enterprise_project_id

String

Definition

Enterprise project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

tags

Array of TagEntity objects

Definition

Tag list.

Constraints

N/A

Range

N/A

Default Value

N/A

total_storage_space

Integer

Definition

Total storage space.

Constraints

N/A

Range

N/A

Default Value

N/A

resource_spec_code

String

Definition

Resource specification.

Constraints

N/A

Range

N/A

Default Value

N/A

produce_portion

Integer

Definition

Production TPS proportion.

Constraints

N/A

Range

N/A

Default Value

N/A

consume_portion

Integer

Definition

Consumption TPS proportion.

Constraints

N/A

Range

N/A

Default Value

N/A

dr_enable

Boolean

Definition

Whether the instance has disaster recovery (DR).

Constraints

N/A

Range

  • true: Yes

  • false: No

Default Value

N/A

config_ssl_need_restart_process

Boolean

Definition

Whether a restart is required to configure SSL.

Constraints

N/A

Range

  • true: Yes

  • false: No

Default Value

N/A

tls_mode

String

Definition

Security protocol used by an instance.

Constraints

N/A

Range

N/A

Default Value

N/A

arch_type

String

Definition

Architecture type.

Constraints

N/A

Range

  • X86

  • ARM

Default Value

N/A

auto_volume_expand_enable

Boolean

Definition

Whether to enable automatic disk capacity expansion.

Constraints

N/A

Range

  • true: Yes

  • false: No

Default Value

N/A
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.basic",
  "specification" : "rocketmq.b2.large.4, 2000 tps",
  "engine_version" : "5.x",
  "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" : "rocketmq.b2.large.4",
  "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.64.0/18",
  "available_zones" : [ "9f1c5806706d4c1fb0eb72f0a9b18c77" ],
  "available_zone_names" : [ "AZ3" ],
  "user_id" : "0b01fbb53600d4671fa8c00673c71260",
  "user_name" : "",
  "maintain_begin" : "02:00:00",
  "maintain_end" : "06:00:00",
  "dns_enable" : false,
  "storage_space" : 558,
  "total_storage_space" : 1200,
  "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",
  "disk_encrypted" : false,
  "enable_acl" : false,
  "dr_enable" : false,
  "config_ssl_need_restart_process" : false,
  "broker_num" : 1,
  "namesrv_address" : "***",
  "broker_address" : "***",
  "public_namesrv_address" : "***",
  "public_broker_address" : "***",
  "grpc_address" : "***",
  "public_grpc_address" : "***"
}

Status Codes

Status Code

Description

200

Instance queried successfully.

Error Codes

See Error Codes.

Parent topic: Lifecycle Management