Tenant Cloud Security Cloud Workload Protection Platform Other APIs DescribeScanTaskDetails

DescribeScanTaskDetails

Last Updated At: 2026-08-02 00:05:03

1. Interface Description

Interface request domain name: cwp.api3.convergecloud.com.

This API is used to query the details of a scan task or query the progress of the scan task or whether the scan task is running normally.

Default interface request rate limit: 20 times per second.

Interface update time: 2022-06-14 17:12:25.

The interface is both signature verification and authentication.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name Required Allow NULL Type Description
Action Yes No String Public parameter, The value of this interface: DescribeScanTaskDetails
Version Yes No String Public parameter, The value of this interface: 2018-02-28
Region No No String Public parameter,Regional information This interface does not need to pass this parameter.
Filters No No Array of Filters Filter conditions.
  • MachineName - String - Required: No - Host alias.
  • Ip - String - Required: No - Host IP address.
  • InstanceID - String - Required: No - Host instance ID.

    • Example:View
    Limit No No Uint64 Maximum number of entries to return. Maximum value: 100.
    Example: 10
    ModuleType Yes No String Module type. Valid values: Malware (trojan), Vul (vulnerability), and Baseline.
    Example: Vul
    Offset No No Uint64 Offset. Default value: 0.
    Example: 0
    TaskId Yes No Uint64 The task ID.
    Example: 1

    3. Output Parameters

    Parameter name Type Description
    RiskEventCount Uint64 Number of risky events.
    Example: 1
    RiskMachineCount Uint64 Number of servers at risk.
    Example: 1
    ScanBeginTime String Start time of the scan.
    Example: 2024-10-30 10:13:53
    ScanContent Array of String Scan content.
    Example:  ["0", "1", "2", "4", "5"]
    ScanEndTime String Time when the scan ends.
    Example: 2021-02-01 12:00:00
    ScanLeftTime Uint64 Remaining scanning time.
    Example: 12
    ScanMachineCount Uint64 Total number of scanned servers.
    Example: 1
    ScanProgress Uint64 Scan progress.
    Example: 10
    ScanTaskDetailList Array of ScanTaskDetails Scan task information.
    Example:View
    ScanTime Uint64 Scan time.
    Example: 19
    StoppingAll Bool Indicates whether the task is being stopped. true: yes.
    Example: true
    TotalCount Uint64 Total number.
    Example: 1
    Type Uint64 0: quick scan .1: scheduled scan.
    Example: 1
    VulCount Uint64 Number of vulnerabilities detected in the scan.
    Example: 0
    VulInfo Array of VulDetailInfo Vulnerability information.
    Example:View
    RequestId String Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

    4. Error Code

    The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

    Error Code Description
    InternalError Internal error.
    MissingParameter Missing parameter.
    InvalidParameter.IllegalRequest Invalid request.
    InvalidParameter Invalid parameter.
    AuthFailure CAM signature or authentication error.
    InvalidParameterValue The parameter value is invalid.