Creating an ECS Group
Function
This API is used to create an ECS group.
Constraints
Only anti-affinity policies are supported.
URI
POST /v1/{project_id}/cloudservers/os-server-groups
Parameter |
Mandatory |
Description |
---|---|---|
project_id |
Yes |
Specifies the project ID. For details about how to obtain the ID, see Obtaining a Project ID. |
Request
Table 2 describes the request parameters.
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
server_group |
Yes |
Object |
Specifies the ECS group information. For details, see Table 3. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
String |
Specifies the ECS group name. The value contains 1 to 255 characters. |
policies |
Yes |
Array of strings |
Specifies the policies associated with the ECS group. Options:
|
Response
Table 4 describes the response parameters.
Parameter |
Type |
Description |
---|---|---|
server_group |
Object |
Specifies the ECS group information. For details, see Table 5. |
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. Options:
|
members |
Array of strings |
Specifies the IDs of the ECSs in an ECS group. |
metadata |
Object |
Specifies the ECS group metadata. |
Example Request
Create an ECS group.
POST https://{endpoint}/v1/{project_id}/cloudservers/os-server-groups { "server_group": { "name": "test", "policies": ["anti-affinity"] } }
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.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot