tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ScanVulSetting

Last updated: 2024-12-06 15:38:53

1. API Description

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

This API is used to complete regular vulnerability scan settings.

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: ScanVulSetting.
Version Yes String Common Params. The value used for this API: 2018-02-28.
Region No String Common Params. This parameter is not required.
TimerInterval Yes Integer Regular detection interval (days)
VulCategories.N No Array of Integer Vulnerability type. 1: web CMS vulnerability; 2: application vulnerability; 4: Linux software vulnerability; 5: Windows system vulnerability. Pass in the values in array format. Example: [1,2]
VulLevels.N No Array of Integer Severity level. 1: low-risk; 2: medium-risk; 3: high-risk; 4: critical. Pass in the values in array format. Example: [1,2,3]
TimerTime No String Periodic detection time. Example: 02:10:50
VulEmergency No Integer Whether the vulnerability is an emergency vulnerability. 0: no; 1: yes.
StartTime No String Scan start time. Example: 00:00
EndTime No String Scan end time. Example: 08:00
EnableScan No Integer Whether to enable scanning. 1: enable; 0: disable.
Uuids.N No Array of String If empty, scan hosts with all Professional, Premium, and General Discount editions by default; if not empty, only scan the selected hosts.
ScanMethod No Integer

3. Output Parameters

Parameter Name Type Description
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 Regular Vulnerability Scan Settings

This example shows you the regular vulnerability scan settings.

Input Example

https://cwp.intl.tencentcloudapi.com/?Action=ScanVulSetting
&VulCategories.0=1
&VulLevels.0=1
&TimerInterval=3
&TimerTime=02:10:50
&VulEmergency=1
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "4234234"
    }
}

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