Tenant Cloud
Security
Cloud Workload Protection Platform
Baseline Management APIs (New)
SyncBaselineDetectSummary
1. Interface Description
Interface request domain name: cwp.api3.convergecloud.com.
API for synchronizing the summary information about the baseline check progress
Default interface request rate limit: 20 times per second.
Interface update time: 2022-08-23 15:34:11.
The interface is both signature verification and authentication.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: SyncBaselineDetectSummary |
| Version | Yes | No | String | Public parameter, The value of this interface: 2018-02-28 |
| Region | No | No | String | Public parameter,Regional information This interface does not need to pass this parameter. |
| TaskIds | No | No | Array of Uint64 | IDs for calculating the progress of ongoing check tasks. Generally, this parameter is not required. Example: [1024] |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| DetectingTaskIds | Array of Int64 | IDs of the running check tasks. Example: [1002] |
| EndTime | String | End time. Example: 2020-11-21 15:16:00 |
| HostCount | Int64 | Total number of hosts. Example: 0 |
| LeftMins | Int64 | Remaining time for the scan. Unit: minutes. Example: 1 |
| NotPassPolicyCount | Int64 | Total number of policies against which the check failed. Example: 0 |
| ProgressRate | Int64 | Handling progress. Example: 70 |
| StartTime | String | Start time. Example: 2020-11-21 15:16:00 |
| WillFirstScan | Int64 | 1: about to perform the first scan. 0: has been scanned. Example: 0 |
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| InternalError | Internal error. |
| FailedOperation | Operation failed. |