Use DescribeVulCheckTaskStatusDetail to query vulnerability scan task status - Security Center - Alibaba Cloud - Security Center

Queries the status of a vulnerability scanning node for a specified server.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
TaskIds	array	No	The list of task IDs.
	string	No	The task ID of the server.	ad8afca3914a5fff4636e67f18e259c7
Types	array	No	The list of vulnerability types for the one-click scan.
	string	No	The vulnerability type. Valid values: cve: Linux software vulnerability sys: Windows system vulnerability cms: Web-CMS vulnerability sca: SCA vulnerability	sca
Uuid	string	No	The UUID of the server to query. This parameter is required. If this parameter is not specified, the API returns HTTP 503 with the error code ServiceUnavailable.	5d55af3c-35f3-4d4d-8ccc-8c5443b0****
ResourceDirectoryAccountId	integer	No	The Alibaba Cloud account ID of the member accounts in the resource folder. Note Invoke the DescribeMonitorAccounts operation to obtain this parameter.	127608589417****

Response elements

Element	Type	Description	Example
	object	The response parameters.
TotalCount	integer	The total number of vulnerability subtasks for the server.	1
RequestId	string	The request ID.	BE120DAB-F4E7-4C53-ADC3-A97578ABF384
TaskStatuses	array<object>	The list of vulnerability task statuses for the server.
	array<object>	The vulnerability main task status struct.
TaskId	string	The main task ID.	16190385
TaskStatusList	array<object>	The list of vulnerability detection task statuses.
	object	The vulnerability subtask status struct.
Type	string	The vulnerability type. Valid values: cve: Linux software vulnerability sys: Windows system vulnerability cms: Web-CMS vulnerability sca: SCA vulnerability	cve
Status	string	The check completion status. Valid values: 0: Unprocessed. 1: Collecting. 2: Collection completed. 3: Matching. 4: Completed.	4
Code	string	The failure code.	push_command_failed

Examples

Success response

JSON format

{
  "TotalCount": 1,
  "RequestId": "BE120DAB-F4E7-4C53-ADC3-A97578ABF384",
  "TaskStatuses": [
    {
      "TaskId": "16190385",
      "TaskStatusList": [
        {
          "Type": "cve",
          "Status": "4",
          "Code": "push_command_failed"
        }
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalParam	Illegal param
400	RdCheckNoPermission	Resource directory account verification has no permission.
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.