帮你快速理解、总结文档立即下载
文档中心>云安全中心>API 文档>告警中心相关接口>CSIP 手动扫描进度查询接口

CSIP 手动扫描进度查询接口

最近更新时间：2026-08-14 01:23:57
我的收藏

本页目录：

1. 接口描述

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

CSIP 手动扫描进度查询接口

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeCSIPMalwareScanTaskProgress。
Version 是 String 公共参数，本接口取值：2022-11-21。
Region 否 String 公共参数，此参数为可选参数。
MemberId.N 否 Array of String

集团账号的成员id


示例值：["mem-tencent-e74488e0ba0cd8fe"]
TaskId 否 Integer

任务ID


示例值：3086642

3. 输出参数

参数名称 类型 描述
TaskId Integer

任务ID


示例值：3086642
Status Integer

任务整体状态枚举值：0： NeverScanned1： Scanning2： Finished3： Stopping4： Stopped


示例值：4
Schedule Integer

进度百分比 0~100（公式：20 + 80 × finished/total，含运行中机器时强制 ≤ 99；Status=Stopped 时强制 100）


示例值：100
TotalCount Integer

子表机器总数


示例值：21
FinishedCount Integer

进入终态的机器数（含 Terminating(6) / Terminated(7)）


示例值：21
RiskCount Integer

累计风险告警数（来自主表 total_risk_count）


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

4. 示例

示例1 查看扫描进度

输入示例

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

{
    "TaskId": 3069421
}

输出示例

{
    "Response": {
        "FinishedCount": 1,
        "RiskCount": 0,
        "Schedule": 100,
        "Status": 4,
        "TaskId": 3069421,
        "TotalCount": 1,
        "RequestId": "db69f94c-8193-46b8-bb3c-542ac46358a4"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
中国站