文档首页/ 漏洞管理服务 CodeArts Inspector/ API参考/ API/ 主机组管理/ 获取主机组列表
更新时间：2024-10-14 GMT+08:00
查看PDF
分享

获取主机组列表

功能介绍

获取主机组列表

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v3/{project_id}/hostscan/groups

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

project_id

最小长度：32

最大长度：32
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

分页查询，偏移量，表示从此偏移量开始查询

最小值：0

最大值：200

缺省值：0

limit

否

Integer

分页查询，每页显示的条目数量

最小值：1

最大值：100

缺省值：5

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

X-Auth-Token

最小长度：1

最大长度：102400

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

total

Integer

群组总数

最小值：0

最大值：1000

items

Array of Group objects

群组列表

数组长度：0 - 1000
表5 Group

参数

参数类型

描述

id

String

群组ID

最小长度：1

最大长度：64

name

String

群组名称

最小长度：1

最大长度：24

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：0

最大长度：50

error_msg

String

错误描述

最小长度：0

最大长度：256

状态码： 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：0

最大长度：50

error_msg

String

错误描述

最小长度：0

最大长度：256

状态码： 418

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：0

最大长度：50

error_msg

String

错误描述

最小长度：0

最大长度：256

请求示例

无

响应示例

状态码： 200

OK

{
  "total" : 1,
  "items" : [ {
    "name" : "myGroup1",
    "id" : "9a1cd36501a94a739db18a53ba07e35a"
  } ]
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

418

I'm a teapot

错误码

请参见错误码。

父主题： 主机组管理

相关文档