1. 接口描述
接口请求域名: cwp.api3.fincloud.tencent.cn。
同步基线检测进度概要
默认接口请求频率限制:20次/秒。
接口更新时间:2022-08-23 15:34:11。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:SyncBaselineDetectSummary |
| Version | 是 | 否 | String | 公共参数,本接口取值:2018-02-28 |
| Region | 是 | 否 | String | 公共参数,地域信息本接口不需要传递此参数。 |
| TaskIds | 否 | 否 | Array of Uint64 | 用于计算检测中和进度的任务ID集合,一般不用传入 示例值: [1024] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| DetectingTaskIds | Array of Int64 | 正在检测的任务ID 示例值: [1002] |
| EndTime | String | 结束时间 示例值: 2020-11-21 15:16:00 |
| HostCount | Int64 | 主机总数 示例值: 0 |
| LeftMins | Int64 | 扫描中剩余时间(分钟) 示例值: 1 |
| NotPassPolicyCount | Int64 | 未通过策略总数 示例值: 0 |
| ProgressRate | Int64 | 处理进度 示例值: 70 |
| StartTime | String | 开始时间 示例值: 2020-11-21 15:16:00 |
| WillFirstScan | Int64 | 1:即将进行首次扫描 0:已经扫描过了 示例值: 0 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| FailedOperation | 操作失败。 |
5. 示例
示例1 同步检测概要
输入示例
POST / HTTP/1.1
Host: cwp.api3.fincloud.tencent.cn
Content-Type: application/json
X-TC-Action: SyncBaselineDetectSummary
<Public request parameters>
{}
输出示例
{
"Response": {
"DetectingTaskIds": [
2379
],
"EndTime": "2020-11-21 15:16:00",
"HostCount": 1,
"LeftMins": 3,
"NotPassPolicyCount": 19,
"ProgressRate": 20,
"RequestId": "69fce851-ee60-44ac-8ab1-62c2c7856051",
"StartTime": "2022-08-23 15:07:02",
"WillFirstScan": 0
}
}