1. 接口描述
接口请求域名： cwp.tencentcloudapi.com 。
同步基线检测进度概要
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：SyncBaselineDetectSummary。 |
| Version | 是 | String | 公共参数，本接口取值：2018-02-28。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| TaskIds.N | 否 | Array of Integer | 用于计算检测中和进度的任务ID集合，一般不用传入 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ProgressRate | Integer | 处理进度 |
| NotPassPolicyCount | Integer | 未通过策略总数 |
| HostCount | Integer | 主机总数 |
| StartTime | String | 开始时间 |
| EndTime | String | 结束时间 |
| WillFirstScan | Integer | 1:即将进行首次扫描 0:已经扫描过了 示例值：0 |
| DetectingTaskIds | Array of Integer | 正在检测的任务ID |
| LeftMins | Integer | 扫描中剩余时间(分钟) 示例值：1 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 同步检测概要
输入示例
POST / HTTP/1.1
Host: cwp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SyncBaselineDetectSummary
<公共请求参数>
{}输出示例
{
"Response": {
"DetectingTaskIds": [
2379
],
"EndTime": "",
"HostCount": 1,
"LeftMins": 3,
"NotPassPolicyCount": 19,
"ProgressRate": 20,
"RequestId": "69fce851-ee60-44ac-8ab1-62c2c7856051",
"StartTime": "2022-08-23 15:07:02",
"WillFirstScan": 0
}
}示例2 指定任务ID概要请求
指定任务ID概要请求
输入示例
POST / HTTP/1.1
Host: cwp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SyncBaselineDetectSummary
<公共请求参数>
{
"TaskIds": [
299,
298
]
}输出示例
{
"Response": {
"DetectingTaskIds": [],
"EndTime": "2023-12-25 12:05:27",
"HostCount": 31,
"LeftMins": 0,
"NotPassPolicyCount": 1,
"ProgressRate": 100,
"RequestId": "5f862bd8-6931-45ee-a5d9-0fe2c4ea30d7",
"StartTime": "2023-12-25 09:36:00",
"WillFirstScan": 0
}
}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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |