Use GetOnceTaskResultInfo to query the execution result of a one-time scan task - Security Center - Alibaba Cloud - Security Center

Queries the execution results of a one-time scan task, such as an asset fingerprint collection task, a vulnerability scan, or an image security scan.

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-aegis:GetOnceTaskResultInfo

get

*All resources

*

None

Request parameters

Parameter	Type	Required	Description	Example
TaskType	string	Yes	The type of the task. Valid values: CLIENT_PROBLEM_CHECK: client troubleshooting task CLIENT_DEV_OPS: cloud O&M task ASSET_SECURITY_CHECK: asset collection task ASSETS_COLLECTION: asset fingerprint collection task IMAGE_SCAN: container image scan task AI_SECURITY_CHECK: AI asset synchronization task IDC_PROBE_SCAN: IDC probe scan task ATTACK_SURFACE_SCAN: attack surface and boundary asset scan task ASSET_EXPOSURE_SCAN: asset exposure scan task VUL_CHECK_TASK: vulnerability scan task	ASSETS_COLLECTION
TaskName	string	Yes	The name of the task. Valid values: CLIENT_PROBLEM_CHECK: client troubleshooting task CLIENT_DEV_OPS: cloud O&M task ASSET_SECURITY_CHECK: asset collection task ASSETS_COLLECTION: asset fingerprint collection task IMAGE_SCAN: container image scan task AI_SECURITY_CHECK: AI asset synchronization task IDC_PROBE_SCAN: IDC probe scan task ATTACK_SURFACE_SCAN: attack surface and boundary asset scan task ASSET_EXPOSURE_SCAN: asset exposure scan task VUL_CHECK_TASK: vulnerability scan task	ASSETS_COLLECTION
TaskId	string	Yes	The ID of the one-time task.	9dfa3a7eb9547781632785b49003****

Response elements

Element	Type	Description	Example
	object
CollectTime	integer	The time when the task was executed.	1671184531000
RequestId	string	The ID of the request. This uniquely identifies the request and can be used for troubleshooting.	CE500770-42D3-442E-9DDD-156E0F9F****
TotalCount	integer	The total number of entries returned.	44
TaskId	integer	The ID of the one-time task.	e7b70a4b030db086db52231f1b58****
FinishCount	integer	The number of tasks that have been completed.	47
TaskInfo	object	Details of the task.
Status	string	The status of the task. Valid values: INIT: The task is pending start. START: The task is running. SUCCESS: The task is completed. TIMEOUT: The task has timed out.	START

Examples

Success response

JSON format

{
  "CollectTime": 1671184531000,
  "RequestId": "CE500770-42D3-442E-9DDD-156E0F9F****",
  "TotalCount": 44,
  "TaskId": 0,
  "FinishCount": 47,
  "TaskInfo": {
    "Status": "START"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalParameter	Illegal parameter. Check the input parameters.	The specified parameter is invalid. Check the input parameters.
500	ServerError	ServerError	A server error occurred. Try again later.
403	NoPermission	caller has no permission	You are not authorized to perform this operation. Contact the Alibaba Cloud account owner to grant the required permissions in the RAM console.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.