1. Interface Description
Interface request domain name: cwp.api3.convergecloud.com.
This API is used to unbind a license from one or more servers in the Settings Center > License Management module.
Default interface request rate limit: 20 times per second.
Interface update time: 2022-05-27 11:43:31.
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: ModifyLicenseUnBinds |
| 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. |
| IsAll | No | No | Bool | Specifies whether to specify all servers. If the total number of servers exceeds the number of licenses available for the current order, the excess servers will be skipped. Example: true |
| IsShrink | No | No | Bool | Specifies whether to enable automatic scale-in. If the remaining number of licenses is 1, this API terminates the order. Example: false |
| LicenseType | Yes | No | Uint64 | License type. 0: Pro Edition license; 5: Ultimate Edition license. Example: 0 |
| QuuidList | No | No | Array of String | QUUIDs of the servers to which you want to unbind licenses. This parameter is required when the IsAll parameter is set to false. If the IsAll parameter is not set to false, ignore this parameter. The maximum length of this parameter is 100 bytes. Example: ["4c4c4544-0053-4d10-8052-c4c04f53ayay"] |
| ResourceId | Yes | No | String | Resource ID. Example: cwplic-92c9ayay |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| ErrMsg | Array of LicenseUnBindRsp | This value is returned only for unbinding failures. Example:View |
| 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. |
| FailedOperation | Operation failed. |