1. 接口描述
接口请求域名： tem.tencentcloudapi.com 。
创建环境
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateEnvironment。 |
| Version | 是 | String | 公共参数，本接口取值：2021-07-01。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| EnvironmentName | 是 | String | 环境名称 示例值：namespace-a |
| Description | 否 | String | 环境描述 示例值：命名空间名 |
| Vpc | 否 | String | 私有网络名称 示例值：vpc-1n5javez |
| SubnetIds.N | 否 | Array of String | 子网列表 示例值：subnet-xxxx |
| K8sVersion | 否 | String | K8s version 示例值：1.16.9 |
| SourceChannel | 否 | Integer | 来源渠道 示例值：0 |
| EnableTswTraceService | 否 | Boolean | 是否开启tsw服务 示例值：true |
| Tags.N | 否 | Array of Tag | 标签 示例值：1 |
| EnvType | 否 | String | 环境类型：test、pre、prod 示例值：test |
| CreateRegion | 否 | String | 创建环境的region 示例值：ap-shanghai |
| SetupVpc | 否 | Boolean | 是否创建私有网络 示例值：false |
| SetupPrometheus | 否 | Boolean | 是否创建 Prometheus 实例 示例值：false |
| PrometheusId | 否 | String | prometheus 实例 id 示例值：prom-xxx |
| ApmId | 否 | String | apm id 示例值：apm-xxx |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | String | 成功时为环境ID，失败为null 注意：此字段可能返回 null，表示取不到有效值。 示例值：namespace-36pm4p8r |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建环境
创建环境
输入示例
POST / HTTP/1.1
Host: tem.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateEnvironment
<公共请求参数>
{
"EnvironmentName": "xx",
"Description": "xx",
"K8sVersion": "xx",
"SubnetIds": [
"xx"
],
"EnableTswTraceService": true,
"SourceChannel": 0,
"Vpc": "xx"
}输出示例
{
"Response": {
"RequestId": "81f74023-563c-437d-abf7-8139449ef178",
"Result": "env-xxxx"
}
}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.DefaultInternalError | 服务器繁忙,请稍后再试。 |
| InternalError.CreateEksClusterError | 底层集群创建失败。 |
| InternalError.DefaultInternalError | 服务器繁忙,请稍后再试。 |
| InvalidParameter.UnauthorizedOrMissingRole | 权限不足或缺少相关角色 |
| InvalidParameter.VpcOverQuota | 自动创建将超过 vpc 限额。 |
| InvalidParameterValue.CreateNamespaceUnsupportRegionError | 创建环境createRegion参数错误。 |
| InvalidParameterValue.DailyCreateNamespaceReachMaximum | 每日环境创建次数超过上限。 |
| InvalidParameterValue.NamespaceDuplicateError | 环境重复。 |
| InvalidParameterValue.NamespaceReachMaximum | 环境创建失败，达到上限。 |
| MissingParameter.EnvironmentNameNull | 环境名称不能为空。 |
| OperationDenied.BalanceNotEnough | 账户余额不足。 |
| UnauthorizedOperation.UnauthorizedOperation | 未授权。 |