1. 接口描述
接口请求域名: csip.tencentcloudapi.com 。
查询文件查杀定时扫描配置
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeMalwareTimingScanSetting。 |
| Version | 是 | String | 公共参数,本接口取值:2022-11-21。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| MemberId.N | 否 | Array of String | 集团账号的成员id 示例值:["mem-tencent-e74488e0ba0cd8fe"] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| EnableScan | Integer | 定时检测开关 0 关闭1 开启 示例值:1 |
| Cycle | Integer | 周期 1每天 示例值:1 |
| StartTime | String | 检测周期 开始时间 示例值:00:00 |
| EndTime | String | 检测周期 超时结束时间 示例值:17:40 |
| ScanType | String | 检测模式 示例值:include |
| CustomPaths | Array of String | 自选路径列表 示例值:["/detect/path"] |
| AssetSelectionType | String | 资产选择方式 示例值:tag |
| TagIds | Array of String | 标签ID数组 示例值:["1"] |
| InstanceIDsWithAppId | Array of InstanceIDWithAppIdItem | 直接选择的主机列表 |
| ExcludeInstanceIDsWithAppId | Array of InstanceIDWithAppIdItem | 排除的主机列表 |
| ClusterIDsWithAppId | Array of ClusterIDWithAppIdItem | 直接选择的集群列表 |
| ExcludeClusterIDsWithAppId | Array of ClusterIDWithAppIdItem | 排除的集群列表 |
| RealTimeMonitoring | Integer | 实时监控0 关闭 1开启 示例值:1 |
| MonitoringPattern | Integer | 监控模式 0 标准 1深度 示例值:2 |
| MonitorCustomPaths | Array of String | 实时监控自定义路径列表 示例值:["/detect/path"] |
| EngineType | Integer | 1标准模式(只报严重、高危)、2增强模式(报严重、高危、中危)、3严格模式(报严重、高、中、低、提示) 示例值:3 |
| EnableInspiredEngine | Integer | 启发引擎 0 关闭 1开启 示例值:0 |
| EnableMemShellScan | Integer | 是否开启恶意进程查杀[0:未开启,1:开启] 示例值:0 |
| AutoIsolation | Integer | 是否自动隔离:1-是,0-否 示例值:1 |
| KillProcess | Integer | 是否杀掉进程 1杀掉 0不杀掉 只有开启自动隔离才生效 示例值:1 |
| DoClean | Integer | 执行清理开关 0未开启 1开启 示例值:0 |
| ProtectMode | Integer | 防护模式 0 标准 1 重保 示例值:0 |
| ProtectFileScope | Integer | 查杀范围 0 脚本类之外的恶意文件,1全部恶意文件 示例值:0 |
| QuaraAssetSelectionType | String | 隔离资产选择 示例值:tag |
| QuaraTagIds | Array of String | 隔离标签ID数组 示例值:["1"] |
| QuaraInstanceIDsWithAppId | Array of InstanceIDWithAppIdItem | 隔离直接选择的主机 |
| QuaraExcludeInstanceIDsWithAppId | Array of InstanceIDWithAppIdItem | 隔离排除的主机 |
| QuaraClusterIDsWithAppId | Array of ClusterIDWithAppIdItem | 隔离直接选择的集群 |
| QuaraExcludeClusterIDsWithAppId | Array of ClusterIDWithAppIdItem | 隔离排除的集群 |
| Timeout | Integer | 超时时长(秒) 示例值:7200 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询
输入示例
POST / HTTP/1.1
Host: csip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMalwareTimingScanSetting
<公共请求参数>
{
"MemberId": [
"mem-tencent-e74488e0ba0cd8fe"
]
}
输出示例
{
"Response": {
"AssetSelectionType": "tag",
"AutoIsolation": 1,
"ClusterIDsWithAppId": [],
"CustomPaths": [
"/detect/path"
],
"Cycle": 1,
"DoClean": 0,
"EnableInspiredEngine": 0,
"EnableMemShellScan": 0,
"EnableScan": 1,
"EndTime": "17:40",
"EngineType": 3,
"ExcludeClusterIDsWithAppId": [],
"ExcludeInstanceIDsWithAppId": [],
"InstanceIDsWithAppId": [],
"KillProcess": 1,
"MonitorCustomPaths": [
"/detect/path"
],
"MonitoringPattern": 2,
"ProtectFileScope": 0,
"ProtectMode": 0,
"QuaraAssetSelectionType": "tag",
"QuaraClusterIDsWithAppId": [],
"QuaraExcludeClusterIDsWithAppId": [],
"QuaraExcludeInstanceIDsWithAppId": [],
"QuaraInstanceIDsWithAppId": [],
"QuaraTagIds": [
"1"
],
"RealTimeMonitoring": 1,
"ScanType": "include",
"StartTime": "00:00",
"TagIds": [
"1"
],
"Timeout": 7200,
"RequestId": "e6325de7-3b87-4a0d-b319-2b105839a60c"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| ResourceNotFound | 资源不存在。 |