Querying Server Groups
Function
This API is used to query server groups.
URI
GET /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. |
| offset | No | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. |
| limit | No | Integer | Number of records displayed on each page. |
| group_name | No | String | Server group name |
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. |
| region | Yes | String | Region ID |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| total_num | Integer | Total number |
| data_list | Array of HostGroupItem objects | Server group list |
| Parameter | Type | Description |
|---|---|---|
| group_id | String | Server group ID |
| group_name | String | Server group name |
| host_num | Integer | Number of associated servers |
| risk_host_num | Integer | Number of unsafe servers |
| unprotect_host_num | Integer | Number of unprotected servers |
| host_id_list | Array of strings | Server ID list |
Example Requests
Query the server group whose name is test.
GET https://{endpoint}/v5/{project_id}/host-management/groups?offset=0&limit=200&enterprise_project_id=all_granted_eps&&group_name=test Example Responses
Status code: 200
Server group list
{
"data_list" : [ {
"group_id" : "36e59701-e2e7-4d56-b229-0db3bcf4e6e8",
"group_name" : "test",
"host_id_list" : [ "71a15ecc-049f-4cca-bd28-5e90aca1817f" ],
"host_num" : 1,
"risk_host_num" : 1,
"unprotect_host_num" : 0
} ],
"total_num" : 1
} Status Codes
| Status Code | Description |
|---|---|
| 200 | Server group list |
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.
