Tenant Cloud
Security
Cloud Workload Protection Platform
Settings Center APIs
DescribeLicenseGeneral
1. Interface Description
Interface request domain name: cwp.api3.convergecloud.com.
This API is used to query the license overview information in the license management module.
Default interface request rate limit: 20 times per second.
Interface update time: 2022-12-12 15:17:14.
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: DescribeLicenseGeneral |
| 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. |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| AutoOpenStatus | Bool | Indicates whether automatic upgrade is enabled. true: enabled. false: disabled. Default value: false. Example: false |
| AutoRepurchaseRenewSwitch | Bool | Is auto-renewal required for auto-purchase orders, true for ON, false for OFF Example: false |
| AutoRepurchaseSwitch | Bool | Auto-purchase switch, true for ON, false for OFF Example: false |
| AvailableFlagshipVersionLicenseCnt | Uint64 | Number of available CWP Ultimate licenses. Example: 1 |
| AvailableLHLicenseCnt | Uint64 | Number available CWP General licenses. Example: 0 |
| AvailableLicenseCnt | Uint64 | Number of available licenses. Example: 3 |
| AvailableProVersionLicenseCnt | Uint64 | Number of available CWP Pro licenses, including those billed based on a pay-as-you-go basis. Example: 2 |
| CwpVersionLicenseCnt | Uint64 | Total number of CWP General licenses purchased through valid orders. Example: 0 |
| DestroyOrderNum | Uint64 | Number of terminated orders Example: 0 |
| ExpireLicenseCnt | Uint64 | Number of expired licenses, excluding deleted licenses. Example: 0 |
| FlagshipVersionLicenseCnt | Uint64 | Total number of CWP Ultimate licenses purchased through valid orders. Example: 1 |
| IsOpenStatusHistory | Bool | Indicates whether automatic upgrade has been enabled. Example: false |
| LicenseCnt | Uint64 | Total number of licenses, including isolated licenses, expired licenses, and licenses in other unavailable states. Example: 3 |
| NearExpiryLicenseCnt | Uint64 | Number of licenses that will expire within 15 days. Example: 0 |
| NotExpiredLicenseCnt | Uint64 | Number of licenses that have not expired. Example: 3 |
| ProVersionLicenseCnt | Uint64 | Total number of CWP Pro licenses purchased through valid orders. Example: 2 |
| ProtectType | String | PROVERSION_POSTPAY: CWP Pro (pay-as-you-go). PROVERSION_PREPAY: CWP Pro (monthly subscription). FLAGSHIP_PREPAY: CWP Ultimate (monthly subscription). Example: PROVERSION_POSTPAY |
| RepurchaseRenewSwitch | Bool | Whether automatic renewal is enabled for additional purchase. true: enabled; false: disabled. Example: false |
| UsedLicenseCnt | Uint64 | Number of used licenses. Example: 0 |
| 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. |