1. 接口描述
接口请求域名： batch.tencentcloudapi.com 。
创建黑石计算环境
默认接口请求频率限制：3次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateCpmComputeEnv。 |
| Version | 是 | String | 公共参数，本接口取值：2017-03-12。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ComputeEnv | 是 | NamedCpmComputeEnv | 计算环境信息 |
| Placement | 否 | Placement | 位置信息 |
| ClientToken | 否 | String | 用于保证请求幂等性的字符串。该字符串由用户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| EnvId | String | 计算环境ID |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建黑石计算环境
输入示例
https://batch.tencentcloudapi.com/?Action=CreateCpmComputeEnv
&ComputeEnv.EnvName=cpm-env-win
&ComputeEnv.EnvData.Zones.0=ap-chongqing-bls-1
&ComputeEnv.EnvData.InstanceTypes.0=PI100v2
&ComputeEnv.EnvData.TimeUnit=m
&ComputeEnv.EnvData.TimeSpan=1
&ComputeEnv.EnvData.RaidId=3
&ComputeEnv.EnvData.OsTypeId=125
&ComputeEnv.EnvData.VirtualPrivateClouds.0.VpcId=vpc-33em4y15
&ComputeEnv.EnvData.VirtualPrivateClouds.0.SubnetId=subnet-6x83jiie
&ComputeEnv.EnvData.SysRootSpace=100
&ComputeEnv.EnvData.SysDataSpace=50
&ComputeEnv.EnvData.EipPayMode=flow
&ComputeEnv.EnvData.EipBandwidth=0
&ComputeEnv.EnvData.ApplyEip=0
&ComputeEnv.EnvData.HyperThreading=1
&ComputeEnv.EnvData.AutoRenewFlag=0
&ComputeEnv.DesiredComputeNodeCount=1
&<公共请求参数>输出示例
{
"Response": {
"EnvId": "env-89kunmev",
"RequestId": "c30340b4-a9a7-4204-98f6-725da4bcc117"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InternalError.CallCpmAPI | 调用Cpm API返回错误。 |
| InternalError.CpmResponseDataEmpty | 黑石服务返回数据为空。 |
| InvalidParameter.EnvDescriptionTooLong | 计算环境描述过长。 |
| InvalidParameter.EnvNameTooLong | 计算环境名称过长。 |
| InvalidParameter.NotificationEventNameDuplicate | 重复的消息通知事件名称。 |
| InvalidParameter.NotificationTopicName | 非法的主题名称。 |
| InvalidParameter.NotificationTopicNameTooLong | 主题名称过长。 |
| InvalidParameterValue.LimitExceeded | Filter参数值数量超过限制。 |
| InvalidParameterValue.OsTypeId | 指定的OsTypeId不合法。 |
| InvalidParameterValue.RegionNotSupportCpm | 该地域不支持创建黑石计算环境。 |
| UnauthorizedOperation.UserNotAllowedToUseBatch | 禁止使用批量计算服务。 |
