首页 云安全中心 开发参考 API参考指南 API目录 任务管理 DescribeCycleTaskList - 查询通用计划任务列表

DescribeCycleTaskList - 查询通用计划任务列表

更新时间: 2024-02-20 13:57:33

查询通用计划任务的列表,包括镜像扫描、应急漏洞扫描及病毒扫描。

调试

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

授权信息

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

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

请求参数

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

任务名称。取值:

  • VIRUS_VUL_SCHEDULE_SCAN:病毒扫描。
  • IMAGE_SCAN:镜像扫描。
  • EMG_VUL_SCHEDULE_SCAN:应急漏洞扫描。
IMAGE_SCAN
TaskTypestring

任务类型。取值:

  • VIRUS_VUL_SCHEDULE_SCAN:病毒扫描。
  • IMAGE_SCAN:镜像扫描。
  • EMG_VUL_SCHEDULE_SCAN:应急漏洞扫描。
IMAGE_SCAN
CurrentPageinteger

分页查询时,当前页的页码。

1
PageSizeinteger

分页查询时,显示的每页数据的最大条数,默认值 20。

20

返回参数

名称类型描述示例值
object

请求返回数据。

RequestIdstring

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

A4EB8B1C-1DEC-5E18-BCD0-D1BBB393****
PageInfoobject

分页信息。

CurrentPageinteger

分页查询时,当前页的页码。

1
PageSizeinteger

分页查询时,每页最多显示的数据条数。

20
TotalCountinteger

总条数。

149
Countinteger

分页查询时,当前页显示数据条数。

9
CycleScheduleResponseListobject []

周期性扫描任务列表。

LastTaskIdstring

最后一次任务 id。

38730bb078f4a1461d4ed283994c****
ConfigIdstring

配置对应的 ID。

2cdbdeba8dd70586d5814d4cbf21****
TargetEndTimeinteger

任务结束时间(小时)。

7
NextStartTimeStrlong

下一次执行的时间。格式为毫秒级时间戳。

1671184531000
TaskNamestring

任务名称。

IMAGE_SCAN
TaskTypestring

任务类型。

IMAGE_SCAN
IntervalPeriodinteger

间隔周期。

3
FirstDateStrlong

首次执行时间。

1667491200000
Paramstring

扩展信息字段。

{"userAgreement":"yes","lang":"zh"}
PeriodUnitstring

扫描周期的单位,取值:

  • day:天。
  • hour:小时。
day
TargetStartTimeinteger

任务开始时间(小时)。

0
Enableinteger

是否启用。取值:

  • 1:开启
  • 0:关闭
1

示例

正常返回示例

JSON格式

{
  "RequestId": "A4EB8B1C-1DEC-5E18-BCD0-D1BBB393****",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 149,
    "Count": 9
  },
  "CycleScheduleResponseList": [
    {
      "LastTaskId": "38730bb078f4a1461d4ed283994c****",
      "ConfigId": "2cdbdeba8dd70586d5814d4cbf21****",
      "TargetEndTime": 7,
      "NextStartTimeStr": 1671184531000,
      "TaskName": "IMAGE_SCAN",
      "TaskType": "IMAGE_SCAN",
      "IntervalPeriod": 3,
      "FirstDateStr": 1667491200000,
      "Param": "{\"userAgreement\":\"yes\",\"lang\":\"zh\"}",
      "PeriodUnit": "day",
      "TargetStartTime": 0,
      "Enable": 1
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
403NoPermissioncaller has no permission当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作。
500ServerErrorServerError服务故障,请稍后重试!

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

阿里云首页 云安全中心 相关技术圈