1. 接口描述
接口请求域名: tcb.tencentcloudapi.com 。
开通后付费资源
默认接口请求频率限制:2次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreatePostpayPackage。 |
Version | 是 | String | 公共参数,本接口取值:2018-06-08。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
EnvId | 否 | String | 环境ID,需要系统自动创建环境时,此字段不传 示例值:cdnheader-v2a |
WxAppId | 否 | String | 微信 AppId,微信必传 示例值:wxxjklfjdkld |
Source | 否 | String | 付费来源 示例值:qcloud |
FreeQuota | 否 | String | 用户享有的免费额度级别,目前只能为“basic”,不传该字段或该字段为空,表示不享受免费额度。 示例值:basic |
EnvSource | 否 | String | 环境创建来源,取值: 用法同CreateEnv接口的Source参数 和 Channel 参数同时传,或者同时不传;EnvId 为空时必传。 示例值:qcloud |
Alias | 否 | String | 环境别名,要以a-z开头,不能包含 a-z,0-9,- 以外的字符 示例值:env-alias |
Channel | 否 | String | 如果envsource为miniapp, channel可以为ide或api; 如果envsource为qcloud, channel可以为qc_console,cocos, qq, cloudgame,dcloud,serverless_framework 和 EnvSource 参数同时传,或者同时不传;EnvId 为空时必传。 示例值:qc_console |
ExtensionId | 否 | String | 扩展ID |
Flag | 否 | String | 订单标记。建议使用方统一转大小写之后再判断。 示例值:Activity |
EnvAlias | 否 | String | 环境别名,无字符类型限制 示例值:my-env |
Extra | 否 | String | 附加字段,用于透传额外的自定义信息 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TranId | String | 后付费订单号 示例值:20200603119423 |
EnvId | String | 环境ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:cdnheader-v2a |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 开通后付费资源
开通后付费资源
输入示例
https://tcb.tencentcloudapi.com/?Action=CreatePostpayPackage
&EnvId=cdnheader-v2a
&FreeQuota=basic
&<公共请求参数>
输出示例
{
"Response": {
"EnvId": "cdnheader-v2a",
"RequestId": "52537e93-2a50-4269-a638-e03e6bb6426e",
"TranId": "20200603119423"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.PlatformError | 操作失败,后台依赖平台错误。 |
InternalError | 内部错误。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable.BalanceNotEnough | 资源不可用-余额不足。 |