GenerateOnceTask - Security Center - Alibaba Cloud Documentation Center

Creates a one-time scan task.

Debugging

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

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-aegis:GenerateOnceTask	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
TaskType	string	Yes	The type of the scan task. Valid values: CLIENT_PROBLEM_CHECK: a client diagnosis task CLIENT_DEV_OPS: an O&M task of Cloud Assistant ASSET_SECURITY_CHECK: a task of asset information collection	CLIENT_PROBLEM_CHECK
TaskName	string	Yes	The name of the scan task. Valid values: CLIENT_PROBLEM_CHECK: a client diagnosis task CLIENT_DEV_OPS: an O&M task of Cloud Assistant ASSET_SECURITY_CHECK: a task of asset information collection	CLIENT_PROBLEM_CHECK
Param	string	Yes	The additional information.	{"mode":1,"problemType":"offline","uuids":"inet-795dcad1-360f-49d2-b01e-b7da7f1c****"}
Source	string	No	The source of the scan task.	Manual

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	8BB6B8FA-39E8-5654-A309-8EED13B1****
CanCreate	boolean	Indicates whether you can create more scan tasks. Valid values: true: yes false: no Note By default, a maximum of 10 scan tasks can be running at the same time. If 10 image scan tasks are running, you cannot create a scan task by calling this operation. You must wait for at least one of the 10 existing scan tasks to complete before you can create a scan task.	true
LastTask	string	The ID of the last scan task.	38730bb078f4a1461d4ed283994c****
CollectTime	long	The collection time.	1670307567000
TotalCount	integer	The total number of scan tasks.	100
TaskId	string	The ID of the scan task.	38730bb078f4a1461d4ed283994c****
FinishCount	integer	The number of scan tasks that are complete.	61

Examples

Sample success responses

JSONformat

{
  "RequestId": "8BB6B8FA-39E8-5654-A309-8EED13B1****",
  "CanCreate": true,
  "LastTask": "38730bb078f4a1461d4ed283994c****\n",
  "CollectTime": 1670307567000,
  "TotalCount": 100,
  "TaskId": "38730bb078f4a1461d4ed283994c****",
  "FinishCount": 61
}

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