tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

DescribeLicenseList

最后更新时间：2024-08-27 11:38:24

1. API Description

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

This API is used to obtain all authorization orders of a user.

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: DescribeLicenseList.
Version Yes String Common Params. The value used for this API: 2018-02-28.
Region No String Common Params. This parameter is not required.
Filters.N No Array of Filters Take the intersection when filtering with multiple conditions.
  • LicenseStatus authorization status information: 0 - not used; 1 - partially used; 2 - used up; 3 - unavailable; 4 - available
  • BuyTime: time of purchase
  • LicenseType authorization type. 0: Pro Edition-pay-as-you-go; 1: Pro Edition-monthly subscription; 2: Ultimate Edition-monthly subscription
  • DeadlineStatus expiration status: NotExpired -not expired; expire - expired (including terminated); nearexpiry - about to expire
  • ResourceId resource ID
  • Keywords IP filtering
  • PayMode payment mode. 0: pay-as-you-go; 1: monthly subscription
  • OrderStatus order status. 1: normal; 2: isolated; 3: terminated
  • DealNames sub-order number, with a maximum length of 10, exceeding this will result in a failure.
    		•
    Limit No Integer Limit number, 10 by default.
    Offset No Integer Offset, which is 0 by default.
    Tags.N No Array of Tags Tag filtering; filter by the platform's tag capabilities. In this case, you should pass in the tag key and tag value as an object.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Total number
    List Array of LicenseDetail Authorization quantity list information
    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

    Input Example

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

{}

    Output Example

    {
    "Response": {
        "RequestId": "de41ce31-f2c0-49a9-a476-57051a5c7c6c",
        "TotalCount": 1,
        "List": [
            {
                "LicenseId": 1,
                "LicenseType": 0,
                "LicenseStatus": 0,
                "LicenseCnt": 0,
                "UsedLicenseCnt": 0,
                "OrderStatus": 1,
                "BuyTime": "2018-02-28 00:00:00",
                "Deadline": "2018-02-28 00:00:00",
                "ResourceId": "1c007adc2f0bb9f7c052860e2d3703fa",
                "AutoRenewFlag": 0,
                "ProjectId": 1,
                "TaskId": 1,
                "SourceType": 0,
                "Alias": "Resource alias",
                "Tags": [
                    {
                        "TagKey": "Tag key",
                        "TagValue": "Tag value"
                    }
                ]
            }
        ]
    }
}

    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
    InvalidParameter Incorrect parameter.
    InvalidParameterValue Invalid parameter value.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款