All Products
Search
Document Center

Security Center:CreateCycleTask

Last Updated:Jul 23, 2024

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

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.