Querying Server Groups

Function

This API is used to query server groups.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v5/{project_id}/host-management/groups

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Definition Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID. To query assets in all enterprise projects, set this parameter to all_granted_eps. Constraints You need to set this parameter only after the enterprise project function is enabled. Range The value can contain 1 to 256 characters. Default Value 0: default enterprise project.
offset	No	Integer	Definition Offset, which specifies the start position of the record to be returned. Constraints N/A Range The value range is 0 to 2,000,000. Default Value The default value is 0.
limit	No	Integer	Definition Number of records displayed on each page. Constraints N/A Range Value range: 10-200 Default Value 10
group_name	No	String	Definition Server group name. Constraints N/A Range The value can contain 1 to 64 characters. Default Value N/A

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A
region	No	String	Definition Region ID, which is used to query assets in the required region. For details about how to obtain a region ID, see Obtaining a Region ID. Constraints N/A Range The value can contain 1 to 128 characters. Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_num	Integer	Definition Total number. Range The value range is 0 to 2,147,483,647.
data_list	Array of HostGroupItem objects	Definition Server group list. Range N/A

**Table 5** HostGroupItem
Parameter	Type	Description
group_id	String	Definition Unique ID of the server group that the server belongs to. Range The value can contain 0 to 64 characters.
group_name	String	Definition Server group name. Range The value can contain 0 to 256 characters.
host_num	Integer	Definition Number of affected servers. Range The value range is 0 to 2,147,483,647.
risk_host_num	Integer	Definition Unsafe servers. Range 0 to 2,147,483,647
unprotect_host_num	Integer	Definition Number of unprotected servers. Range 0 to 2,147,483,647
host_id_list	Array of strings	Definition Server ID list. Range N/A
is_outside	Boolean	Definition Whether a server group is an on-premises data center server group. Range true or false

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

Request succeeded.

{
  "data_list" : [ {
    "group_name" : 21,
    "group_id" : "fcf8097f-2b6e-3eab-89cb-62d125ad6417",
    "host_num" : 0,
    "risk_host_num" : 0,
    "unprotect_host_num" : 0,
    "host_id_list" : [ {
      "items" : "xxx"
    } ]
  } ],
  "total_num" : 1
}