tencent cloud

容器安全服务

DescribePurchaseStateInfo

下载
聚焦模式
字号
最后更新时间: 2026-06-10 17:07:12

1. API Description

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

This API is used to check whether TCSS is purchased.

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 Valid values: 0 (available for trial and purchase); 1 (available for purchase only after failed trial review or trial expiration); 2 (trial effective); 3 (Pro Edition effective); 4 (Pro Edition expired).
AllCoresCnt Integer
CoresCnt Integer Total number of protected cores. It is the sum of the number of purchased cores, the number of free trial cores, and the number of elastic billing cores.
UndefendCoresCnt Integer
AuthorizedCoresCnt Integer Number of purchased cores
GivenAuthorizedCoresCnt Integer Number of free trial cores for Pro Edition.
CurrentFlexibleCoresCnt Integer
ImageCnt Integer Image count
AuthorizedImageCnt Integer Number of licensed images
ExpirationTime String Expiration time
PurchasedAuthorizedCnt Integer Number of purchased image licenses
AutomaticRenewal Integer 0 indicates the default status (it has not been set by the user, namely the initial status); 1 indicates automatic renewal; 2 indicates explicit non-automatic renewal (it has been set by the user).
GivenAuthorizedCnt Integer Complimentary image licenses during the trial period may expire.
BeginTime String Start time.
SubState String Substatus (specific meaning depending on the State field)
Valid values when State is 4: ISOLATE, TERMINATED.
InquireKey String Billing key.
DefendPolicy String
FlexibleCoresLimit Integer
DefendClusterCoresCnt Integer
DefendHostCoresCnt Integer
TrialCoresCnt Integer Number of trial cores for Pro Edition.
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 An internal error occurred.
InternalError.ErrRoleNotExist The user is unauthorized.
InternalError.MainDBFail The database operation failed.
InvalidParameter The parameter is incorrect.

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈