Updated on 2023-07-17 GMT+08:00

Querying ECS Groups

Function

This API is used to query ECS groups.

URI

GET /v1/{project_id}/cloudservers/os-server-groups?limit={limit}&marker={marker}

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

limit

No

Integer

Specifies the upper limit on the number of returned server groups. The maximum value is 1000.

marker

No

String

Specifies the marker that points to the ECS group. The query starts from the next piece of data indexed by this parameter.

Parameters marker and limit must be used together.

Request

None

Response

Table 3 describes the response parameters.
Table 3 Response parameters

Parameter

Type

Description

server_groups

Array of objects

Specifies ECS groups. For details, see Table 4.

page_info

Object

If the pagination function is enabled, the UUID of the last ECS group on the current page is returned. For details, see Table 5.

Table 4 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.
Table 5 page_info field description

Parameter

Type

Description

next_marker

String

Specifies an ECS group UUID.

Example Request

Query ECS groups.

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

Example Response

{
   "server_groups": [
      {
         "members": [],
         "metadata": {},
         "id": "318b44a7-f7a6-4c0b-8107-e8bd618b28dd",
         "policies": [
                     "anti-affinity"
                     ],
         "name": "SvrGrp-b9d6"
  },
  {
         "members": [],
         "metadata": {},
         "id": "b8f4cfc4-9a59-498c-9b52-643ee6515cd0",
         "policies": [
                     "anti-affinity"
                     ],
         "name": "SvrGrp-10a1"
  }
 ]
}

Error Codes

See Error Codes.