创建全局资产扫描任务 - CreateGlobalAssetScanTask
功能介绍
创建全局资产扫描任务
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
POST /v5/{project_id}/asset/assign-task
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID，用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0，表示默认企业项目（default）。 |
|
category |
是 |
String |
参数解释: 资产类别 约束限制: 不涉及 取值范围:
默认取值: host |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
host_ids |
否 |
Array of strings |
参数解释: 下发任务的主机列表 约束限制: 不涉及 取值范围: 最小值0，最大值200 默认取值: 不涉及 |
|
server_group |
否 |
Array of strings |
参数解释: 下发任务的主机组列表 约束限制: 不涉及 取值范围: 最小值0，最大值200 默认取值: 不涉及 |
|
all_hosts |
否 |
Boolean |
参数解释: 下发全部主机的扫描 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error |
String |
参数解释 失败原因 取值范围 字符长度1-256 |
请求示例
创建资产全局扫描任务状态，查询project_id为2b31ed520xxxxxxebedb6e57xxxxxxxx的主机全局扫描任务状态
POST https://{endpoint}/v5/2b31ed520xxxxxxebedb6e57xxxxxxxx/asset/assign-task?enterprise_project_id=all_granted_eps&category=host
{
"all_hosts" : true
}
响应示例
状态码：200
请求已成功
{
"error" : "84b5266c14ae489fa6549827f032dc62-all_granted_eps processed 1 tasks successfully."
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。
