容器安全服务
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 容器安全服务 > API 文档 > 运行时安全-木马调用相关接口 > 运行时查询文件查杀设置

运行时查询文件查杀设置

最近更新时间：2024-03-12 01:51:52

我的收藏

本页目录：

1. 接口描述

接口请求域名： tcss.tencentcloudapi.com 。

运行时查询文件查杀设置

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeVirusScanSetting。
Version 是 String 公共参数，本接口取值：2020-11-01。
Region 否 String 公共参数，此参数为可选参数。

3. 输出参数

参数名称 类型 描述
EnableScan Boolean 是否开启定期扫描
示例值：true
Cycle Integer 检测周期每隔多少天
示例值：1
BeginScanAt String 扫描开始时间
示例值：10:00:00
ScanPathAll Boolean 扫描全部路径
示例值：true
ScanPathType Integer 当ScanPathAll为true 生效 0扫描以下路径 1、扫描除以下路径
示例值：0
Timeout Integer 超时时长，单位小时
示例值：1
ScanRangeType Integer 扫描范围0容器1主机节点
示例值：0
ScanRangeAll Boolean true 全选，false 自选
示例值：true
ScanIds Array of String 自选扫描范围的容器id或者主机id 根据ScanRangeType决定
示例值：[]
ScanPath Array of String 自选排除或扫描的地址
示例值：[]
ClickTimeout Integer 一键检测的超时设置
注意：此字段可能返回 null，表示取不到有效值。
示例值：1
ScanPathMode String 扫描路径模式：
SCAN_PATH_ALL：全部路径
SCAN_PATH_DEFAULT：默认路径
SCAN_PATH_USER_DEFINE：用户自定义路径

示例值：SCAN_PATH_ALL
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 运行时查询文件查杀设置

运行时查询文件查杀设置

输入示例

POST / HTTP/1.1
Host: tcss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeVirusScanSetting
<公共请求参数>

{}

输出示例

{
    "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. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。
ResourceNotFound 资源不存在。
中国站