Domain name for API request: tcss.intl.tencentcloudapi.com.
This API is used to query virus scanning settings at runtime.
A maximum of 20 requests can be initiated per second for this API.
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: DescribeVirusScanSetting. |
| Version | Yes | String | Common Params. The value used for this API: 2020-11-01. |
| Region | No | String | Common Params. This parameter is not required. |
| Parameter Name | Type | Description |
|---|---|---|
| EnableScan | Boolean | Whether to enable scheduled scan |
| Cycle | Integer | Check cycle in days |
| BeginScanAt | String | Scan start time |
| ScanPathAll | Boolean | Scan all paths |
| ScanPathType | Integer | Valid when ScanPathAll is true. Valid values of ScanPathAll: 0 (scan the following paths); 1 (scan all paths except the following). |
| Timeout | Integer | Timeout period in hours |
| ScanRangeType | Integer | Scanning scope. Valid values: 0 (container); 1 (server). |
| ScanRangeAll | Boolean | Valid values: true (all); false (specified). |
| ScanIds | Array of String | ID of the specified container or server to be scanned, which is based on ScanRangeType. |
| ScanPath | Array of String | Specified path to be excluded or scanned |
| ClickTimeout | Integer | Timeout settings of quick check Note: This field may return null, indicating that no valid values can be obtained. |
| ScanPathMode | String | Path scanning mode: SCAN_PATH_ALL: Scan all pathsSCAN_PATH_DEFAULT: Scan the default pathSCAN_PATH_USER_DEFINE: Scan the custom path |
| 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. |
This example shows you how to query the virus scanning settings.
POST / HTTP/1.1
Host: tcss.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeVirusScanSetting
<Common request parameters>
{}
{
"Response": {
"EnableScan": true,
"Cycle": 1,
"BeginScanAt": "xx",
"ScanPathAll": true,
"ScanPathType": 1,
"Timeout": 1,
"ScanRangeType": 1,
"ScanRangeAll": true,
"ScanIds": [],
"xx"
],
"ScanPath": [
"xx"
],
"ClickTimeout": 1,
"ScanPathMode": "SCAN_PATH_DEFAULT",
"RequestId": "xx"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
| ResourceNotFound | The resource does not exist. |
피드백