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}
|
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.
|
Parameter |
Type |
Description |
|---|---|---|
|
server_group |
Object |
Specifies the ECS group information. For details, see Table 3. |
|
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
Query details about a 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
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.