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

Querying Details About an ECS Group

Function

This API is used to query details bout an ECS group.

URI

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

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.

server_group_id

Yes

Specifies an ECS group UUID.

Request

None

Response

Table 2 describes the response parameters.

Table 2 Response parameters

Parameter

Type

Description

server_group

Object

Specifies an ECS group.
Table 3 server_group parameters

Parameter

Type

Description

id

String

Specifies an ECS group UUID.

name

String

Specifies the ECS group name.

policies

Array of strings

Specifies the policies associated with the ECS group.

members

Array of strings

Specifies the ECS contained in an ECS group.

metadata

Object

Specifies the ECS group metadata.

Example Request

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

Example Response

{
    "server_group": {
        "id": "5bbcc3c4-1da2-4437-a48a-66f15b1b13f9",
        "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