文档

GenerateOnceTask - 创建一次性执行任务

更新时间:

创建一次性扫描任务。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-aegis:GenerateOnceTasknone
  • 全部资源
    *

请求参数

名称类型必填描述示例值
TaskTypestring

任务类型。取值:

  • CLIENT_PROBLEM_CHECK:客户端问题诊断任务
  • CLIENT_DEV_OPS:云运维任务
  • ASSET_SECURITY_CHECK:资产采集任务
CLIENT_PROBLEM_CHECK
TaskNamestring

任务名称。取值:

  • CLIENT_PROBLEM_CHECK:客户端问题诊断任务
  • CLIENT_DEV_OPS:云运维任务
  • ASSET_SECURITY_CHECK:资产采集任务
CLIENT_PROBLEM_CHECK
Paramstring

扩展信息字段。

{"mode":1,"problemType":"offline","uuids":"inet-795dcad1-360f-49d2-b01e-b7da7f1c****"}
Sourcestring

增加任务的来源。

Manual

返回参数

名称类型描述示例值
object
RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

8BB6B8FA-39E8-5654-A309-8EED13B1****
CanCreateboolean

是否可以继续创建扫描任务。取值:

  • true:可以继续创建扫描任务。
  • false:无法继续创建扫描任务。
说明 默认支持同时存在 10 个扫描任务,超过 10 个扫描任务时,使用本接口创建扫描任务会失败。您需要等待已有的 10 个扫描任务中有扫描任务完成后,才可以继续创建新的扫描任务。
true
LastTaskstring

最后一次任务 id。

38730bb078f4a1461d4ed283994c****
CollectTimelong

采集时间。

1670307567000
TotalCountinteger

总任务数量。

100
TaskIdstring

检测任务 id。

38730bb078f4a1461d4ed283994c****
FinishCountinteger

完成数量。

61

示例

正常返回示例

JSON格式

{
  "RequestId": "8BB6B8FA-39E8-5654-A309-8EED13B1****",
  "CanCreate": true,
  "LastTask": "38730bb078f4a1461d4ed283994c****\n",
  "CollectTime": 1670307567000,
  "TotalCount": 100,
  "TaskId": "38730bb078f4a1461d4ed283994c****",
  "FinishCount": 61
}

错误码

HTTP status code错误码错误信息描述
400AssetsCollectionFrequencyLimitCollection task frequency limit.采集任务频率限制。
400IllegalParameterIllegal parameter, please check the param.参数错误,请检查输入参数。
400UnsupportedOperationThis operation is not supported.不支持该操作。
400TaskProcessingThe baseline repair task is in progress.基线修复任务执行中,请稍后操作。
403NoPermissioncaller has no permission当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作。
500ServerErrorServerError服务故障,请稍后重试!

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-07-02OpenAPI 错误码发生变更查看变更详情
2024-05-14OpenAPI 错误码发生变更查看变更详情
2024-04-08OpenAPI 错误码发生变更查看变更详情