tencent cloud

APIs

DescribeLicenseGeneral

다운로드
포커스 모드
폰트 크기
마지막 업데이트 시간: 2026-06-18 16:07:31

1. API Description

Domain name for API request: cwp.intl.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 licenses (including unavailable licenses such as isolated and expired ones)

AvailableLicenseCnt Integer

Available licenses

AvailableProVersionLicenseCnt Integer

Number of available Pro Edition licenses (including postpaid licenses)

AvailableFlagshipVersionLicenseCnt Integer

Number of available Ultimate Edition licenses

NearExpiryLicenseCnt Integer

Number of licenses expiring within 15 days

ExpireLicenseCnt Integer

Number of expired licenses (excluding deleted records)

AutoOpenStatus Boolean

Automatic upgrade switch status. Default value: false. true: enabled; false: disabled.

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 licenses

NotExpiredLicenseCnt Integer

Number of unexpired licenses

FlagshipVersionLicenseCnt Integer

Total number of Ultimate Edition licenses (valid orders)

ProVersionLicenseCnt Integer

Total number of Pro Edition licenses (valid orders)

CwpVersionLicenseCnt Integer

Lightweight edition total number of licenses (valid order licenses count)

AvailableLHLicenseCnt Integer

Number of available Lightweight Edition licenses

AutoRepurchaseSwitch Boolean

Auto-purchase switch. true: enabled; false: disabled.

AutoRepurchaseRenewSwitch Boolean

Whether auto-purchase orders are automatically renewed. true: enabled; false: disabled.

DestroyOrderNum Integer

Number of terminated orders

RepurchaseRenewSwitch Boolean

Auto-renewal switch for auto-purchase. true: enabled; false: disabled.

AutoBindRaspSwitch Boolean

Whether to automatically bind RASP protection to newly added machines. false: disabled; true: enabled.

AutoOpenRaspSwitch Boolean

Whether to automatically enable RASP protection for newly added machines. false: disabled; true: enabled.

AutoDowngradeSwitch Boolean

Whether the auto-downgrade switch is enabled

AvailableAISecurityLicenseCnt Integer

Number of available AI Protection Edition licenses

AISecurityVersionLicenseCnt Integer

Total number of AI Protection Edition licenses

ApplicationAvailableLicenseCnt Integer

Number of available licenses after combining application protection licenses with Ultimate Edition licenses

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 Example

Example 1

Input Example

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

{}

Output Example

{
    "Response": {
        "AISecurityVersionLicenseCnt": 0,
        "ApplicationAvailableLicenseCnt": 0,
        "AutoBindRaspSwitch": false,
        "AutoDowngradeSwitch": false,
        "AutoOpenRaspSwitch": false,
        "AutoOpenStatus": false,
        "AutoRepurchaseRenewSwitch": false,
        "AutoRepurchaseSwitch": false,
        "AvailableAISecurityLicenseCnt": 0,
        "AvailableFlagshipVersionLicenseCnt": 0,
        "AvailableLHLicenseCnt": 0,
        "AvailableLicenseCnt": 0,
        "AvailableProVersionLicenseCnt": 0,
        "CwpVersionLicenseCnt": 0,
        "DestroyOrderNum": 1,
        "ExpireLicenseCnt": 10,
        "FlagshipVersionLicenseCnt": 0,
        "IsOpenStatusHistory": false,
        "LicenseCnt": 0,
        "NearExpiryLicenseCnt": 0,
        "NotExpiredLicenseCnt": 0,
        "ProVersionLicenseCnt": 0,
        "ProtectType": "FLAGSHIP_PREPAY",
        "RepurchaseRenewSwitch": false,
        "UsedLicenseCnt": 0,
        "RequestId": "98fd0d2c-c27c-43f3-8622-1b5fe386c5fa"
    }
}

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

도움말 및 지원

문제 해결에 도움이 되었나요?

피드백