Use CreateCycleTask to create a periodic scan - Security Center - Alibaba Cloud - Security Center

Creates an epoch scan task, including image scans, emergency vulnerability scans, and virus scans.

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:CreateCycleTask

create

*CycleTask

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

None

Request parameters

Parameter	Type	Required	Description	Example
TaskName	string	Yes	The task name. This is a custom string used to identify the periodic scan task.	test_virus_scan
TaskType	string	Yes	The task type. Valid values: VIRUS_VUL_SCHEDULE_SCAN: virus scan. IMAGE_SCAN: image scan. EMG_VUL_SCHEDULE_SCAN: emergency vulnerability scan.	VIRUS_VUL_SCHEDULE_SCAN
PeriodUnit	string	Yes	The unit of the scan period. Valid values: day: day. hour: hour.	day
IntervalPeriod	integer	Yes	The interval period.	7
FirstDateStr	integer	Yes	The time of the first execution.	1650556800000
TargetStartTime	integer	Yes	The start time of the task, in hours.	0
TargetEndTime	integer	Yes	The end time of the task, in hours.	6
Param	string	No	The extended information field. Note Note: This parameter is required. If you do not specify this parameter, the API returns an error. The value is a JSON-formatted string that must contain at least the targetInfo array.	{ "targetInfo": [ { "type": "groupId", "name": "TI HOST", "target": 10597* }, { "type": "groupId", "name": "expense HOST", "target": 10597* } ] }
Enable	integer	Yes	Specifies whether to enable the task. Valid values: 1: Enable. 0: Disable.	1
Source	string	No	The source from which the task is created.	console_batch
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.	0c593ea1-3bea-11e9-b96b-88e9fe637760
		No	Specifies whether to perform only a dry run, without performing the actual request. Valid values: true: performs only a dry run without performing the actual operation. false: performs the actual request. Default value: false.

Response elements

Element	Type	Description	Example
	object
ConfigId	string	The ID of the configuration.	00cfa8161da093089e6804ba6a33****
RequestId	string	The request ID. Alibaba Cloud generates a unique identifier for each request. You can use this ID to troubleshoot issues.	86CFF42E-E00A-57A3-8656-22291EFB****

Examples

Success response

JSON format

{
  "ConfigId": "00cfa8161da093089e6804ba6a33****",
  "RequestId": "86CFF42E-E00A-57A3-8656-22291EFB****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	RdCheckNoPermission	Resource directory account verification has no permission.
400	IdempotentParameterMismatch	相同的 ClientToken 被用于不同的请求参数。
500	ServerError	ServerError
500	RdCheckInnerError	Resource directory account service internal error.
403	NoPermission	caller has no permission	You are not authorized to do this operation.
409	IdempotentRequestInProgress	使用相同 ClientToken 的请求正在处理中。

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.