1. Interface Description
Interface request domain name: cwp.api3.convergecloud.com.
The CreateLicenseOrder API can create Professional/Premium Edition orders.
Supports prepaid and postpaid creation.
Postpaid orders are created directly.
Prepaid orders are placed without payment, requiring calling the billing payment API to pay.
Default interface request rate limit: 20 times per second.
Interface update time: 2022-12-12 15:20:33.
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: CreateLicenseOrder |
| 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. |
| AutoProtectOpenConfig | No | No | String | This field is deprecated. Example: "no config" |
| AutoRenewFlag | No | No | Bool | Specifies whether to enable auto-renewal. By default, auto-renewal is not enabled. This parameter takes effect only when the billing method is monthly subscription. Example: false |
| BillingDefineParams | No | No | BillingDefineParams | Business Custom Parameters Example:View |
| LicenseNum | No | No | Uint64 | Number of licenses that you want to purchase. Default value: 1. Example: 1 |
| LicenseType | No | No | Uint64 | License type. 0: Pro Edition license; 5: Ultimate Edition license. Example: 0 |
| ModifyConfig | No | No | OrderModifyObject | Configuration Parameters Example:View |
| ProjectId | No | No | Uint64 | Project ID. Default value: 0. Example: 0 |
| RegionId | No | No | Uint64 | Code of the region that applies the billing price. Example: 1 |
| Tags | No | No | Array of Tags | Tags. If this parameter is left empty, no tags need to be attached. Example:View |
| TimeSpan | No | No | Uint64 | Unused field. Example: 1 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| BigDealId | String | Parent order ID. The value of this parameter is an empty string for postpaid orders. Example: order-vmqkfmayay |
| DealNames | Array of String | Order list. Example: ["cwp-313dfay*", "cwp-vi4d8ay*"] |
| ResourceIds | Array of String | Resource IDs. The value of this parameter is an empty string for prepaid orders. Example: ["cwp-313dfay*", "cwp-vi4d8ay*"] |
| 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. |
| InvalidParameter | Invalid parameter. |
| OperationDenied | Operation denied. |
| InvalidParameterValue | The parameter value is invalid. |
| FailedOperation | Operation failed. |