tencent cloud

All product documents
Tencent Container Security Service
DocumentationTencent Container Security ServiceAPI DocumentationRuntime Security - Trojan Call APIsDescribeVirusScanSetting
DescribeVirusScanSetting
Download PDF
Last updated: 2024-12-06 15:47:30
DescribeVirusScanSetting
Last updated: 2024-12-06 15:47:30
Download PDF

1. API Description

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.

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: 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.

3. Output Parameters

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 paths
SCAN_PATH_DEFAULT: Scan the default path
SCAN_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.

4. Example

Example1 Querying virus scanning settings

This example shows you how to query the virus scanning settings.

Input Example

POST / HTTP/1.1
Host: tcss.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeVirusScanSetting
<Common request parameters>

{}

Output Example

{
    "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"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

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.
ResourceNotFound The resource does not exist.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon