1. 接口描述
接口请求域名: csip.tencentcloudapi.com 。
点击开始扫描后触发,支持多账号、多资产类型。同时选主机和容器集群时拆分为两个独立任务(主机+容器)。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateEDRManualScan。 |
| Version | 是 | String | 公共参数,本接口取值:2022-11-21。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| AssetSelectionType | 是 | String | 资产选择方式:all-全部资产/tag-按标签选择(仅主机)/direct-直接选择 示例值:tag |
| ScanType | 是 | String | 检测模式:full-全盘检测/quick-快速检测/include-仅检测指定路径/exclude-排除指定路径 示例值:include |
| MemberId.N | 否 | Array of String | 集团账号的成员id 示例值:["mem-tencent-54213b157ddf7170"] |
| InstanceIDsWithAppId.N | 否 | Array of InstanceIDWithAppIdItem | 直接选择的主机列表(AssetSelectionType=direct或all时使用) |
| ExcludeInstanceIDsWithAppId.N | 否 | Array of InstanceIDWithAppIdItem | 剔除的主机列表(AssetSelectionType=all时使用) |
| TagIds.N | 否 | Array of Integer | 主机对应的标签ID 示例值:[139] |
| ClusterIDsWithAppId.N | 否 | Array of ClusterWithAppIdItem | 直接选择的集群列表 |
| ExcludeClusterIDsWithAppId.N | 否 | Array of ClusterWithAppIdItem | 剔除的集群列表(AssetSelectionType=all时使用) |
| CustomPaths.N | 否 | Array of String | 自选路径列表(ScanType=include或exclude时必填,最多100条) 示例值:["/tmp"] |
| Timeout | 否 | Integer | 超时时间(秒),上限7200 示例值:1800 |
| EnableMemShellScan | 否 | Integer | 是否开启深度检测:0-否/1-是 示例值:0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Tasks | Array of CreatedTaskItem | 创建的任务列表(主机和容器分别一条) |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 tag模式创建任务
输入示例
POST / HTTP/1.1
Host: csip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateEDRManualScan
<公共请求参数>
{
"AssetSelectionType": "tag",
"ScanType": "include",
"MemberId": [
"mem-tencent-54213b157ddf7170"
],
"TagIds": [
139
],
"CustomPaths": [
"/tmp"
],
"Timeout": 1800,
"EnableMemShellScan": 0
}
输出示例
{
"Response": {
"Tasks": [
{
"AppId": 260199972,
"TaskId": 304,
"TaskType": "HOST"
}
],
"RequestId": "00dc20af-e070-4c80-b24c-becae48e73cb"
}
}
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 | 资源不存在。 |