Tencent Container Security Service
- Product Introduction
- Operation Guide
- Vulnerability Detection
- Image Risk Management
- Cluster Risk Management
- Baseline Management
- Runtime Security
- Advanced Defense
- Abnormal Process
- File Tampering
- High-Risk Syscall
- Policy Management
- Container Network Policy
- Log Analysis
- Hybrid Cloud Installation Guide
- Troubleshooting
- API Documentation
- Making API Requests
- Network Security APIs
- Cluster Security APIs
- Security Compliance APIs
- Runtime security - High-risk syscalls
- Runtime Security - Reverse Shell APIs
- Runtime Security APIs
- Alert Settings APIs
- Advanced prevention - K8s API abnormal requests
- Asset Management APIs
- Security Operations - Log Analysis APIs
- Runtime Security - Trojan Call APIs
- Runtime Security - Container Escape APIs
- Image Security APIs
- Billing APIs
DocumentationTencent Container Security ServiceAPI DocumentationRuntime Security - Trojan Call APIsModifyVirusScanSetting
ModifyVirusScanSetting
Last updated: 2024-12-06 15:47:25
1. API Description
Domain name for API request: tcss.intl.tencentcloudapi.com.
This API is used to update virus scanning settings at runtime.
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: ModifyVirusScanSetting. |
| Version | Yes | String | Common Params. The value used for this API: 2020-11-01. |
| Region | No | String | Common Params. This parameter is not required. |
| EnableScan | Yes | Boolean | Whether to enable scheduled scan |
| Cycle | Yes | Integer | Check cycle in days. Valid values: 1, 3, 7. |
| BeginScanAt | Yes | String | Scan start time |
| ScanPathAll | Yes | Boolean | Scan all paths. Valid values: true (all); false (specified). |
| ScanPathType | Yes | Integer | Valid when ScanPathAll is true. Valid values of ScanPathAll: 0 (scan the following paths); 1 (scan all paths except the following). |
| Timeout | Yes | Integer | Timeout period in hours. Value range: 5-24. |
| ScanRangeType | Yes | Integer | Scanning scope. Valid values: 0 (container); 1 (server). |
| ScanRangeAll | Yes | Boolean | Valid values: true (all); false (specified). |
| ScanIds.N | No | Array of String | ID of the specified container or server to be scanned, which is based on ScanRangeType. |
| ScanPath.N | No | Array of String | Scanned path |
| ScanPathMode | No | String | Path scanning mode: SCAN_PATH_ALL: Scan all pathsSCAN_PATH_DEFAULT: Scan the default pathSCAN_PATH_USER_DEFINE: Scan the custom path |
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 Modifying virus scanning settings
This example shows you how to modify the virus scanning settings.
Input Example
POST / HTTP/1.1
Host: tcss.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyVirusScanSetting
<Common request parameters>
{
"BeginScanAt": "xx",
"EnableScan": true,
"ScanPathType": 1,
"ScanRangeType": 1,
"ScanPathAll": true,
"Timeout": 1,
"ScanIds": [
"xx"
],
"ScanPath": [
"xx"
],
"ScanRangeAll": true,
"Cycle": 1
"ScanPathMode": "SCAN_PATH_ALL"
}
Output Example
{
"Response": {
"RequestId": "b9cd345d-9d88-4e3b-86b6-e0e5c971731a"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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 | An internal error occurred. |
| InvalidParameter | The parameter is incorrect. |
| InvalidParameter.ParsingError | A parameter parsing error occurred. |
| ResourceNotFound | The resource does not exist. |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No