Tencent Cloud

Download PDF

DescribeScanTaskDetails

Last updated: 2024-08-27 11:40:28

Download PDF

1. API Description

Domain name for API request: cwp.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.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeScanTaskDetails
<Common request parameters>

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

Output Example

{
    "Response": {
        "ScanContent": [
            "xx"
        ],
        "VulInfo": [
            {
                "CveId": "xx",
                "CvssScore": 0.0,
                "Name": "xx",
                "Reference": "xx",
                "Level": 1,
                "Fix": "xx",
                "Descript": "xx",
                "PublishTime": "xx",
                "VulId": 1,
                "Cvss": "xx",
                "VulCategory": 1
            }
        ],
        "ScanMachineCount": 1,
        "ScanTaskDetailList": [
            {
                "Status": "xx",
                "Uuid": "xx",
                "ScanEndTime": "xx",
                "FailType": 1,
                "HostName": "xx",
                "ScanBeginTime": "xx",
                "OsName": "xx",
                "Quuid": "xx",
                "HostIp": "xx",
                "RiskNum": 1,
                "Id": 1,
                "Description": "xx"
            }
        ],
        "ScanEndTime": "xx",
        "ScanTime": 1,
        "ScanProgress": 1,
        "ScanLeftTime": 1,
        "ScanBeginTime": "xx",
        "TotalCount": 1,
        "RequestId": "xx",
        "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

Tencent Cloud CLI 3.0

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.

tencent cloud

Recent Pages

DescribeScanTaskDetails

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Example

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

Was this page helpful?

Was this page helpful?

tencent cloud

Sign Up

Log in

Recent Pages

DescribeScanTaskDetails

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Example

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

Was this page helpful?

Was this page helpful?