tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ScanVul

Last updated: 2024-08-27 11:36:32

1. API Description

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

This API is used to perform one-click vulnerability scans.

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: ScanVul.
Version Yes String Common Params. The value used for this API: 2018-02-28.
Region No String Common Params. This parameter is not required.
VulLevels Yes String Whether to count only critical vulnerabilities. 1: only critical vulnerabilities; 0: all vulnerabilities.
HostType Yes Integer Server type. 1: Pro Edition server; 2: selected server.
VulCategories No String Vulnerability category. 1: web CMS vulnerability; 2: application vulnerability; 4: Linux software vulnerability; 5: Windows system vulnerability (separate multiple values by commas).
QuuidList.N No Array of String String array of host QUUIDs. This parameter is effective for selected servers.
VulEmergency No Integer Whether it is an emergency vulnerability. 0: no; 1: yes.
TimeoutPeriod No Integer Scan duration, in seconds. Default duration: 3,600 second.
VulIds.N No Array of Integer IDs of vulnerabilities to be scanned
ScanMethod No Integer

3. Output Parameters

Parameter Name Type Description
TaskId Integer Task ID
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 One-Click Vulnerability Detection

Input Example

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

{
    "VulCategories": "1,2",
    "VulLevels": "1,2,3,4",
    "HostType": 1,
    "QuuidList": [
        "69796250-2a3a-40ef-b418-676e677019a4"
    ],
    "VulEmergency": 1,
    "TimeoutPeriod": 3600,
    "VulIds": [
        1
    ]
}

Output Example

{
    "Response": {
        "TaskId": 1,
        "RequestId": "69796250-2a3a-40ef-b418-676e677019a4"
    }
}

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
FailedOperation Operation failed.
FailedOperation.APIServerFail Failed to invoke the API service.
FailedOperation.NoProfessionHost No Pro Edition host.
InternalError Internal error
InvalidParameter Incorrect parameter.
InvalidParameter.IllegalRequest Invalid request.
InvalidParameter.InvalidFormat Incorrect parameter format.
InvalidParameter.MissingParameter Missing parameter.
InvalidParameter.ParsingError Incorrect parameter parsing.
InvalidParameterValue Invalid parameter value.
OperationDenied The operation was denied.
ResourceNotFound The resource does not exist.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy