查询套餐信息列表

最近更新时间:2025-06-06 02:07:05

我的收藏

1. 接口描述

接口请求域名: teo.tencentcloudapi.com 。

查询套餐信息列表,支持分页。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribePlans。
Version String 公共参数,本接口取值:2022-09-01。
Region String 公共参数,此参数为可选参数。
Filters.N Array of Filter 过滤条件,Filters.Values 的上限为 20。详细的过滤条件如下:
  • plan-type
      按照【套餐类型】进行过滤。
      可选的类型有:
      plan-trial:试用版套餐;
      plan-personal:个人版套餐;
      plan-basic:基础版套餐;
      plan-standard:标准版套餐;
      plan-enterprise:企业版套餐。 
  • plan-id
      按照【套餐 ID】进行过滤。套餐 ID 形如:edgeone-268z103ob0sx。
  • area
      按照【套餐加速地域】进行过滤。
  •   服务区域,可选的类型有:
      mainland: 中国大陆;
      overseas: 全球(不包括中国大陆);
      global: 全球(包括中国大陆)。
  • status
      按照【套餐状态】进行过滤。
      可选的状态有:
      normal:正常状态;
      expiring-soon:即将过期;
      expired:已到期;
      isolated:已隔离。
  • Order String 排序字段,取值有:
  • enable-time:生效时间;
  • expire-time:过期时间。
  • 不填写使用默认值 enable-time。
    Direction String 排序方向,取值有:
  • asc:从小到大排序;
  • desc:从大到小排序。
  • 不填写使用默认值 desc。
    Limit Integer 分页查询限制数目。默认值:20,最大值:200。
    Offset Integer 分页查询偏移量。默认值:0。

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合条件的套餐个数。
    Plans Array of Plan 套餐信息列表。
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询套餐信息列表

    查询套餐信息列表,按照套餐生效时间排序,顺序为降序,从第0个套餐开始,拉取4个套餐信息。

    输入示例

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribePlans
    <公共请求参数>
    
    {
        "Offset": 0,
        "Limit": 4,
        "Order": "enable-time",
        "Direction": "desc"
    }

    输出示例

    {
        "Response": {
            "RequestId": "55496a31-e798-4aef-b40c-5cdbaef7fe6f",
            "Plans": [
                {
                    "Area": "overseas",
                    "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",
                    "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",
                    "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",
                    "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. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    UnauthorizedOperation.CamUnauthorized Cam 未授权。
    UnauthorizedOperation.NoPermission 子账户没有操作权限,请添加权限后继续操作。