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.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
total	Integer	Total number.
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.
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	The enterprise project ID must be used together with the enterprise project switch. This parameter is mandatory when the enterprise project 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. If the instance type of the security group ID selected by the user is ROMA, this field has a value.
publicip_enable	Boolean	Whether to enable the public network entry.
publicip_id	String	Compatibility field, which is the ID of the public IP address selected by the user. This field has a value when the public network entry is enabled and the instance type is ROMA.
publicip_address	String	IPv4 address of the public network entry. This field has a value when the public network entry is enabled.
connect_address	String	IPv4 address of the private network entry.
flavor_id	String	Compatibility field, instance specification ID. This field has a value when the instance type is ROMA.
flavor_type	String	Compatibility field, instance specification ID. This field has a value 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. This field has a value when the instance type is ROMA.
maintain_end	String	Compatibility field, end time of the maintenance time window. This field has a value when the instance type is ROMA.
site_id	String	Site ID. This field has a value when the instance type is site.
create_time	String	UTC time of the creation.
update_time	String	UTC time of the update.
rcu	rcu object	This parameter has a value when the instance type is RCU.
bandwidths	Integer	Compatibility field, public network egress bandwidth of the instance. The unit is Mbit/s. This parameter is valid when the instance type is ROMA.
ingress_bandwidth_size	Integer	Public network inbound bandwidth of the instance when the instance type is RCU. 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, MQS of the RocketMQ engine.
order_id	String	Compatibility field, ID of a yearly/monthly order. This field is valid only when the instance type is ROMA.
error_code	String	Error code information when the instance status is abnormal.
error_msg	String	Error information when the instance status 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

Previous topic: Creating a Pro Instance

Next topic: Tag Management

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot