销毁环境

1. 接口描述

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

本接口用于销毁云开发环境。
云开发环境遵循腾讯云包年包月预付费产品生命周期，因此环境销毁需要分两步：

1. 资源退费。此时会根据当前环境剩余有效期，自动退还相关费用(代金券不退)。退款后，环境进入隔离期。
2. 环境删除。环境在进入隔离期后15天会自动删除。也可以通过本接口，指定 IsForce=true 来强制删除隔离期环境。

注意⚠️

1. 环境退费后进入隔离期，则所有资源均无法访问，控制台无法操作和管理。
2. 环境被彻底删除后，所有数据均无法找回。请谨慎操作。

可以通过接口 tcb:DescribeBillingInfo 查询环境计费状态。

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

2. 输入参数

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

3. 输出参数

4. 示例

示例1 云开发环境退款

用于给云开发环境退款。
退款后，环境会进入隔离期。通过接口 DescribeBillingInfo 可以查到环境的计费状态。

输入示例

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

{
    "EnvId": "my-envid-xu94jkgjdlkjlsd"
}

输出示例

{
    "Response": {
        "RequestId": "51a33e48-a808-4fe7-8c02-4e7be5245351"
    }
}

示例2 彻底删除隔离期的环境

用于彻底删除已进入隔离期的环境。需要指定参数 IsForce = true 。
注意⚠️
环境被删除之后，任何数据都将无法找回，请谨慎操作。

输入示例

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

{
    "EnvId": "my-envid-xu94jkgjdlkjlsd",
    "IsForce": true
}

输出示例

{
    "Response": {
        "RequestId": "51a33e48-a808-4fe7-8c02-4e7be5245351"
    }
}

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

命令行工具

• Tencent Cloud CLI 3.0

6. 错误码

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