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}
Parameter |
Mandatory |
Description |
---|---|---|
project_id |
Yes |
Specifies the project ID. For details about how to obtain the ID, see Obtaining a Project ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
limit |
No |
Integer |
Specifies the upper limit on the number of returned server groups. The maximum value is 1,000. |
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
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:
|
Example Request
Query ECS groups.
GET https://{endpoint}/v1/{project_id}/cloudservers/os-server-groups
Example Response
{ "server_groups": [ { "members": [], "metadata": {}, "id": "318b44a7-f7a6-4c0b-8107-e8bd618b28dd", "policies": [ "anti-affinity" ], "name": "SvrGrp-b9d6" }, { "members": [], "metadata": {}, "id": "b8f4cfc4-9a59-498c-9b52-643ee6515cd0", "policies": [ "anti-affinity" ], "name": "SvrGrp-10a1" } ] }
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.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot