All Products
Search
Document Center

Security Center:DescribeVulCheckTaskStatusDetail

Last Updated:Feb 20, 2024

Queries the status information about vulnerability scan tasks on a server.

Debugging

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

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:DescribeVulCheckTaskStatusDetailRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TaskIdsarrayYes

The task IDs.

stringYes

The ID of the task.

ad8afca3914a5fff4636e67f18e259c7
TypesarrayYes

The types of the vulnerabilities that are detected by the tasks.

stringYes

The type of the vulnerability. Valid values:

  • cve: Linux software vulnerabilities
  • sys: Windows system vulnerabilities
  • cms: Web-CMS vulnerabilities
  • sca: vulnerabilities that are detected based on software component analysis
sca
UuidstringYes

The UUID of the server.

5d55af3c-35f3-4d4d-8ccc-8c5443b0****

Response parameters

ParameterTypeDescriptionExample
object

The data returned.

TotalCountinteger

The total number of vulnerability scan tasks on the server.

1
RequestIdstring

The ID of the request.

BE120DAB-F4E7-4C53-ADC3-A97578ABF384
TaskStatusesobject []

An array that consists of the status information about the vulnerability scan tasks on the server.

TaskIdstring

The ID of the main task.

16190385
TaskStatusListobject []

An array that consists of status information about the vulnerability scan subtask.

Typestring

The type of the vulnerability. Valid values:

  • cve: Linux software vulnerability
  • sys: Windows system vulnerability
  • cms: Web-CMS vulnerability
  • sca: vulnerability that is detected based on software component analysis
cve
Statusstring

The status of the subtask. Valid values:

  • 0: unhandled
  • 1: collecting
  • 2: collected
  • 3: matching
  • 4: complete
4
Codestring

The error code returned.

push_command_failed

Examples

Sample success responses

JSONformat

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

Error codes

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

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

Change history

Change timeSummary of changesOperation
2023-11-22The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 500
    Added Error Codes: 400