tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeScanState

Last updated: 2024-12-06 15:40:27

1. API Description

Domain name for API request: cwp.intl.tencentcloudapi.com.

This API is used to query the status of recent scan tasks of the corresponding module.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeScanState.
Version Yes String Common Params. The value used for this API: 2018-02-28.
Region No String Common Params. This parameter is not required.
ModuleType Yes String Module type. Malware (Trojan), Vul (vulnerability), and Baseline are currently available.
Filters.N No Array of Filters Filter parameters
  • StrategyId: Baseline policy ID, which is required only if ModuleType is set to Baseline
    		•

    3. Output Parameters

    Parameter Name Type Description
    ScanState Integer 0 - never scanned; 1 - scan in progress; 2 - scan completed; 3 - stop in progress; 4 - stop completed
    Schedule Integer Scan progress
    TaskId Integer Task ID
    VulId Array of Integer Vulnerability ID of task scan
    Type Integer 0 - one-click detection; 1 - regular detection
    ScanBeginTime String Scan start time
    Note: This field may return null, indicating that no valid values can be obtained.
    RiskEventCount Integer Number of vulnerabilities scanned
    Note: This field may return null, indicating that no valid values can be obtained.
    ScanEndTime String Scan end time
    Note: This field may return null, indicating that no valid values can be obtained.
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Example

    Input Example

    POST / HTTP/1.1
Host: cwp.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeScanState
<Common request parameters>

{
    "ModuleType": "Vul"
}

    Output Example

    {
    "Response": {
        "RiskEventCount": 1,
        "ScanEndTime": "2023-10-26 14:56:29",
        "Schedule": 1,
        "ScanState": 1,
        "ScanBeginTime": "2023-10-26 14:56:29",
        "RequestId": "c741a4fd-776f-499b-85a2-7bc70fd5b92s",
        "TaskId": 1,
        "VulId": [
            1
        ],
        "Type": 1
    }
}

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    AuthFailure CAM signature/authentication error.
    InternalError Internal error
    InvalidParameter Incorrect parameter.
    InvalidParameter.IllegalRequest Invalid request.
    InvalidParameter.InvalidFormat Incorrect parameter format.
    InvalidParameter.MissingParameter Missing parameter.
    InvalidParameterValue Invalid parameter value.
    MissingParameter Missing parameter error.
    ResourceNotFound The resource does not exist.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy