1. 接口描述
接口请求域名: igtm.tencentcloudapi.com 。
购买套餐并支付,此接口会在余额扣费,谨慎调用
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreatePackageAndPay。 |
| Version | 是 | String | 公共参数,本接口取值:2023-10-24。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| DealType | 是 | String | 下单类型:CREATE 新购;RENEW 续费;MODIFY 变配 示例值:CREATE |
| GoodsType | 是 | String | 套餐类型:STANDARD 标准版;ULTIMATE 旗舰版;TASK 任务探测 示例值:STANDARD |
| GoodsNum | 是 | Integer | 商品数量:STANDARD和ULTIMATE固定为1,TASK为任务探测数量。取值范围:1~10000 示例值:1 |
| AutoRenew | 是 | Integer | 自动续费:1 开启自动续费;2 关闭自动续费 示例值:1 |
| ResourceId | 否 | String | 资源ID,续费和变配的时候需要传 示例值:gtm-cnxxpfvartb |
| TimeSpan | 否 | Integer | 套餐时长,以月为单位,创建和续费的时候需要传。取值范围:1~120 示例值:1 |
| NewPackageType | 否 | String | 升级的套餐类型,暂时只支持传ULTIMATE,不支持降配 示例值:ULTIMATE |
| AutoVoucher | 否 | Integer | 是否自动选择代金券,1 是;0否,默认为0 示例值:1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ResourceIds | Array of String | 资源id列表,目前只会返回一个资源,取第一个值即可 示例值:["gtm-cnxxpfvartb"] |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 购买套餐
输入示例
POST / HTTP/1.1
Host: igtm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreatePackageAndPay
<公共请求参数>
{
"DealType": "CREATE",
"GoodsType": "ULTIMATE",
"GoodsNum": 1,
"AutoRenew": 1,
"TimeSpan": 1,
"AutoVoucher": 1
}
输出示例
{
"Response": {
"RequestId": "079d26c3-15a0-4ce0-836d-7307776860e1",
"ResourceIds": [
"ins-ojwefnyfigv"
]
}
}
示例2 续费套餐
输入示例
POST / HTTP/1.1
Host: igtm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreatePackageAndPay
<公共请求参数>
{
"DealType": "RENEW",
"GoodsType": "ULTIMATE",
"GoodsNum": 1,
"AutoRenew": 1,
"ResourceId": "ins-ojwefnyfigv",
"TimeSpan": 1,
"AutoVoucher": 1
}
输出示例
{
"Response": {
"RequestId": "079d26c3-15a0-4ce0-836d-7307776860e1",
"ResourceIds": [
"ins-ojwefnyfigv"
]
}
}
示例3 变配套餐
输入示例
POST / HTTP/1.1
Host: igtm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreatePackageAndPay
<公共请求参数>
{
"DealType": "MODIFY",
"GoodsType": "STANDARD",
"GoodsNum": 1,
"AutoRenew": 1,
"ResourceId": "ins-lntftyrifqx",
"TimeSpan": 1,
"NewPackageType": "ULTIMATE",
"AutoVoucher": 1
}
输出示例
{
"Response": {
"RequestId": "183a7455-6a2c-4e17-816d-e45e880230fe",
"ResourceIds": [
"ins-lntftyrifqx"
]
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| FailedOperation.CreateError | 创建失败。 |
| FailedOperation.DealAndPayFailed | 下单与支付失败 |
| FailedOperation.QueryErr | 查询失败 |
| InternalError | 内部错误。 |
| InternalError.UndefinedError | 错误未定义 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.DealStandardModifyFailed | 标准版只支持变配到旗舰版 |
| InvalidParameter.DealStandardModifyInvalid | 此套餐非标准版,不支持变配到旗舰版 |
| InvalidParameter.DealTaskModifyInvalid | resourceId非探测任务,请确认参数 |
| InvalidParameter.DealTaskModifyNumLess | 变配的探测任务配额小于已使用数,请重新输入 |
| InvalidParameter.DealTaskModifyNumSame | 变配的探测任务配额无变化,请重新输入 |
| InvalidParameter.DealUltimateModifyFailed | 旗舰版不支持变配 |
| InvalidParameter.ResourceIdEmpty | 续费或变配时,资源ID不能为空 |
| InvalidParameter.TimeSpanEmpty | 创建或续费时,下单时间长度不能为空 |
| InvalidParameter.TimeSpanInvalid | 下单时间范围非法,只支持1到120 |
| InvalidParameterValue | 参数取值错误。 |
| MissingParameter | 缺少参数错误。 |
| UnauthorizedOperation | 未授权操作。 |
| UnauthorizedOperation.ResourceIdNotMatch | 资源Id与传入的套餐类型不匹配 |
| UnauthorizedOperation.ResourceIdUnauthorized | 资源Id未授权或已过期,请重新输入 |
| UnauthorizedOperation.UnauthorizedError | 资源未授权。 |
| UnsupportedOperation.UserNotFound | 用户未登录,缺少Uin参数。 |