cwp — Cloud Workload Protection
cwp · 2018-02-28
DescribeLicenseGeneral
POST
Obtain the authorization overview information.
Wire call
Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /cwp/DescribeLicenseGeneral path used in the OpenAPI document is a documentation convenience so each action is addressable; it is not a route on the server.
curl
curl -sS https://cwp.api3.convergecloud.com/ \
-H 'Authorization: TC3-HMAC-SHA256 Credential=<SecretId>/<YYYY-MM-DD>/cwp/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=<sig>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'Host: cwp.api3.convergecloud.com' \
-H 'X-TC-Action: DescribeLicenseGeneral' \
-H 'X-TC-Version: 2018-02-28' \
-H 'X-TC-Timestamp: <unix-seconds>' \
-H 'X-TC-Region: luzon' \
-d '{}'Request parameters
This action takes no parameters.
Response
Fields are returned inside the Response envelope. Converge Cloud answers HTTP 200 for errors as well as successes, so read Response.Error rather than the status code — and test for the presence of that object, because Code is occasionally the empty string.
| Field | Type | Description |
|---|---|---|
| LicenseCnt | integer | Total number of authorizations (including those that are isolated, expired, and in other states) |
| AvailableLicenseCnt | integer | Number of available authorizations |
| AvailableProVersionLicenseCnt | integer | Number of available Professional Edition authorizations (including those in postpaid mode) |
| AvailableFlagshipVersionLicenseCnt | integer | Number of available Ultimate Edition authorizations |
| NearExpiryLicenseCnt | integer | Number of authorizations about to expire (no more than 15 days left) |
| ExpireLicenseCnt | integer | Number of expired authorizations (excluding deleted ones) |
| AutoOpenStatus | boolean | Automatic upgrade enabling status. True: enabled; false: disabled. Default value: false. |
| ProtectType | string | PROVERSION_POSTPAY: Pro Edition - postpaid; PROVERSION_PREPAY: Pro edition - prepaid; FLAGSHIP_PREPAY: Ultimate Edition - prepaid. |
| IsOpenStatusHistory | boolean | Whether automatic upgrade has been enabled before |
| UsedLicenseCnt | integer | Number of used authorizations |
| NotExpiredLicenseCnt | integer | Number of authorizations that have not expired |
| FlagshipVersionLicenseCnt | integer | Total number of Ultimate Edition authorizations (valid orders) |
| ProVersionLicenseCnt | integer | Total number of Pro Edition authorizations (valid orders) |
| CwpVersionLicenseCnt | integer | Total number of Inclusive Edition authorizations (those of valid orders) |
| AvailableLHLicenseCnt | integer | Number of available Inclusive Edition authorizations |
| AutoRepurchaseSwitch | boolean | Auto-purchase switch, true for ON, false for OFF |
| AutoRepurchaseRenewSwitch | boolean | Is auto-renewal required for auto-purchase orders, true for ON, false for OFF |
| DestroyOrderNum | integer | Number of terminated orders |
| RepurchaseRenewSwitch | boolean | Whether automatic renewal is enabled. True: enabled; false: disabled. |
| RequestId | string | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
Success
{
"Response": {
"LicenseCnt": …,
"AvailableLicenseCnt": …,
"RequestId": "…"
}
}Error
{
"Response": {
"Error": { "Code": "…", "Message": "…" },
"RequestId": "…"
}
}Try it
CredentialThe key never leaves this tab — it signs the request here. The signed request goes to /api-relay/cwp.
Request bodyvalid JSONPOST cwp.api3.convergecloud.com · DescribeLicenseGeneral
Read-only. Creates nothing.
Recorded example response
{
"AutoOpenStatus": false,
"AutoRepurchaseRenewSwitch": false,
"AutoRepurchaseSwitch": false,
"AvailableFlagshipVersionLicenseCnt": 0,
"AvailableLHLicenseCnt": 0,
"AvailableLicenseCnt": 0,
"AvailableProVersionLicenseCnt": 0,
"CwpVersionLicenseCnt": 0,
"DestroyOrderNum": 0,
"ExpireLicenseCnt": 0,
"FlagshipVersionLicenseCnt": 0,
"IsOpenStatusHistory": false,
"LicenseCnt": 0,
"NearExpiryLicenseCnt": 0,
"NotExpiredLicenseCnt": 0,
"ProVersionLicenseCnt": 0,
"ProtectType": "FLAGSHIP_POSTPAY",
"RepurchaseRenewSwitch": false,
"UsedLicenseCnt": 0
}