Querying Details About an ECS Group¶
Function¶
This API is used to query details about an ECS group.
URI¶
GET /v2.1/{project_id}/os-server-groups/{server_group_id}
GET /v2/{project_id}/os-server-groups/{server_group_id}
Table 1 describes the parameters in the URI.
Parameter | Mandatory | Description |
---|---|---|
project_id | Yes | Specifies the project ID. |
server_group_id | Yes | Specifies the ECS group UUID. |
Request¶
None
Response¶
Table 2 describes the response parameters.
Parameter | Type | Description |
---|---|---|
server_group | Object | Specifies the ECS group information. For details, see Table 3. |
Parameter | Type | Description |
---|---|---|
id | String | Specifies the 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 ECSs contained in the 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. |
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 details about an ECS group.
GET https://{endpoint}/v2/9c53a566cb3443ab910cf0daebca90c4/os-server-groups/5bbcc3c4-1da2-4437-a48a-66f15b1b13f9
GET https://{endpoint}/v2.1/9c53a566cb3443ab910cf0daebca90c4/os-server-groups/5bbcc3c4-1da2-4437-a48a-66f15b1b13f9
Example Response¶
{
"server_group": {
"id": "5bbcc3c4-1da2-4437-a48a-66f15b1b13f9",
"name": "test",
"policies": ["anti-affinity"],
"members": [],
"metadata": {},
"project_id": "9c53a566cb3443ab910cf0daebca90c4"
}
}