Creating a Server Group
Function
This API is used to create a server group.
URI
POST /v5/{project_id}/host-management/groups
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
Enterprise project ID. To query all enterprise projects, set this parameter to all_granted_eps. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
IAM token. It can be obtained by calling the IAM API used to obtain an IAM token. The value of X-Subject-Token in the response header is a token. |
Content-Type |
No |
String |
Default value: application/json; charset=utf-8 |
region |
Yes |
String |
Region ID |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
group_name |
Yes |
String |
Server group name |
host_id_list |
Yes |
Array of strings |
Server ID list |
Response Parameters
Status code: 200
success
None
Example Requests
Create a server group named test. The ID of the server in the server group is 15dac7fe-d81b-43bc-a4a7-4710fe673972.
POST https://{endpoint}/v5/{project_id}/host-management/groups { "group_name" : "test", "host_id_list" : [ "15dac7fe-d81b-43bc-a4a7-4710fe673972" ] }
Example Responses
None
Status Codes
Status Code |
Description |
---|---|
200 |
success |
400 |
Invalid parameter. |
401 |
Authentication failed. |
403 |
Insufficient permission. |
404 |
Resource not found. |
500 |
System error. |
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.