DescribeCycleTaskList - Security Center - Alibaba Cloud Documentation Center

Queries periodic scan tasks. The tasks include image scan tasks, urgent vulnerability scan tasks, and virus scan tasks.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-sas:DescribeCycleTaskList	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
TaskName	string	No	The name of the task. Valid values: VIRUS_VUL_SCHEDULE_SCAN: virus scan task IMAGE_SCAN: image scan task EMG_VUL_SCHEDULE_SCAN: urgent vulnerability scan task	IMAGE_SCAN
TaskType	string	Yes	The type of the task. Valid values: VIRUS_VUL_SCHEDULE_SCAN: virus scan task IMAGE_SCAN: image scan task EMG_VUL_SCHEDULE_SCAN: urgent vulnerability scan task	IMAGE_SCAN
CurrentPage	integer	No	The number of the page to return.	1
PageSize	integer	No	The number of entries to return on each page.	20

Response parameters

Parameter	Type	Description	Example
	object	The data returned.
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	A4EB8B1C-1DEC-5E18-BCD0-D1BBB393****
PageInfo	object	The pagination information.
CurrentPage	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page.	20
TotalCount	integer	The total number of entries returned.	149
Count	integer	The number of entries returned on the current page.	9
CycleScheduleResponseList	array<object>	An array that consists of periodic scan tasks.
CycleScheduleResponse	object	The information about the periodic scan task.
LastTaskId	string	The ID of the last task.	38730bb078f4a1461d4ed283994c****
ConfigId	string	The configuration ID.	2cdbdeba8dd70586d5814d4cbf21****
TargetEndTime	integer	The end time of the task. The time must be a time frame.	7
NextStartTimeStr	long	The time when the next task starts. The value is a UNIX timestamp. Unit: milliseconds.	1671184531000
TaskName	string	The name of the task.	IMAGE_SCAN
TaskType	string	The type of the task.	IMAGE_SCAN
IntervalPeriod	integer	The interval between which two consecutive tasks are run.	3
FirstDateStr	long	The time when the task first started.	1667491200000
Param	string	The extended information.	{"userAgreement":"yes","lang":"zh"}
PeriodUnit	string	The unit of the scan interval. Valid values: day hour	day
TargetStartTime	integer	The start time of the task. The start time must be a time frame.	0
Enable	integer	Indicates whether the configuration for the task interval was enabled. Valid values: 1: enabled. 0: disabled.	1

Examples

Sample success responses

JSONformat

{
  "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
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
403	NoPermission	caller has no permission	You are not authorized to do this operation.
500	ServerError	ServerError	-

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history