DescribePlans

1. API Description

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

This API is used to query package information list with pagination support.

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: DescribePlans.
Version	Yes	String	Common Params. The value used for this API: 2022-09-01.
Region	No	String	Common Params. This parameter is not required.
Filters.N	No	Array of Filter	Filter criteria: the maximum number of Filters.Values is 20. detailed filter criteria are as follows: plan-type filter by package type. available types: plan-trial: trial package; plan-personal: personal plan; plan-basic: basic plan; plan-standard: standard edition plan; plan-enterprise: enterprise plan. plan-id filter by package id. the package id format is: edgeone-268z103ob0sx. area filter by acceleration region. service area. available types: mainland: chinese mainland; overseas: worldwide (excluding chinese mainland); global: global (including chinese mainland). status filter by status. available states: normal: normal status; expiring-soon: expiring soon; expired: expired; isolated: isolated. .
Order	No	String	Specifies the sorting field. valid values:. enable-time: effective time; . expire-time: expiration time. use default value enable-time if not specified.
Direction	No	String	Sorting order. valid values:. `Asc`: sort in ascending order . `Desc`: from the largest to smallest. default value: `desc`.
Limit	No	Integer	Number limit of paginated query. Default value: 20. Maximum value: 200.
Offset	No	Integer	The offset of paginated query. Default value: 0.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Number of eligible packages.
Plans	Array of Plan	Package information list.
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 Query Package Information List

This example shows you how to query the package information list sorted by package activation time in descending order, starting from the 0th package and fetching 4 package details.

Input Example

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

{
    "Offset": 0,
    "Limit": 4,
    "Order": "enable-time",
    "Direction": "desc"
}

Output Example

{
    "Response": {
        "RequestId": "55496a31-e798-4aef-b40c-5cdbaef7fe6f",
        "Plans": [
            {
                "Area": "overseas",
                "AutoRenewal": false,
                "PayMode": 0,
                "PlanId": "edgeone-2ycvr8ml4zpq",
                "PlanType": "plan-enterprise-v2",
                "Status": "normal",
                "DDoSTrafficCapacity": 10000,
                "AccTrafficCapacity": 10000,
                "CrossMLCTrafficCapacity": 10000,
                "ExpiredTime": "2020-09-22T00:00:00Z",
                "EnabledTime": "2020-10-22T00:00:00Z",
                "SecRequestCapacity": 10000,
                "SecTrafficCapacity": 10000,
                "SmartTrafficCapacity": 10000,
                "L4TrafficCapacity": 10000,
                "SmartRequestCapacity": 10000,
                "VAUCapacity": 50,
                "ZonesInfo": [
                    {
                        "Paused": false,
                        "ZoneId": "zone-2ycvr8p31c5q",
                        "ZoneName": "edgeone.icu"
                    }
                ],
                "Bindable": "true"
            },
            {
                "Area": "global",
                "AutoRenewal": false,
                "PayMode": 0,
                "PlanId": "edgeone-2ycvr8p345am",
                "PlanType": "plan-enterprise-v2",
                "Status": "normal",
                "DDoSTrafficCapacity": 10000,
                "AccTrafficCapacity": 10000,
                "CrossMLCTrafficCapacity": 10000,
                "ExpiredTime": "2020-09-22T00:00:00Z",
                "EnabledTime": "2020-10-22T00:00:00Z",
                "SecRequestCapacity": 10000,
                "SecTrafficCapacity": 10000,
                "SmartTrafficCapacity": 10000,
                "L4TrafficCapacity": 10000,
                "SmartRequestCapacity": 10000,
                "VAUCapacity": 50,
                "ZonesInfo": [
                    {
                        "Paused": false,
                        "ZoneId": "zone-2ycvr8p35jv2",
                        "ZoneName": "edgeone.xyz"
                    }
                ],
                "Bindable": "true"
            },
            {
                "Area": "overseas",
                "AutoRenewal": false,
                "PayMode": 0,
                "PlanId": "edgeone-2ycvr8p36yfi",
                "PlanType": "plan-enterprise",
                "Status": "normal",
                "DDoSTrafficCapacity": 10000,
                "AccTrafficCapacity": 10000,
                "CrossMLCTrafficCapacity": 10000,
                "ExpiredTime": "2020-09-22T00:00:00Z",
                "EnabledTime": "2020-10-22T00:00:00Z",
                "SecRequestCapacity": 10000,
                "SecTrafficCapacity": 10000,
                "SmartTrafficCapacity": 10000,
                "L4TrafficCapacity": 10000,
                "SmartRequestCapacity": 10000,
                "VAUCapacity": 50,
                "ZonesInfo": [
                    {
                        "Paused": false,
                        "ZoneId": "zone-2ycvr8p38czy",
                        "ZoneName": "edgeone.com"
                    }
                ],
                "Bindable": "true"
            },
            {
                "Area": "overseas",
                "AutoRenewal": false,
                "PayMode": 0,
                "PlanId": "edgeone-2ycvr8p39rke",
                "PlanType": "plan-standard",
                "Status": "normal",
                "DDoSTrafficCapacity": 10000,
                "AccTrafficCapacity": 10000,
                "CrossMLCTrafficCapacity": 10000,
                "ExpiredTime": "2020-09-22T00:00:00Z",
                "EnabledTime": "2020-10-22T00:00:00Z",
                "SecRequestCapacity": 10000,
                "SecTrafficCapacity": 10000,
                "SmartTrafficCapacity": 10000,
                "L4TrafficCapacity": 10000,
                "SmartRequestCapacity": 10000,
                "VAUCapacity": 50,
                "ZonesInfo": [
                    {
                        "Paused": true,
                        "ZoneId": "zone-2vv6990bixl1",
                        "ZoneName": "edgeone.xyz"
                    }
                ],
                "Bindable": "false"
            }
        ],
        "TotalCount": 28
    }
}

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

Tencent Cloud CLI 3.0

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
UnauthorizedOperation.CamUnauthorized	CAM is not authorized.
UnauthorizedOperation.NoPermission	The sub-account is not authorized for the operation. Please get permissions first.

1. API Description
2. Input Parameters
3. Output Parameters
4. Example
Example1 Query Package Information List
5. Developer Resources
SDK
Command Line Interface
6. Error Code