Domain name for API request: tcss.intl.tencentcloudapi.com.
This API is used to query the real-time monitoring settings of virus scanning 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: DescribeVirusMonitorSetting. |
| 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 real-time monitoring |
| ScanPathAll | Boolean | Scan all paths. |
| ScanPathType | Integer | It is effective when ScanPathAll is true. 0: Scan the following paths; 1: Scan the following paths. |
| ScanPath | Array of String | Custom Excluded or Scanned Address |
| 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 querying the monitoring settings for virus scanning.
POST / HTTP/1.1
Host: tcss.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeVirusMonitorSetting
<Common request parameters>
{}
{
"Response": {
"RequestId": "b9cd345d-9d88-4e3b-86b6-e0e5c971731a",
"EnableScan": true,
"ScanPathAll": true,
"ScanPathType": 0,
"ScanPathMode": "SCAN_PATH_DEFAULT",
"ScanPath": []
}
}
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