Domain name for API request: tcss.intl.tencentcloudapi.com.
Query new settings of file scan 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: DescribeVirusScanConfig. |
| 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 | Enable Regular Scanning |
| Cycle | Integer | Detection Interval in Days |
| BeginScanAt | String | Scan start time |
| Timeout | Integer | Timeout Duration (Hours) |
| ScanRangeType | String | SCAN_NODE: Scanning node SCAN CONTAINER |
| ScanIDs | Array of ScanRangeInfo | Container ID or Node ID in Custom Scan Range |
| ScanPath | Array of String | Custom Excluded or Scanned Address |
| ScanPathMode | String | Scan path mode: SCAN_PATH_ALL: All paths. SCAN_PATH_DEFAULT: Default path SCAN_PATH_USER_DEFINE: User-defined path |
| IsIncludePath | Boolean | true: including path Default value: false. Excluded 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. |
Query new settings of file scan at runtime.
POST / HTTP/1.1
Host: tcss.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeVirusScanSettingV2
<Common request parameters>
{}
{
"Response": {
"EnableScan": true,
"Cycle": 1,
"BeginScanAt": "abc",
"Timeout": 1,
"ScanRangeType": "abc",
"ScanIDs": [
{
"IsAll": true,
"RangeType": "abc",
"IDs": [
"abc"
]
}
],
"ScanPath": [
"abc"
],
"ScanPathMode": "abc",
"IsIncludePath": true,
"RequestId": "abc"
}
}
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. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback