有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

获取新套餐列表,含详情,如果传了PackageId,则只获取指定套餐详情

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeBaasPackageList。
Version String 公共参数,本接口取值:2018-06-08。
Region String 公共参数,本接口不需要传递此参数。
PackageName String tcb产品套餐ID,不填拉取全量package信息。
示例值:xxx
EnvId String 环境ID
示例值:xxx
Source String 套餐归属方,填写后只返回对应的套餐 包含miniapp与qcloud两种 默认为miniapp
示例值:miniapp
EnvChannel String 套餐归属环境渠道
示例值:qc_console
TargetAction String 拉取套餐用途:
1)new 新购
2)modify变配
3)renew续费
示例值:new
GroupName String 预留字段,同一商品会对应多个类型套餐,对指标有不同侧重。
计算型calculation
流量型flux
容量型capactiy
示例值:calculation
PackageTypeList.N Array of String 类型分组过滤。默认为["default"]
示例值:["default","vip"]
PaymentChannel String 付费渠道,与回包billTags中的计费参数相关,不填返回默认值。
示例值:miniapp

3. 输出参数

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

4. 示例

示例1 获取套餐

获取套餐

输入示例

POST / HTTP/1.1
Host: tcb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBaasPackageList
<公共请求参数>

{
    "Source": "miniapp"
}

输出示例

{
    "Response": {
        "PackageList": [
            {
                "PackageName": "personal_calculation",
                "PackageTitle": "个人版-计算型",
                "GroupName": "calculation",
                "GroupTitle": "套餐分组中文名",
                "BillTags": "{\"pid\":0, \"cids\":{\"create\":0, \"renew\":0, \"modify\":0}, \"productCode\":0, \"subProductCode\":0}",
                "ResourceLimit": "{\"Capacity\":{\"TimeUnit\":\"m\", \"Unit\":\"GB\", \"MaxSize\": 100}, \"Flux\":{\"TimeUnit\":\"m\", \"Unit\":\"GB\", \"MaxSize\": 100}, \"CalculationTime\":{\"TimeUnit\":\"m\", \"Unit\":\"s\", \"MaxSize\": 100}, \"InvokeNum\":{\"TimeUnit\":\"m\", \"Unit\":\"次\", \"MaxSize\": 100}}",
                "AdvanceLimit": "{\"CMSEnable\":false,\"ProvisionedConcurrencyMem\":512000, \"PictureProcessing\":false, \"SecurityAudit\":false, \"RealTimePush\":false, \"TemplateMessageBatchPush\":false, \"Payment\":false}",
                "PackageDescription": "xxx",
                "IsExternal": true
            }
        ],
        "RequestId": "2e992b19-7906-44a4-a8bb-5a71672b0ec9"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。
LimitExceeded 超过配额限制。
MissingParameter 缺少参数错误。
MissingParameter.Param 缺少必要参数。