Tenant Cloud Security Cloud Workload Protection Platform Other APIs DescribeScanState

DescribeScanState

Last Updated At: 2026-08-03 00:04:49

1. Interface Description

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

This API is used to query the status of a scan task that is running in the corresponding module.

Default interface request rate limit: 20 times per second.

Interface update time: 2022-12-29 09:49:27.

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: DescribeScanState
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 parameters; 
  • StrategyId - Baseline strategy ID, required only when ModuleType is Baseline.

    • Example:View
    ModuleType Yes No String Module type. Valid values: Malware (trojan), Vul (vulnerability), and Baseline.
    Example: Vul

    3. Output Parameters

    Parameter name Type Description
    RiskEventCount Uint64 Number of scanned vulnerabilities.
    Example: 1
    ScanBeginTime String Time when the scan starts.
    Example: 2021-07-09 15:04:01
    ScanEndTime String Time when the scan ends.
    Example: 2021-07-09 15:04:01
    ScanState Uint64 0: never scanned. 1: scanning. 2: scan completed. 3: stopping. 4: stopped.
    Example: 2
    Schedule Uint64 Scan progress.
    Example: 10
    TaskId Uint64 Task ID.
    Example: 1
    Type Uint64 0: quick scan .1: scheduled scan.
    Example: 1
    VulId Array of Uint64 Vulnerability ID in the scan task.
    Example: [1,2,4]
    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.
    InvalidParameter.MissingParameter Missing parameter.
    InvalidParameter.InvalidFormat Incorrect parameter format.
    MissingParameter Missing parameter.
    ResourceNotFound The resource does not exist.
    InvalidParameter.IllegalRequest Invalid request.
    InvalidParameter Invalid parameter.
    AuthFailure CAM signature or authentication error.
    InvalidParameterValue The parameter value is invalid.