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.
Parameter | Mandatory | Description |
---|---|---|
project_id | Yes | Specifies the project ID. |
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.
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. |
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:
|
Parameter | Type | Description |
---|---|---|
next_marker | String | Specifies an ECS group UUID. |
Example Request¶
GET https://{endpoint}/v1/{project_id}/cloudservers/os-server-groups
Example Response¶
{
"server_groups": [
{
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"name": "test",
"policies": ["anti-affinity"],
"members": [],
"metadata": {}
}
],
"page_info": {
"next_marker": "616fb98f-46ca-475e-917e-2563e5a8cd19"
}
}
Returned Values¶
Error Codes¶
See Error Codes.