tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeLicenseGeneral

Last updated: 2024-08-27 11:38:25

1. API Description

Domain name for API request: cwp.tencentcloudapi.com.

This API is used to obtain the authorization overview information.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeLicenseGeneral.
Version Yes String Common Params. The value used for this API: 2018-02-28.
Region No String Common Params. This parameter is not required.

3. Output Parameters

Parameter Name 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.

4. Example

Example1 Querying Information of Authorization Overview

Input Example

POST / HTTP/1.1
Host: cwp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLicenseGeneral
<Common request parameters>

{}

Output Example

{
    "Response": {
        "AutoOpenStatus": true,
        "AvailableFlagshipVersionLicenseCnt": 1,
        "AvailableLHLicenseCnt": 0,
        "AvailableLicenseCnt": 3,
        "AvailableProVersionLicenseCnt": 2,
        "CwpVersionLicenseCnt": 0,
        "ExpireLicenseCnt": 0,
        "FlagshipVersionLicenseCnt": 1,
        "IsOpenStatusHistory": true,
        "LicenseCnt": 3,
        "NearExpiryLicenseCnt": 0,
        "NotExpiredLicenseCnt": 3,
        "ProVersionLicenseCnt": 2,
        "ProtectType": "FLAGSHIP_PREPAY",
        "RequestId": "d9a5456b-a2db-4106-bd12-32e2c735435d",
        "UsedLicenseCnt": 0,
        "AutoRepurchaseSwitch": false,
        "AutoRepurchaseRenewSwitch": false,
        "DestroyOrderNum": 0,
        "RepurchaseRenewSwitch": false
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalError Internal error
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy