1. 接口描述
接口请求域名: csip.tencentcloudapi.com 。
查询扫描任务详情。Filter.Filters支持Name:Status(资产扫描状态,OperatorType=7 IN匹配,取值WAIT/SCANNING/FINISHED/FAILED)。
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeEDRScanTaskDetail。 |
| Version | 是 | String | 公共参数,本接口取值:2022-11-21。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| TaskId | 是 | Integer | 任务ID 示例值:4 |
| MemberId.N | 否 | Array of String | 集团账号的成员id 示例值:["mem-tencent-54213b157ddf7170"] |
| Filter | 否 | Filter | 通用查询参数(含Filters/Limit/Offset) |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskId | Integer | 任务ID 示例值:4 |
| TaskName | String | 任务名称 示例值:Malware_20260707_151616 |
| Status | String | 整体状态:WAIT/SCANNING/FINISHED/FAILED/CANCELED/TERMINATED/TIMEOUT 示例值:SCANNING |
| TaskType | String | 任务类型:HOST/CONTAINER 示例值:HOST |
| TriggerType | String | 触发方式:MANUAL/CYCLE 示例值:MANUAL |
| StartTime | String | 任务开始时间 示例值:2026-07-07 15:16:17 |
| EndTime | String | 任务结束时间 示例值:2026-07-08 12:16:00 |
| ScanType | String | 检测模式:full/quick/include/exclude 示例值:full |
| CustomPaths | Array of String | 自选路径列表 注意:此字段可能返回 null,表示取不到有效值。 示例值:["/home/ubuntu/.openclaw/workspace/AgentSecEval/dataset/malicious_samples"] |
| Timeout | Integer | 超时时间(秒) 示例值:3600 |
| EnableMemShellScan | Integer | 是否开启深度检测:0-否/1-是 示例值:0 |
| CreateAppID | Integer | 创建者账号AppId 示例值:260199982 |
| AccountName | String | 任务创建者账号名称(后端富化) 示例值:委派管理员1 |
| CloudType | Integer | 创建者云类型 示例值:0 |
| TotalAssetCount | Integer | 任务总资产数 示例值:7 |
| FinishedAssetCount | Integer | 已完成资产数 示例值:7 |
| RiskAssetCount | Integer | 风险资产数 示例值:0 |
| HostList | Array of EDRScanTaskHostItem | 主机资产列表(TaskType=HOST时有值) 注意:此字段可能返回 null,表示取不到有效值。 |
| ContainerList | Array of EDRScanTaskContainerItem | 容器资产列表(TaskType=CONTAINER时有值) 注意:此字段可能返回 null,表示取不到有效值。 |
| TotalCount | Integer | 当前筛选条件下资产列表总条数 示例值:7 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询TaskId为4的扫描任务详情
输入示例
POST / HTTP/1.1
Host: csip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeEDRScanTaskDetail
<公共请求参数>
{
"TaskId": 4,
"MemberId": [
"mem-tencent-54213b157ddf7170"
],
"Filter": {
"Limit": 20,
"Offset": 0,
"Filters": []
}
}
输出示例
{
"Response": {
"AccountName": "委派管理员1",
"CloudType": 0,
"ContainerList": null,
"CreateAppID": 260199982,
"CustomPaths": null,
"EnableMemShellScan": 0,
"EndTime": "",
"FinishedAssetCount": 7,
"HostList": [
{
"AccountName": "成员2",
"AppId": 260082268,
"CloudType": 0,
"FailReason": "scan timeout",
"FixSuggestion": "",
"HostName": "1f665110",
"InstanceId": "mix-qgbtrzf3",
"OsType": "Ubuntu 24.04.4 LTS",
"PrivateIp": "169.254.68.6",
"PublicIp": "",
"Quuid": "1f665110-706a-4f2c-bef7-9b0f15827419",
"RiskCount": 0,
"Status": "TIMEOUT"
}
],
"RiskAssetCount": 0,
"ScanType": "full",
"StartTime": "2026-07-07 15:16:17",
"Status": "SCANNING",
"TaskId": 4,
"TaskName": "Malware_20260707_151616",
"TaskType": "HOST",
"Timeout": 3600,
"TotalAssetCount": 7,
"TotalCount": 7,
"TriggerType": "MANUAL",
"RequestId": "d2d353f4-6404-41bc-9c27-fbd351548f93"
}
}
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 | 资源不存在。 |