查询服务器组列表 - ListHostGroups
功能介绍
查询服务器组列表
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/host-management/groups
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID，用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0，表示默认企业项目（default）。 |
|
offset |
否 |
Integer |
参数解释: 偏移量：指定返回记录的开始位置 约束限制: 不涉及 取值范围: 最小值0，最大值2000000 默认取值: 默认为0 |
|
limit |
否 |
Integer |
参数解释: 每页显示个数 约束限制: 不涉及 取值范围: 取值10-200 默认取值: 10 |
|
group_name |
否 |
String |
参数解释: 服务器组名称 约束限制: 不涉及 取值范围: 字符长度1-64位 默认取值: 不涉及 |
请求参数
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_num |
Integer |
参数解释: 总数 取值范围: 最小值0，最大值2147483647 |
|
data_list |
Array of HostGroupItem objects |
参数解释: 服务器组列表 取值范围: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
group_id |
String |
参数解释: 服务器组ID 取值范围: 字符长度0-64位 |
|
group_name |
String |
参数解释: 服务器组名称 取值范围: 字符长度0-256位 |
|
host_num |
Integer |
参数解释: 影响主机数量 取值范围: 最小值0，最大值2147483647 |
|
risk_host_num |
Integer |
参数解释: 有风险服务器数 取值范围: 0到2147483647 |
|
unprotect_host_num |
Integer |
参数解释: 未防护服务器数 取值范围: 0到2147483647 |
|
host_id_list |
Array of strings |
参数解释: 服务器ID列表 取值范围: 不涉及 |
|
is_outside |
Boolean |
参数解释: 是否是线下数据中心服务器组 取值范围: true或者false |
请求示例
查询服务器组名称为test的服务器组。
GET https://{endpoint}/v5/{project_id}/host-management/groups?offset=0&limit=200&enterprise_project_id=all_granted_eps&&group_name=test
响应示例
状态码：200
请求已成功
{
"data_list" : [ {
"policy_id" : "34b4f91f-8480-4c17-a06e-cf5dac7c82dd",
"group_id" : "fcf8097f-2b6e-3eab-89cb-62d125ad6417",
"policy_name" : "资产发现",
"feature_name" : "assetmanage_collect",
"policy_category" : "Asset",
"policy_status" : "applied"
} ],
"total_num" : 1
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。
