Domain name for API request: tcss.tencentcloudapi.com.
This API is used to perform a quick virus 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: CreateVirusScanTask. |
Version | Yes | String | Common Params. The value used for this API: 2020-11-01. |
Region | No | String | Common Params. This parameter is not required. |
ScanPathAll | Yes | Boolean | Whether to scan all paths |
ScanRangeType | Yes | Integer | Scanning scope. Valid values: 0 (container); 1 (server). |
ScanRangeAll | Yes | Boolean | Valid values: true (all); false (specified). |
Timeout | Yes | Integer | Timeout period in hours |
ScanPathType | No | Integer | Valid when ScanPathAll is false . Valid values: 0 (scan the following paths); 1 (scan all paths except the following). |
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 | Specified path to be excluded or scanned |
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 |
Parameter Name | Type | Description |
---|---|---|
TaskID | String | Task ID |
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 create a virus scanning task.
POST / HTTP/1.1
Host: tcss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateVirusScanTask
<Common request parameters>
{
"ScanRangeAll": true,
"ScanPathAll": true,
"ScanRangeType": 1,
"ScanPathMode": "SCAN_PATH_DEFAULT",
"Timeout": 2
}
{
"Response": {
"RequestId": "a6d8d540-940f-47d9-8d7f-daac832ba5b4",
"TaskID": "6013a6c334b9a9000cf519be"
}
}
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. |
InternalError.MainDBFail | The database operation failed. |
InvalidParameter | The parameter is incorrect. |
ResourceNotFound | The resource does not exist. |
Was this page helpful?