1. 接口描述
接口请求域名: teo.tencentcloudapi.com 。
若您需要使用 Edgeone 产品,您需要通过此接口创建计费套餐。
创建套餐后,您需要通过 CreateZone 完成创建站点,绑定套餐的流程,Edgeone 才能正常提供服务。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreatePlan。 |
Version | 是 | String | 公共参数,本接口取值:2022-09-01。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
PlanType | 是 | String | 订阅的套餐类型,取值有: 计费概述参考 Edgeone计费概述 不同套餐区别参考 Edgeone计费套餐选型对比 |
AutoUseVoucher | 否 | String | 是否自动使用代金券,取值有: 不填写使用默认值 false。 |
PrepaidPlanParam | 否 | PrepaidPlanParam | 订阅预付费套餐参数,PlanType 为 personal, basic, standard 时,可以选填该参数,用于传入套餐的订阅时长和是否开启自动续费。 不填该参数时,默认开通套餐时长为 1 个月,不开启自动续费。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
PlanId | String | 套餐 ID,形如 edgeone-2unuvzjmmn2q。 |
DealName | String | 订单号。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建个人版计费套餐
创建个人版计费套餐,套餐时长 1 个月,且设置不自动续费。
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreatePlan
<公共请求参数>
{
"PlanType": "personal",
"PrepaidPlanParam": {
"Period": 1,
"RenewFlag": "off"
},
"AutoUseVoucher": "false"
}
输出示例
{
"Response": {
"RequestId": "6a617014-efc9-45c6-ba9d-c87d70472461",
"PlanId": "edgeone-2unuvzjmmn2q",
"DealName": "20240312347001004723731"
}
}
示例2 创建企业版套餐
创建企业版套餐。
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreatePlan
<公共请求参数>
{
"PlanType": "enterprise"
}
输出示例
{
"Response": {
"RequestId": "6a617014-efc9-45c6-ba9d-c87d70472461",
"PlanId": "edgeone-2unuvzjmmn2q",
"DealName": "20240312347001004723731"
}
}
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.InsufficientAccountBalance | 账户余额不足。 |
InvalidParameter.InvalidAutoUseVoucher | 自动使用代金券格式不正确,请输入正确的自动使用代金券格式。 |
InvalidParameter.InvalidPeriod | 套餐周期格式不正确,请输入正确的套餐周期格式。 |
InvalidParameter.InvalidPlanType | 套餐类型格式不正确,请输入正确的套餐类型格式。 |
InvalidParameter.InvalidRenewFlag | 自动续费标志格式不正确,请输入正确的自动续费标签格式。 |
OperationDenied.PleaseContactBusinessPersonnel | 如需创建企业版套餐,请联系商务人员。 |