1. Interface Description
Interface request domain name: cwp.api3.convergecloud.com.
API for synchronizing asset scan information
Default interface request rate limit: 20 times per second.
Interface update time: 2022-09-28 15:55:30.
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: SyncAssetScan |
| 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. |
| Sync | Yes | No | Bool | Specifies whether to enable synchronization. Valid values: true and false. Default value: false. Example: true |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| LatestEndTime | String | Latest synchronization end time. Example: 2021-01-01 11:22:11 |
| LatestStartTime | String | Latest synchronization start time. Example: 2021-01-01 11:22:11 |
| State | String | The enumeration values are (uppercase): NOTASK (no synchronization task), SYNCING (synchronization in progress), FINISHED (synchronization completed). Example: NOTASK |
| TaskId | Uint64 | The task ID. Example: 88 |
| 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. |
| InvalidParameter.MissingParameter | Missing parameter. |
| ResourceNotFound | The resource does not exist. |
| InvalidParameter.IllegalRequest | Invalid request. |
| InternalError.MainDBFail | Failed to operate data. |
| FailedOperation.APIServerFail | Failed to call the API service. |
| FailedOperation | Operation failed. |