Help Center/ ROMA Connect/ API Reference/ Public Resource APIs/ Pro Instance Management/ Listing All Instances
Updated on 2026-08-10 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Listing All Instances

Function

This API is used to obtain the instance list.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

GET /v3/{project_id}/roma/instances

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Tenant to which the instance belongs.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

category

No

String

Instance type.

status

No

String

Instance status.

  • CREATING

  • CREATE_FAILED

  • ERROR

  • RUNNING

  • FREEZING

  • FROZEN

  • DELETING

  • DELETE_FAILED

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

total

Integer

Total.

size

Integer

Number of items on this page.

instances

Array of instances objects

Instance array object.
Table 4 instances

Parameter

Type

Description

id

String

Instance ID.

name

String

Name.

description

String

Instance description.

status

String

Instance status.

  • CREATING

  • CREATE_FAILED

  • ERROR

  • RUNNING

  • FREEZING

  • FROZEN

  • DELETING

  • DELETE_FAILED

category

String

Instance type.

charge_type

String

Billing mode of the instance. The value can be: - prePaid: yearly/monthly. - postPaid: pay-per-use.

available_zone_ids

Array of strings

AZ list.

cpu_arch

String

Architecture type.

enterprise_project_id

String

Enterprise project ID. This parameter is mandatory when the enterprise project function is enabled.

vpc_id

String

VPC ID selected by the user.

subnet_id

String

Subnet network ID selected by the user.

security_group_id

String

(Compatibility field) ID of the security group selected by the user. Set this parameter when the instance type is ROMA.

publicip_enable

Boolean

Whether to enable public network access.

publicip_id

String

(Compatibility field) ID of the public IP address selected by the user. Set this parameter when the public network access is enabled and the instance type is ROMA.

publicip_address

String

IPv4 address of the public network ingress. Set this parameter when the public network access is enabled.

connect_address

String

IPv4 address of the private network ingress.

flavor_id

String

(Compatibility field) Instance specification ID. Set this parameter when the instance type is ROMA.

flavor_type

String

(Compatibility field) Instance specification ID. Set this parameter when the instance type is ROMA.

project_id

String

Project ID of a user.

maintain_begin

String

(Compatibility field) Start time of the maintenance time window. Set this parameter when the instance type is ROMA.

maintain_end

String

(Compatibility field) End time of the maintenance time window. Set this parameter when the instance type is ROMA.

site_id

String

Site ID. This field has a value for a site instance.

create_time

String

Creation time (UTC).

update_time

String

Update time (UTC).

rcu

rcu object

Set this parameter when the instance type is RCU.

bandwidths

Integer

(Compatibility field) Public network egress bandwidth of the instance. The unit is Mbit/s. Set this parameter when the instance type is ROMA.

ingress_bandwidth_size

Integer

Public network ingress bandwidth of the RCU instance. The unit is Mbit/s.

ipv6_enable

Boolean

(Huawei Cloud Stack dedicated field) IPv6 instance.

ipv6_connect_address

String

(Huawei Cloud Stack dedicated field) IPv6 instance entry address.

rocketmq_enable

Boolean

(Huawei Cloud Stack dedicated field) For MQS, the engine type is RocketMQ.

order_id

String

(Compatibility field) ID of a yearly/monthly order. Set this parameter when the instance type is ROMA.

error_code

String

Error code returned when the instance is abnormal.

error_msg

String

Error information returned when the instance is abnormal.

created_user

created_user object

Creator information.

last_updated_user

last_updated_user object

Last update user information.
Table 5 rcu

Parameter

Type

Description

total

Integer

Sum of RCUs.

distribution

Array of strings

RCU allocation.
Table 6 created_user

Parameter

Type

Description

user_id

String

Application creator ID.

user_name

String

Application creator name. The value can be empty.
Table 7 last_updated_user

Parameter

Type

Description

user_id

String

Last modification user ID.

user_name

String

Last modification user name. The value can be empty.

Status code: default

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Instance List

default

response for errors

Error Codes

See Error Codes.

Parent topic: Pro Instance Management