更新时间:2025-09-23 GMT+08:00

查询服务器组列表

功能介绍

查询服务器组列表

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户项目ID

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

企业项目ID,查询所有企业项目时填写:all_granted_eps

offset

Integer

偏移量:指定返回记录的开始位置,必须为数字,取值范围为大于或等于0,默认0

limit

Integer

每页显示个数

group_name

String

服务器组名称

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

x-auth-token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total_num

Integer

总数

data_list

Array of HostGroupItem objects

服务器组列表

表5 HostGroupItem

参数

参数类型

描述

group_id

String

服务器组ID

group_name

String

服务器组名称

host_num

Integer

关联服务器数

risk_host_num

Integer

有风险服务器数

unprotect_host_num

Integer

未防护服务器数

host_id_list

Array of strings

服务器ID列表

is_outside

Boolean

是否是线下数据中心服务器组

请求示例

查询服务器组名称为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" : [ {
    "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
}

状态码

状态码

描述

200

服务器组列表

错误码

请参见错误码