1. 接口描述
接口请求域名: omics.tencentcloudapi.com 。
创建组学平台计算环境。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateEnvironment。 |
Version | 是 | String | 公共参数,本接口取值:2022-11-28。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Name | 是 | String | 环境名称。 示例值:FirstEnvironment |
Config | 是 | EnvironmentConfig | 环境配置信息。 示例值:{"VPCOption": {"SubnetZone": "ap-guangzhou-6","VPCCIDRBlock": "10.8.0.0/16","SubnetCIDRBlock": "10.8.16.0/20"},"ClusterOption": {"Zone": "ap-guangzhou-6","Type": "KUBERNETES","ServiceCidr": "192.168.0.0/20","ResourceQuota": {"CPULimit": "30","MemoryLimit": "60Gi","Pods": "10"},"LimitRange": {"MaxCPU": "5","MaxMemory": "10Gi"}},"DatabaseOption": {"Zone": "ap-guangzhou-4"},"StorageOption": {"StorageType": "SD","Capacity": 40960,"Zone": "ap-guangzhou-6"},"CVMOption": {"Zone": "ap-guangzhou-6","InstanceType": "SA3.MEDIUM8"},"SecurityGroupOption": {"SecurityGroupId": "sg-cml3s14x"}} |
Description | 否 | String | 环境描述。 示例值:My first environment |
IsDefault | 否 | Boolean | 是否为默认环境。 示例值:True |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
EnvironmentId | String | 环境ID。 示例值:env-lljckw12 |
WorkflowUuid | String | 工作流UUID。 示例值:bc5b790b-407e-42c7-b488-a252fee1dcc7 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建环境
创建环境。
输入示例
POST / HTTP/1.1
Host: omics.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateEnvironment
{
"Name": "omics env",
"Description": "env description",
"Config": {
"VPCOption": {
"SubnetZone": "ap-guangzhou-6",
"VPCCIDRBlock": "10.8.0.0/16",
"SubnetCIDRBlock": "10.8.16.0/20"
},
"ClusterOption": {
"Zone": "ap-guangzhou-6",
"Type": "KUBERNETES"
},
"DatabaseOption": {
"Zone": "ap-guangzhou-4"
},
"StorageOption": {
"StorageType": "SD",
"Zone": "ap-guangzhou-6"
},
"CVMOption": {
"Zone": "ap-guangzhou-6",
"InstanceType": "SA3.MEDIUM8"
}
}
}
输出示例
{
"Response": {
"RequestId": "946e07f8-f487-46ab-b486-65e362b4a38b",
"EnvironmentId": "env-lljckw12",
"WorkflowUuid": "bc5b790b-407e-42c7-b488-a252fee1dcc7"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.DuplicateName | 名称重复 |
LimitExceeded | 超过配额限制。 |
OperationDenied | 操作被拒绝。 |
ResourceInsufficient | 资源不足。 |