All Products
Search
Document Center

Security Center:CreateCycleTask

Last Updated:Nov 25, 2024

Creates a periodic scan task. The task can be an image scan task, urgent vulnerability scan task, or virus scan task.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-sas:CreateCycleTaskcreate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TaskNamestringYes

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
EMG_VUL_SCHEDULE_SCAN
TaskTypestringYes

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
VIRUS_VUL_SCHEDULE_SCAN
PeriodUnitstringYes

The unit of the scan interval. Valid values:

  • day: days
  • hour: hours
day
IntervalPeriodintegerYes

The interval of the task.

7
FirstDateStrlongYes

The first time when the task is performed.

1650556800000
TargetStartTimeintegerYes

The time when the task is started. Unit: hours.

0
TargetEndTimeintegerYes

The time when the task ends. Unit: hours.

6
ParamstringNo

The additional information.

{ "targetInfo": [ { "type": "groupId", "name": "TI HOST", "target": 10597*** }, { "type": "groupId", "name": "expense HOST", "target": 10597*** } ] }
EnableintegerYes

Specifies whether to enable the task. Valid values:

  • 1: yes
  • 0: no
1
SourcestringNo

The additional source for the task.

console_batch

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request, which is used to locate and troubleshoot issues.

86CFF42E-E00A-57A3-8656-22291EFB****

Examples

Sample success responses

JSONformat

{
  "RequestId": "86CFF42E-E00A-57A3-8656-22291EFB****"
}

Error codes

HTTP status codeError codeError messageDescription
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

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