1. 接口描述
接口请求域名: billing.tencentcloudapi.com 。
退订不再需要的实例,只退还实付金额的部分,已使用的代金券不退还,退还的实付金额默认退到腾讯云账户余额中。调用该接口的账号需要授予finace:RefundInstance的权限,否则无法支付成功。目前已接入并支持退订的产品包括:T-Sec-Web应用防火墙、云防火墙、主机安全、主机容器、云安全中心、T-Sec-密钥管理系统。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:RefundInstance。 |
| Version | 是 | String | 公共参数,本接口取值:2018-07-09。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| ClientToken | 是 | String | ClientToken是一个由客户端生成的唯一的、区分大小写、不超过64个ASCII字符的字符串。例如,ClientToken=123e4567-e89b-12d3-a456-42665544****。 示例值:c015c8ce-3698-4cd2-865b-7959fe15a705 |
| ProductCode | 是 | String | 产品一层code 示例值:p_yunjing |
| SubProductCode | 是 | String | 产品二层code 示例值:sp_yunjing_vas |
| InstanceId | 是 | String | 实例id 示例值:**** |
| RegionCode | 是 | String | 地域code 示例值:ap-guangzhou |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| OrderIdList | Array of String | 订单号列表 示例值:["20251201**"] |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 退订实例
退订主机安全-旗舰版实例
输入示例
POST / HTTP/1.1
Host: billing.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RefundInstance
<公共请求参数>
{
"ClientToken": "46E6BF87-AF23-4710-8C82-21032D5F389F",
"RegionCode": "ap-guangzhou",
"ProductCode": "p_yunjing",
"SubProductCode": "sp_yunjing_0014552",
"InstanceId": "*********"
}
输出示例
{
"Response": {
"OrderIdList": [
"20251201*************"
],
"RequestId": "41ac9a14-b2a3-4af5-a66f-baa56113ea4a"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure.UnauthorizedOperation | 没有权限。 |
| FailedOperation.BalanceInsufficient | 账户余额不足。 |
| FailedOperation.BusinessCheckErrCode | 业务侧校验不通过错误码。 |
| FailedOperation.GetPriceParamError | 由于传参数问题,导致询价失败 |
| FailedOperation.InvalidDeal | 订单状态错误,只有未支付订单才能支付。 |
| FailedOperation.NumLimitError | 数量超过最大限制。 |
| InternalError | 内部错误。 |
| InternalError.InternalError | 系统内部错误 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.ApiParamError | 参数错误 |
| InvalidParameter.InvalidParameter | 参数错误 |
| InvalidParameter.ResourceLocked | 资源被锁定。 |
| UnauthorizedOperation.CertificationNeedUpgrade | 因账号安全升级,购买云资源需完善您的实名信息。 |
| UnauthorizedOperation.NotCertification | 账号没有实名认证,支付失败。 |
| UnsupportedOperation.NOT_SUPPORT_THIS_ACTION | 暂不支持该行为 |