Querying ECS Groups

Function

This API is used to query ECS groups.

URI

GET /v2.1/{project_id}/os-server-groups

Table 1 describes the parameters in the URI.

Table 1 Parameter description

Parameter

Mandatory

Description

project_id

Yes

Specifies the project ID.

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

Parameters in the following table can be used as URI parameters to filter query results.

Usage: /v2/{project_id}/os-server-groups?

Request

None

Response

Table 2 describes the response parameters.

Table 2 Response parameters

Parameter

Type

Description

server_groups

Array of objects

Specifies the ECS group information. For details, see Table 3.

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 in an ECS group.

metadata

Object

Specifies the ECS group metadata.

project_id

String

Specifies the tenant ID in UUID format for the ECS group.

This parameter is supported in microversion 2.13 and later.

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.

user_id

String

Specifies the user ID in UUID format for the ECS group.

This parameter is supported in microversion 2.13 and later.

Example Request

Query a list of ECS groups.

GET https://{endpoint}/v2.1/9c53a566cb3443ab910cf0daebca90c4/os-server-groups

Example Response

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

Returned Values

See Returned Values for General Requests.