创建任务 - CreateTask
功能介绍
创建任务
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
POST /v5/{project_id}/common/task
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID，用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0，表示默认企业项目（default）。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
task_type |
是 |
String |
任务类型，包含如下
|
|
cluster_scan_info |
否 |
cluster_scan_info object |
创建集群扫描任务的参数，任务类型为“cluster_scan”时必传 |
|
iac_scan_info |
否 |
iac_scan_info object |
创建IAC安全扫描任务的参数，任务类型为“iac_scan”时必传 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
scan_type_list |
是 |
Array of strings |
参数解释: 扫描项类型列表 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
range_type |
是 |
String |
扫描范围类型，包含如下
|
|
cluster_id_list |
否 |
Array of strings |
需要扫描的集群id列表，扫描范围类型为“specific_cluster”时必传 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
task_id |
String |
本次创建任务的id |
请求示例
创建集群扫描任务，扫描project_id为2b31ed520xxxxxxebedb6e57xxxxxxxx的所有集群的集群漏洞
POST https://{endpoint}/v5/2b31ed520xxxxxxebedb6e57xxxxxxxx/common/task?enterprise_project_id=all_granted_eps
{
"task_type" : "cluster_scan",
"cluster_scan_info" : {
"scan_type_list" : [ "cluster_vul" ],
"range_type" : "all_cluster"
}
}
响应示例
状态码：200
请求已成功
{
"task_id" : "d8xxxx05-8xx5-4xx0-9xx6-c3dbxxxxxxac"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。
