获取主机资产
功能介绍
获取租户的主机资产列表
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v3/{project_id}/hostscan/hosts
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
用户的project_id 最小长度：32 最大长度：32 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
group_id |
否 |
String |
主机组id 最小长度：1 最大长度：64 |
|
offset |
否 |
Integer |
分页查询，偏移量，表示从此偏移量开始查询 最小值：0 最大值：10000 缺省值：0 |
|
limit |
否 |
Integer |
分页查询，每页显示的条目数量 最小值：1 最大值：100 缺省值：5 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：1 最大长度：102400 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
items |
Array of HGHost objects |
主机列表 数组长度：0 - 100 |
|
total |
Integer |
主机总数 最小值：0 最大值：100 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
auth_status |
Integer |
主机授权状态:
枚举值：
|
|
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 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 最大值：5 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 最小长度：0 最大长度：50 |
|
error_msg |
String |
错误描述 最小长度：0 最大长度：256 |
状态码： 401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 最小长度：0 最大长度：50 |
|
error_msg |
String |
错误描述 最小长度：0 最大长度：256 |
状态码： 418
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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" : "<font color=\\\"green\\\">扫描成功, 快去修复已发现的漏洞吧</font>",
"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 |
错误码
请参见错误码。
