查询病毒查杀可选服务器列表 - ListAntiVirusHost
功能介绍
查询病毒查杀可选服务器列表
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/antivirus/host-management/hosts
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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 默认取值: 不涉及 |
|
limit |
是 |
Integer |
参数解释: 每页显示个数 约束限制: 不涉及 取值范围: 取值10-200 默认取值: 10 |
|
host_id |
否 |
String |
参数解释: 服务器ID 约束限制: 不涉及 取值范围: 字符长度1-64位 默认取值: 不涉及 |
|
host_name |
否 |
String |
参数解释: 服务器名称 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
private_ip |
否 |
String |
参数解释: 服务器私有IP 约束限制: 不涉及 取值范围: 字符长度1-128位 默认取值: 不涉及 |
|
public_ip |
否 |
String |
服务器公网IP |
|
group_id |
否 |
String |
参数解释: 服务器组ID 约束限制: 不涉及 取值范围: 字符长度1-64位 默认取值: 不涉及 |
|
scan_type |
是 |
String |
任务类型，包含如下:
|
|
start_type |
是 |
String |
启动类型，包含如下:
|
|
policy_id |
否 |
String |
策略ID |
|
next_start_time |
否 |
Long |
下次启动时间，毫秒 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_num |
Integer |
参数解释: 总数 取值范围: 最小值0，最大值2147483647 |
|
data_list |
Array of AntiVirusHostResponseInfo objects |
data list |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
host_id |
String |
参数解释： 主机ID 取值范围： 字符长度1-64位 |
|
host_name |
String |
参数解释: 服务器名称 取值范围: 字符长度1-256位 |
|
public_ip |
String |
参数解释： 弹性公网IP地址 取值范围： 字符长度1-256位 |
|
private_ip |
String |
参数解释： 服务器私有IP 取值范围： 字符长度1-128位 |
|
agent_id |
String |
参数解释: Agent ID 约束限制: 不涉及 取值范围: 字符长度1-64位 默认取值: 不涉及 |
|
os_type |
String |
操作系统类型，包含如下2种。
|
|
group_id |
String |
服务器组ID |
请求示例
无
响应示例
状态码：200
请求已成功
{
"total_num" : 36,
"data_list" : [ {
"host_name" : "cce-test-l***",
"host_id" : "990***33-04e7-4803-aeeb-2e5b6b***7df",
"agent_id" : "8c33b73f6c5161c994530cb4c85bc518e193e9241f768028c29ae12b2f47f693",
"private_ip" : "192.168.0.***,192.168.0.***",
"public_ip" : "100.95.146.47",
"os_type" : "Linux",
"group_id" : "d93***06-5282-3017-9077-e385ea***1af"
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。
