tencent cloud

Feedback

ExportScanTaskDetails

Last updated: 2024-08-27 11:39:54

1. API Description

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

This API is used to export the specified scan task details by task ID.

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: ExportScanTaskDetails.
Version Yes String Common Params. The value used for this API: 2018-02-28.
Region No String Common Params. This parameter is not required.
TaskId Yes Integer Task ID for this detection (different from the ID of the task for exporting the detection Excel file in the input parameters)
ModuleType Yes String Module type. Malware: Trojan; Vul: vulnerability; Baseline: baseline.
Filters.N No Array of Filters Filter parameter: ipOrAlias (server name/IP address)

3. Output Parameters

Parameter Name Type Description
TaskId String Task ID, which is used to obtain the download URL (DownloadUrl) by using the asynchronous task export API ExportTasks. (This ID differs from the detection task ID in the input parameters.)
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 Exporting Scan Task Details

This example shows you how to export scan task details.

Input Example

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

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

Output Example

{
    "Response": {
        "RequestId": "354f4ac3-8546-4516-8c8a-69e3ab73aa8a",
        "TaskId": "1615549629"
    }
}

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
InternalError Internal error
InvalidParameter Incorrect parameter.
InvalidParameter.InvalidFormat Incorrect parameter format.
InvalidParameterValue Invalid parameter value.
MissingParameter Missing parameter error.