1. 接口描述
接口请求域名: csip.tencentcloudapi.com 。
修改文件查杀定时扫描配置,包含扫描周期、检测模式、资产范围、引擎选择、隔离配置等
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ModifyMalwareTimingScanSettings。 |
| Version | 是 | String | 公共参数,本接口取值:2022-11-21。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| Cycle | 是 | Integer | 扫描周期 默认每天 1 示例值:1 |
| StartTime | 是 | String | 检测周期 开始时间,如:02:00:00 示例值:02:00:00 |
| EndTime | 是 | String | 检测周期 超时结束时间,如:04:00:00 示例值:04:00:00 |
| MemberId.N | 否 | Array of String | 集团账号的成员id 示例值:["mem-tencent-e74488e0ba0cd8fe"] |
| EnableScan | 否 | Integer | 定时检测开关 0 关闭 1开启 示例值:1 |
| ScanType | 否 | String | 检测模式:full/quick/include/exclude 示例值:include |
| CustomPaths.N | 否 | Array of String | 自选路径列表(ScanType=include/exclude时必填,最多100条) 示例值:["/detect/path"] |
| AssetSelectionType | 否 | String | 资产选择方式:all/tag/direct 示例值:tag |
| TagIds.N | 否 | Array of String | 按标签选择时的标签ID数组 示例值:["1"] |
| InstanceIDsWithAppId.N | 否 | Array of InstanceIDWithAppIdItem | 直接选择的主机列表 |
| ExcludeInstanceIDsWithAppId.N | 否 | Array of InstanceIDWithAppIdItem | 排除的主机列表 |
| ClusterIDsWithAppId.N | 否 | Array of ClusterIDWithAppIdItem | 直接选择的集群列表 |
| ExcludeClusterIDsWithAppId.N | 否 | Array of ClusterIDWithAppIdItem | 排除的集群列表 |
| RealTimeMonitoring | 否 | Integer | 实时监控 0 关闭 1开启 示例值:1 |
| MonitoringPattern | 否 | Integer | 监控模式 0 标准 1深度 示例值:2 |
| MonitorCustomPaths.N | 否 | Array of String | 实时监控自定义路径列表(MonitoringPattern=2或3时必填,最多100条) 示例值:["/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 | 1 清理, 0 不清理本操作会修复被篡改的系统命令,计划任务等系统文件,操作中请确保yum/apt 可用 示例值:0 |
| ProtectMode | 否 | Integer | 防护模式 0 标准 1重保 示例值:0 |
| ProtectFileScope | 否 | Integer | 查杀范围 0 脚本类之外的恶意文件,1全部恶意文件 示例值:0 |
| QuaraAssetSelectionType | 否 | String | 隔离资产选择:all/tag/direct 示例值:tag |
| QuaraTagIds.N | 否 | Array of String | 隔离按标签选择时的tagId数组 示例值:["1"] |
| QuaraInstanceIDsWithAppId.N | 否 | Array of InstanceIDWithAppIdItem | 隔离直接选择的主机 |
| QuaraExcludeInstanceIDsWithAppId.N | 否 | Array of InstanceIDWithAppIdItem | 隔离排除的主机 |
| QuaraClusterIDsWithAppId.N | 否 | Array of ClusterIDWithAppIdItem | 隔离直接选择的集群 |
| QuaraExcludeClusterIDsWithAppId.N | 否 | Array of ClusterIDWithAppIdItem | 隔离排除的集群 |
| Timeout | 否 | Integer | 超时时长(秒) 示例值:7200 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改
输入示例
POST / HTTP/1.1
Host: csip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyMalwareTimingScanSettings
<公共请求参数>
{
"Cycle": 1,
"StartTime": "02:00:00",
"EndTime": "04:00:00",
"MemberId": [
"mem-tencent-e74488e0ba0cd8fe"
],
"EnableScan": 1,
"ScanType": "include",
"CustomPaths": [
"/detect/path"
],
"AssetSelectionType": "tag",
"TagIds": [
"1"
],
"RealTimeMonitoring": 1,
"MonitoringPattern": 2,
"MonitorCustomPaths": [
"/detect/path"
],
"EngineType": 3,
"EnableInspiredEngine": 0,
"EnableMemShellScan": 0,
"AutoIsolation": 1,
"KillProcess": 1,
"DoClean": 0,
"ProtectMode": 0,
"ProtectFileScope": 0,
"QuaraAssetSelectionType": "tag",
"QuaraTagIds": [
"1"
],
"Timeout": 7200
}
输出示例
{
"Response": {
"RequestId": "e49147da-7200-439c-a3d2-b76972ca7df4"
}
}
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 | 资源不存在。 |