Call DescribeCycleTaskList to query periodic scan tasks - Security Center - Alibaba Cloud - Security Center

Queries the list of general-purpose scheduled nodes, including image scan, emergency vulnerability scanning, and virus scan nodes.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-sas:DescribeCycleTaskList

get

*CycleTask

acs:yundun-sas:{#regionId}:{#accountId}:cycletask/{#ConfigId}

None

Request parameters

Parameter	Type	Required	Description	Example
TaskName	string	No	The node name. Valid values: VIRUS_VUL_SCHEDULE_SCAN: virus scan. IMAGE_SCAN: image scan. EMG_VUL_SCHEDULE_SCAN: emergency vulnerability scanning.	IMAGE_SCAN
TaskType	string	No	The node type. Valid values: VIRUS_VUL_SCHEDULE_SCAN: virus scan. IMAGE_SCAN: image scan. EMG_VUL_SCHEDULE_SCAN: emergency vulnerability scanning.	IMAGE_SCAN
CurrentPage	integer	No	The page number of the current page when using paging.	1
PageSize	integer	No	The maximum number of entries per page when using paging. Default value: 20.	20
ConfigId	string	No	The ID of the configuration. Note Call the CreateCycleTask operation to obtain this parameter.	f93b6ee24cfd0aad44b897ad5051****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID, which is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.	A4EB8B1C-1DEC-5E18-BCD0-D1BBB393****
PageInfo	object	The pagination information.
CurrentPage	integer	The page number of the current page when using paging.	1
PageSize	integer	The maximum number of entries per page when using paging.	20
TotalCount	integer	The total number of entries.	149
Count	integer	The number of entries on the current page when using paging.	9
CycleScheduleResponseList	array<object>	The list of cyclic scan tasks.
	object	The list of cyclic scan tasks.
LastTaskId	string	The ID of the last task.	38730bb078f4a1461d4ed283994c****
ConfigId	string	The ID of the configuration.	2cdbdeba8dd70586d5814d4cbf21****
TargetEndTime	integer	The task end time, in hours.	7
NextStartTimeStr	integer	The next execution time. The value is a millisecond-level timestamp.	1671184531000
TaskName	string	The task name.	IMAGE_SCAN
TaskType	string	The task type.	IMAGE_SCAN
IntervalPeriod	integer	The interval period.	3
FirstDateStr	integer	The first execution time.	1667491200000
Param	string	The extended information field.	{"userAgreement":"yes","lang":"zh"}
PeriodUnit	string	The unit of the scan period. Valid values: day: day. hour: hour.	day
TargetStartTime	integer	The task start time, in hours.	0
Enable	integer	Indicates whether the task is enabled. Valid values: 1: enabled. 0: disabled.	1

Examples

Success response

JSON format

{
  "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
400	RdCheckNoPermission	Resource directory account verification has no permission.
500	ServerError	ServerError
500	RdCheckInnerError	Resource directory account service internal error.
403	NoPermission	caller has no permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.