创建计算环境

最近更新时间:2018-03-21 18:06:02

1. 接口描述

本接口(CreateComputeEnv)用于创建计算环境
接口请求域名:batch.api.qcloud.com

2. 输入参数

名称 类型 是否必选 描述
Version String API 版本
ComputeEnv ComputeEnv object 计算环境
Placement Placement object 位置信息,通过该参数可以指定作业所属可用区等信息。
ClientToken String 用于保证请求幂等性的字符串。该字符串由用户生成,需保证不同请求之间唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。

ComputeEnv

名称 类型 是否必选 描述
EnvName String 计算环境名称
EnvDescription String 计算环境描述
EnvType String 计算环境类型,仅支持“MANAGED”类型
EnvData EnvData object 计算环境参数
MountDataDisks array of MountDataDisk objects 数据盘挂载选项
InputMappings array of InputMapping objects 输入映射
Authentications array of Authentication objects 授权信息
Notifications array of Notification objects 通知信息
DesiredComputeNodeCount Integer 计算节点期望个数

备注:EnvData、MountDataDisks、InputMappings、Authentications、Notifications、AgentRunningMode 等参数参考SubmitJob接口中相应参数

消息通知事件类型

类型 描述
COMPUTE_ENV_CREATED 创建计算环境
COMPUTE_ENV_DELETED 删除计算环境
COMPUTE_NODE_CREATED 计算节点创建成功
COMPUTE_NODE_CREATION_FAILED 计算节点创建失败
COMPUTE_NODE_RUNNING 计算节点运行中
COMPUTE_NODE_ABNORMAL 计算节点异常
COMPUTE_NODE_DELETING 计算节点销毁中

备注:注意计算环境和作业对应不同的事件类型。

Placement

名称 类型 是否必选 描述
Zone String 计算环境创建的 CVM 实例所属的可用区ID
ProjectId Integer 计算环境创建的 CVM 实例所属项目ID。该参数可以通过调用 DescribeProject 的返回值中的 projectId 字段来获取。不填为默认项目。
# 输入参数示例
{
  "ComputeEnv": {
    "EnvName": "test compute env",
    "EnvDescription": "test compute env",
    "EnvType": "MANAGED",
    "EnvData": {
      "InternetAccessible": {
        "PublicIpAssigned": "TRUE",
        "InternetMaxBandwidthOut": 50
      },
      "LoginSettings": {
        "Password": "B1[habcd"
      },
      "InstanceType": "S1.SMALL1",
      "ImageId": "img-xxxxyyyy"
    },
    "InputMappings": [
      {
        "SourcePath": "cfs://10.100.100.10:/",
        "DestinationPath": "/mnt/disk/"
      },
      {
        "SourcePath": "cos://batchbucket-appid.cosgz.myqcloud.com/",
        "DestinationPath": "/mnt/disk1/"
      },
      {
        "SourcePath": "cos://batchbucket-appid.cosgz.myqcloud.com/hello2/",
        "DestinationPath": "/mnt/disk2/"
      }
    ],
    "MountDataDisks": [
      {
        "FileSystemType": "EXT3",
        "LocalPath": "/data/"
      }
    ],
    "Authentications": [
      {
        "SecretKey": "your secret key",
        "SecretId": "your secret id",
        "Scene": "COS"
      }
    ],
    "Notifications": [
      {
        "TopicName": "topic name",
        "EventConfigs": [
          {
            "EventName": "COMPUTE_ENV_DELETED",
            "EventVars": [
              {
                "Name": "name1",
                "Value": "value1"
              },
              {
                "Name": "name2",
                "Value": "value2"
              }
            ]
          }
        ]
      }
    ],
    "DesiredComputeNodeCount": 3
  },
  "Placement": {
    "Zone": "ap-guangzhou-2",
    "ProjectId": 1053241
  },
  "ClientToken": "xxxx"
}

3. 输出参数

参数名称 类型 描述
EnvId String 计算环境唯一标识。
RequestId String 唯一请求ID。
# 输出参数示例
{
  "Response": {
    "EnvId": "env-xxxxyyyy",
    "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
  }
}

4. 错误码

错误码 描述
InvalidBatchEnvName.TooLong 计算环境名称过长。
InvalidBatchEnvDescription.TooLong 计算环境描述过长。
UnsupportedBatchRemoteStorageSchemeType 非法的存储类型。
UnsupportedBatchRemoteStoragePath 非法的存储路径格式。
BatchComputeNotAllowed 禁止使用批量计算服务。
BatchComputeCheckComputeEnvError 计算环境校验失败。
UnsupportedBatchLocalPath 非法的本地存储路径。
InvalidNotificationEventName.Duplicate 重复的消息通知事件名称。
InvalidNotificationTopicName 非法的主题名称。
InvalidNotificationTopicName.TooLong 主题名称过长。
InvalidCvmParameters 非法的CVM参数。
UnSupportedInstanceType 不支持指定的实例类型。
InvalidParameterValue.Negative 非法的负值参数。
NoEnoughComputeEnvQuota 计算环境配额不足。
NoEnoughCpuQuota CPU配额不足。
InternalServerError 内部服务错误。