tencent cloud

APIs

DescribePurchaseStateInfo

ダウンロード
フォーカスモード
フォントサイズ
最終更新日: 2026-10-13 20:11:35

1. API Description

Domain name for API request: tcss.intl.tencentcloudapi.com.

This API is used to query the purchase information on the container security service.

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: DescribePurchaseStateInfo.
Version Yes String Common Params. The value used for this API: 2020-11-01.
Region No String Common Params. This parameter is not required.

3. Output Parameters

Parameter Name Type Description
State Integer

0: available for trial application and purchase; 1: purchase only (including failed trial review and expired trial); 2: trial active; 3: Pro Edition active; 4: Pro Edition expired

AllCoresCnt Integer

Total resource cores = total protected cores + unprotected cores

CoresCnt Integer

Total protected cores = purchased cores + trial granted cores + elastic billing cores

UndefendCoresCnt Integer

Unprotected cores (number of resource cores with protection not enabled)

AuthorizedCoresCnt Integer

Number of purchased cores

GivenAuthorizedCoresCnt Integer

Trial giveaway of Pro Edition cores

CurrentFlexibleCoresCnt Integer

Current number of elastic billing cores

ImageCnt Integer

Number of images.

AuthorizedImageCnt Integer

Number of licensed images

ExpirationTime String

Expiration time.

PurchasedAuthorizedCnt Integer

Number of purchased image licenses

AutomaticRenewal Integer

0 indicates the default state (not set by the user, i.e., the initial state), 1 indicates auto-renewal, and 2 indicates explicitly no auto-renewal (set by the user).

GivenAuthorizedCnt Integer

Complimentary image licenses during the trial period may expire.

BeginTime String

Start time

SubState String

Sub-status (specific meaning depending on the State field)
When State is 4, valid values: ISOLATE (isolated) DESTROED (terminated)

InquireKey String

Billing key

DefendPolicy String

Protection policy

FlexibleCoresLimit Integer

Upper limit of elastic billing cores

DefendClusterCoresCnt Integer

Number of cores in the protected cluster

DefendHostCoresCnt Integer

Protected host cores

TrialCoresCnt Integer

Number of cores of the Pro Edition for trial use

NoContainerCoresCnt Integer

Number of machines with zero protection containers.

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 the Purchase Information on TCSS

Input Example

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

{}

Output Example

{
    "Response": {
        "AllCoresCnt": 154,
        "AuthorizedCoresCnt": 147,
        "AuthorizedImageCnt": 287756,
        "AutomaticRenewal": 194,
        "BeginTime": "2024-09-24 13:01:18",
        "CoresCnt": 68,
        "CurrentFlexibleCoresCnt": 0,
        "DefendClusterCoresCnt": 48,
        "DefendHostCoresCnt": 20,
        "DefendPolicy": "Part",
        "ExpirationTime": "2024-12-24 13:01:18",
        "FlexibleCoresLimit": 5000,
        "GivenAuthorizedCnt": 0,
        "GivenAuthorizedCoresCnt": 0,
        "ImageCnt": 291209,
        "InquireKey": "sv_yunjing_css_pem",
        "PurchasedAuthorizedCnt": 300000,
        "RequestId": "e40cad09-f295-42a8-914d-ea84767fb6f1",
        "State": 3,
        "SubState": "NORMAL",
        "UndefendCoresCnt": 86,
        "TrialCoresCnt": 0
    }
}

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.
InternalError.ErrRoleNotExist User not authorized.
InternalError.MainDBFail Database operation failed.
InvalidParameter Parameter error.

ヘルプとサポート

この記事はお役に立ちましたか?

フィードバック