Help Center/ Elastic Cloud Server/ API Reference/ APIs (Recommended)/ ECS Group Management/ Querying Details About an ECS Group
Updated on 2026-03-18 GMT+08:00
View PDF

Querying Details About an ECS Group

Function

This API is used to query details about 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

Definition

Specifies the project ID.

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

Constraints

N/A

Range

N/A

Default Value

N/A

server_group_id

Yes

Definition

Specifies an ECS group UUID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request

None

Response

Table 2 describes the response parameters.

Table 2 Response parameters

Parameter

Type

Description

server_group

Object

Definition

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

Range

N/A
Table 3 server_group parameters

Parameter

Type

Description

id

String

Definition

Specifies an ECS group UUID.

Range

N/A

name

String

Definition

Specifies the ECS group name.

Range

N/A

policies

Array of strings

Definition

Specifies the policies associated with the ECS group.

Range

N/A

members

Array of strings

Definition

Specifies the ECS contained in an ECS group.

Range

N/A

metadata

Object

Definition

Specifies the ECS group metadata.

Range

N/A

Example Request

Query details about the specified ECS group.

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 Codes.

Parent topic: ECS Group Management