创建环境

最近更新时间:2026-02-13 02:03:44

我的收藏

1. 接口描述

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

本接口用于购买云开发环境。
该接口会自动下单并支付,会在腾讯云账户中扣除余额(余额不足会下单失败)。
该接口支持自动扣除代金券(AutoVoucher=true时),符合条件的代金券会被自动扣除。
环境下单成功之后会返回EnvId。EnvId是全局唯一表示。
环境发货是异步行为,后续可以通过接口 DescribeEnvs 查询环境状态和各项资源信息;通过 DescribeBillingInfo 查询环境套餐信息,包括 到期时间、当前套餐等。

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateEnv。
Version String 公共参数,本接口取值:2018-06-08。
Region String 公共参数,本接口不需要传递此参数。
Alias String 环境别名。

### 格式要求
- 可选字符: 小写字母(a~z)、数字、减号(-)
- 不能以 减号(-) 开头或结尾
- 不能有连个连续的 减号(-)
- 长度不超过20位
示例值:cloud
示例值:cloudbase
PackageId String 云开发环境套餐Id。
对于云开发环境套餐,可通过 DescribeBaasPackageList 接口获取,对应其出参的PackageName。
示例值:baas_personal
Resources.N Array of String 资源类型。代表新购环境时需要发货哪些资源。
可取值以及含义:
- flexdb : 表示文档型数据库
- storage : 表示云存储
- function : 表示云函数

该字段不可为空
示例值:["flexdb"]
Period Integer 购买实例的时长,单位:月。取值范围:1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24。
默认值为1,即1个月。
示例值:1
AutoVoucher Boolean 是否自动选择代金券支付。
示例值:true
Tags.N Array of Tag 环境标签。
可取值通过接口 tag:DescribeTags 可获取到。
不传或为空则默认不打任何标签。

3. 输出参数

参数名称 类型 描述
EnvId String 自动生成的环境ID
示例值:cloudbase-7g0gd9j012a86ed6
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建个人版环境

创建个人版环境(PackageId=baas_personal),并指定包含 文档型数据库(flexdb)、云存储(storage)、云函数(function) 三种资源。
购买周期为1个月(Period=1)。
自动使用代金券支付(AutoVoucher=true)。
环境别名为 cloudbase(Alias=cloudbase)。
创建成功,则自动拿到一个以 Alias(当前值为cloudbase) 为前缀的 EnvId:cloudbase-8grqda2hfc2f62bb

输入示例

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

{
    "Alias": "cloudbase",
    "PackageId": "baas_personal",
    "Resources": [
        "flexdb",
        "storage",
        "function"
    ],
    "Period": 1,
    "AutoVoucher": true
}

输出示例

{
    "Response": {
        "EnvId": "cloudbase-8grqda2hfc2f62bb",
        "RequestId": "53d30c8d-53ba-46c0-89a5-c791ad79a2b8"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。
MissingParameter 缺少参数错误。
MissingParameter.Param 缺少必要参数。
ResourceInUse 资源被占用。
ResourceInsufficient 资源不足。