Help Center> Elastic Cloud Server> API Reference> APIs (Recommended)> ECS Group Management> Querying ECS Groups
View PDF

Querying ECS Groups

Function

This API is used to query ECS groups.

URI

GET /v1/{project_id}/cloudservers/os-server-groups

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.

Request

None

Response

Table 2 describes the response parameters.

Table 2 Response parameters

Parameter

Type

Description

server_groups

Array of objects

Specifies ECS groups.
Table 3 server_groups parameter information

Parameter

Type

Description

id

String

Specifies the ECS group UUID.

name

String

Specifies the ECS group name.

members

Array of strings

Specifies the ECSs contained in an ECS group.

metadata

Object

Specifies the ECS group metadata.

policies

Array of strings
Specifies the policies associated with the ECS group. Options:
  • anti-affinity: ECSs in this group must be deployed on different hosts.
  • affinity: ECSs in this group must be deployed on the same host.
  • soft-anti-affinity: ECSs in this group are deployed on different hosts if possible. If the ECSs cannot be deployed on different hosts, deploy them based on the actual condition for successful ECS creation.
  • soft-affinity: ECSs in this group are deployed on the same host if possible. If the ECSs cannot be deployed on the same host, deploy them based on the actual condition for successful ECS creation.
NOTE:

Only anti-affinity policies are supported. You are not advised to use other policies. If other policies are used, creating the ECS group will fail.

Example Request

GET https://{endpoint}/v1/{project_id}/cloudservers/os-server-groups

Example Response

{
    "server_groups": [
        {
            "id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
            "name": "test",
            "policies": ["anti-affinity"],
            "members": [],
            "metadata": {}
        }
    ]
}

Returned Values

See Returned Values for General Requests.

Error Codes

See Error Code Description.

Parent topic: ECS Group Management