tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeScanTaskDetails

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 scan task details and scan progress information/exceptions.

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: DescribeScanTaskDetails.
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.
TaskId Yes Integer Task ID
Filters.N No Array of Filters Filter parameters
Limit No Integer Number of items to be returned. The maximum value is 100.
Offset No Integer Offset. Default value: 0.

3. Output Parameters

Parameter Name Type Description
ScanTaskDetailList Array of ScanTaskDetails List of scan task information
TotalCount Integer Total number
ScanMachineCount Integer Total number of scanned machines
RiskMachineCount Integer Number of machines with risks detected
ScanBeginTime String Scan start time
ScanEndTime String Scan end time
ScanTime Integer Scan time
ScanProgress Integer Scan progress
ScanLeftTime Integer Remaining scan time
ScanContent Array of String Scan content
VulInfo Array of VulDetailInfo Vulnerability information
Note: This field may return null, indicating that no valid values can be obtained.
RiskEventCount Integer Number of risk events
Note: This field may return null, indicating that no valid values can be obtained.
Type Integer 0: one-click scan; 1: scheduled scan.Note: This field may return null, indicating that no valid values can be obtained.
StoppingAll Boolean Whether all tasks are being stopped. true: yes.Note: This field may return null, indicating that no valid values can be obtained.
VulCount Integer Number of vulnerabilities scanned
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: DescribeScanTaskDetails
<Common request parameters>

{
    "ModuleType": "Vul",
    "TaskId": 1
}

Output Example

{
    "Response": {
        "ScanContent": [
            "cve"
        ],
        "VulInfo": [
            {
                "CveId": "cve- ",
                "CvssScore": 0,
                "Name": "name",
                "Reference": "ref",
                "Level": 1,
                "Fix": "fix",
                "Descript": "desc",
                "PublishTime": " 2019-12-25 11:57:15",
                "VulId": 1,
                "Cvss": "cvss",
                "VulCategory": 1
            }
        ],
        "ScanMachineCount": 1,
        "ScanTaskDetailList": [
            {
                "Status": "status",
                "Uuid": "1c26308c-5493-4eaf-a817-112ec25f499e",
                "ScanEndTime": " 2019-12-25 11:57:15",
                "FailType": 1,
                "HostName": "hostname",
                "ScanBeginTime": " 2019-12-25 11:57:15",
                "OsName": "osname",
                "Quuid": "1c26308c-5493-4eaf-a817-112ec25f499e",
                "HostIp": "10.1.1.15",
                "RiskNum": 1,
                "Id": 1,
                "Description": "desc",
                "MachineWanIp": "10.1.1.15",
                "MachineExtraInfo": {
                    "WanIP": "10.1.1.15",
                    "PrivateIP": "10.1.1.15",
                    "NetworkType": 0,
                    "NetworkName": "name",
                    "InstanceID": "ins-dsf",
                    "HostName": "hostname"
                }
            }
        ],
        "ScanEndTime": " 2019-12-25 11:57:15",
        "ScanTime": 1,
        "ScanProgress": 1,
        "ScanLeftTime": 1,
        "ScanBeginTime": " 2019-12-25 11:57:15",
        "TotalCount": 1,
        "RequestId": "acdd5474-6360-4fd4-bfc7-843162cb8116",
        "RiskEventCount": 1,
        "VulCount": 1,
        "RiskMachineCount": 1,
        "Type": 1,
        "StoppingAll": false
    }
}

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.
InvalidParameterValue Invalid parameter value.
MissingParameter Missing parameter error.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy