Updated on 2024-07-23 GMT+08:00

Querying ECSs

Function

This API is used to query ECSs.

URI

GET /v2.1/{project_id}/servers?changes-since={changes-since}&image={image}&flavor={flavor}&name={name}&status={status}&limit={limit}&marker={marker}&not-tags={not-tags}&reservation_id={reservation_id}&ip={ip}

Table 1 describes the parameters in the URI.
Table 1 Path parameters

Parameter

Mandatory

Description

project_id

Yes

Specifies the project ID.

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

Table 2 Query parameters

Parameter

Mandatory

Type

Description

changes-since

No

String

Specifies the timestamp of the last ECS status update, which is used to filter out the ECSs with statuses updated later than the timestamp. The value is in the format of "CCYY-MM-DDThh:mm:ss+/-hh:mm" in UTC+0 and complies with ISO 8601, for example, 2018-01-17T03:03:32Z.

image

No

String

Specifies the image ID.

When image is used as a filter criterion, other filter criteria and paging criteria are not supported. If both the image and other filter criteria are specified, the image filter criterion is used. If the query criteria do not contain the image filter criterion, API functions are not restricted.

flavor

No

String

Specifies the ECS type ID, which is fuzzy-matched.

name

No

String

Specifies the ECS name, which is fuzzy-matched.

status

No

String

Specifies the ECS status.

Options:

ACTIVE, BUILD, ERROR, HARD_REBOOT, MIGRATING, REBOOT, REBUILD, RESIZE, REVERT_RESIZE, SHUTOFF, and VERIFY_RESIZE

In microversion 2.37, the system will return an empty list for the status field out of the preceding options. In microversion 2.38 and later, the system will return error 400.

For details, see ECS Statuses.

limit

No

Integer

Specifies the upper limit on the number of returned results.

The default value on each page is 25, and the information of a maximum of 1,000 ECSs is displayed on each page.

marker

No

String

Specifies the ECS ID to which the marker points. The query will start from its next ID.

tags

No

String

Queries ECSs with tags containing the specified value.

not-tags

No

String

Queries ECSs with tags not containing the specified value.

reservation_id

No

String

Specifies the ID returned when ECSs are created in a batch. This parameter is used to query ECSs created in a batch.

sort_key

No

String

Sorts query results by ECS attribute. The default sorting order is the reverse order of created_at.

Options: created_at, availability_zone, display_name, host, instance_type_id, key_name, project_id, user_id, updated_at, uuid, and vm_state

ip

No

String

Indicates the filtering result for IPv4 addresses, which are fuzzy-matched.

Request

None

Response

Table 3 describes the response parameters.

Table 3 Response parameters

Parameter

Type

Description

servers

Array of objects

Specifies the ECSs to be queried. For details, see Table 4.

servers_links

Array of objects

Specifies the link of the next page in pagination query. For details, see Table 5.

Table 4 servers field description

Parameter

Type

Description

name

String

Specifies the ECS name.

id

String

Specifies an ECS uniquely.

links

Array of objects

Specifies ECS shortcut links. For details, see Table 5.

Table 5 servers_links and links field description

Parameter

Type

Description

rel

String

Specifies the shortcut link marker name.

href

String

Specifies the shortcut link.

Example Request

Query a list of ECSs.

GET https://{endpoint}/v2.1/{project_id}/servers

Example Response

{
    "servers": [
        {
            "id": "616fb98f-46ca-475e-917e-2563e5a8cd19", 
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/servers/616fb98f-46ca-475e-917e-2563e5a8cd19", 
                    "rel": "self"
                }, 
                {
                    "href": "http://openstack.example.com/openstack/servers/616fb98f-46ca-475e-917e-2563e5a8cd19", 
                    "rel": "bookmark"
                }
            ], 
            "name": "new-server-test"
        }
    ]
}