1. Interface Description
Interface request domain name: cwp.api3.convergecloud.com.
API for starting to scan asset fingerprints
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: ScanAsset |
| 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. |
| AssetTypeIds | No | No | Array of Uint64 | IDs of the asset fingerprint types. Example: [102] |
| Quuids | No | No | Array of String | List of QUUIDs. Example: ["5a540076-d38a-4078-aa98-q45rt371d322"] |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| TaskId | Uint64 | Task ID. Example: 1 |
| 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.ParsingError | Parameter parsing error. |
| InvalidParameter.MissingParameter | Missing parameter. |
| InvalidParameter.InvalidFormat | Incorrect parameter format. |
| ResourceNotFound | The resource does not exist. |
| InvalidParameter.IllegalRequest | Invalid request. |
| InternalError.MainDBFail | Failed to operate data. |
| FailedOperation.NoProfessionHost | No servers with CWP Pro exist. |
| OperationDenied | Operation denied. |
| FailedOperation | Operation failed. |