Obtaining the Instance List

This API is used to obtain the instance list. You can use multiple parameters for filtering and pagination.

For details, see Calling APIs.

GET /v1/{project_id}/instances

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
availability_zone	No	String	AZ.
charge_mode	No	String	Billing mode.
create_time	No	Long	Creation time.
deploy_mode	No	String	Deployment mode.
fail_reason	No	String	Failure cause.
id	No	String	Instance ID.
mode	No	String	Mode.
name	No	String	Instance name.
limit	No	Integer	Number of records on each page.
offset	No	Long	Offset.
page_number	No	Integer	Page number.
page_size	No	Integer	Page size.
paged	No	Boolean	Whether to enable pagination.
public_ip_id	No	String	EIP ID.
sort_sorted	No	Boolean	Whether to sort the data.
sort_unsorted	No	Boolean	Whether the data is not sorted.
specification	No	String	Specifications.
status	No	Integer	Status.
type	No	String	Type.
unpaged	No	Boolean	Whether pagination is not enabled.
version	No	String	Version.
virtual_ip	No	String	Virtual IP address.
vpc_id	No	String	VPC ID

None

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
count	Long	Total quantity.
items	Array of InstanceVo objects	Instance list.

**Table 4** InstanceVo
Parameter	Type	Description
availability_zone	String	AZ.
charge_mode	String	Billing mode.
create_time	Long	Creation time.
deploy_mode	String	Deployment mode.
fail_reason	String	Failure cause.
id	String	Instance ID.
mode	String	Mode.
name	String	Instance name.
public_ip	String	EIP.
publicip_id	String	EIP ID.
region	String	Region.
security_group_id	String	Security group ID.
specification	String	Specifications.
started_time	Long	Start time.
status	Integer	Status.
subnet_id	String	Subnet ID.
type	String	Type.
update_info	InstanceUpgradeInfo object	Instance upgrade information.
upgrade_process	Integer	Upgrade progress.
version	String	Version.
virtual_ip	String	Virtual IP address.
vpc_id	String	VPC ID

**Table 5** InstanceUpgradeInfo
Parameter	Type	Description
current_task_schedule_time	Long	Task scheduling time.
current_task_status	String	Task status.
estimated_time	Integer	Estimated completion time.
last_fail_reason	String	Last failure cause.
last_task_status	String	Last task status.
new_version	String	Upgraded to the latest version.