1. Interface Description
Interface request domain name: cwp.api3.convergecloud.com.
This API is used to issue a login license.
Default interface request rate limit: 20 times per second.
Interface update time: 0001-01-01 00:00:00.
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: CreateLoginPermissionPush |
| 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. |
| InstanceId | No | No | String | Fill in at least one of the host instance ID and UUID. Example: inst-anyinst |
| MemberId | No | No | Array of String | Group Account Member ID Example: [{"mem-6wfo0fzks3","mem-85fo0fzks4"}] |
| NonceData | Yes | No | String | Random login code. Example: 8095 |
| Uuid | No | No | String | Fill in at least one of the host instance ID and UUID. Example: 5a540076-d38a-4078-aa98-qwert371d322 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| ResultCode | Int64 | 0: Successful. 1: Failed: No login permissions. 2: Failed: Agent not installed. 3: Failed: Agent offline. 4: Failed: Sending timed out. Please retry. 5: Failed: Unknown error. Example: 0 |
| ResultMessage | String | Reason for an issuance failure. Example: Exception Information |
| 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. |
| MissingParameter | Missing parameter. |
| ResourceNotFound | The resource does not exist. |
| InvalidParameter | Invalid parameter. |
| OperationDenied | Operation denied. |
| InvalidParameterValue | The parameter value is invalid. |