九游平台/ 漏洞管理服务 codearts inspector/ api参考/ / / 获取主机资产
更新时间：2024-10-14 gmt 08:00

获取主机资产-九游平台

功能介绍

获取租户的主机资产列表

调试

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

uri

get /v3/{project_id}/hostscan/hosts

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

string

用户的project_id

最小长度：32

最大长度：32
表2 query参数

参数

是否必选

参数类型

描述

group_id

否

string

主机组id

最小长度：1

最大长度：64

offset

否

integer

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

最小值：0

最大值：10000

缺省值：0

limit

否

integer

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

最小值：1

最大值：100

缺省值：5

请求参数

表3 请求header参数

参数

是否必选

参数类型

描述

x-auth-token

是

string

用户token，通过调用iam服务获取用户token接口获取（响应消息头中x-subject-token的值）。

最小长度：1

最大长度：102400

响应参数

状态码： 200

表4 响应body参数

参数

参数类型

描述

items

array of hghost objects

主机列表

数组长度：0 - 100

total

integer

主机总数

最小值：0

最大值：100
表5 hghost

参数

参数类型

描述

auth_status

integer

主机授权状态:

  • -1 未知
  • 0 连接成功
  • 1 不可达
  • 2 登录失败

枚举值：

  • -1
  • 0
  • 1
  • 2

group_id

string

主机组id

最小长度：0

最大长度：64

id

string

主机id

最小长度：0

最大长度：64

ip

string

主机ip

最小长度：0

最大长度：15

jumper_server_id

string

跳板机id

最小长度：0

最大长度：64

last_scan_id

string

最后一次扫描的id

最小长度：0

最大长度：64

last_scan_info

scaninfodetail object

-

name

string

主机名

最小长度：0

最大长度：64

os_type

string

主机操作系统类型

最小长度：0

最大长度：50

smb_credential_id

string

smb_credential_id

最小长度：0

最大长度：64

ssh_credential_id

string

ssh授权id

最小长度：0

最大长度：64
表6 scaninfodetail

参数

参数类型

描述

create_time

long

扫描任务创建时间

最小值：0

最大值：9223372036854775807

enable_weak_passwd

boolean

弱密码检查

end_time

long

扫描任务结束时间

最小值：0

最大值：9223372036854775807

progress

integer

任务进度

最小值：0

最大值：100

reason

string

任务描述

最小长度：0

最大长度：10240

status

integer

扫描任务状态:

  • 0 运行中
  • 1 已完成
  • 2 手动取消
  • 3 等待中
  • 4 扫描失败
  • 5 等待定时调度

最小值：0

最大值：5

状态码： 400

表7 响应body参数

参数

参数类型

描述

error_code

string

错误码

最小长度：0

最大长度：50

error_msg

string

错误描述

最小长度：0

最大长度：256

状态码： 401

表8 响应body参数

参数

参数类型

描述

error_code

string

错误码

最小长度：0

最大长度：50

error_msg

string

错误描述

最小长度：0

最大长度：256

状态码： 418

表9 响应body参数

参数

参数类型

描述

error_code

string

错误码

最小长度：0

最大长度：50

error_msg

string

错误描述

最小长度：0

最大长度：256

请求示例

get https://{endpoint}/v3/{project_id}/hostscan/hosts

响应示例

状态码： 200

ok

{
  "total" : 1,
  "items" : [ {
    "auth_status" : 0,
    "group_id" : "c322c9acecb244cebf2c5449ba8a1930",
    "id" : "9a1cd36501a94a739db18a53ba07e35a",
    "ip" : "100.10.10.110",
    "jumper_server_id" : "b22f51d539994e76a325d388e51b9783",
    "last_scan_id" : "405958a48bc341b2bac4a4352d89e302",
    "last_scan_info" : {
      "create_time" : 1711333867428,
      "enable_weak_passwd" : false,
      "end_time" : 1711334075973,
      "progress" : 100,
      "reason" : "扫描成功, 快去修复已发现的漏洞吧",
      "status" : 1
    },
    "name" : "密钥test190",
    "os_type" : "linux",
    "smb_credential_id" : "",
    "ssh_credential_id" : "c8a7b0e4707749dfaaf8764ea827a764"
  } ]
}

状态码

状态码

描述

200

ok

400

bad request

401

unauthorized

418

i'm a teapot

错误码

请参见错误码。

父主题：

相关文档

网站地图