EMR 开发指南

创建EMR实例

最近更新时间:2020-10-23 08:04:59

1. 接口描述

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

创建EMR实例

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:emr.ap-shanghai-fsi.tencentcloudapi.com。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateInstance。
Version String 公共参数,本接口取值:2019-01-03。
Region String 公共参数,详见产品支持的 地域列表
ProductId Integer 产品ID,不同产品ID表示不同的EMR产品版本。取值范围:
  • 1:表示EMR-V1.3.1。
  • 2:表示EMR-V2.0.1。
  • 4:表示EMR-V2.1.0。
  • 7:表示EMR-V3.0.0。
  • VPCSettings VPCSettings 私有网络相关信息配置。通过该参数可以指定私有网络的ID,子网ID等信息。
    Software.N Array of String 部署的组件列表。不同的EMR产品ID(ProductId:具体含义参考入参ProductId字段)需要选择不同的必选组件:
  • ProductId为1的时候,必选组件包括:hadoop-2.7.3、knox-1.2.0、zookeeper-3.4.9
  • ProductId为2的时候,必选组件包括:hadoop-2.7.3、knox-1.2.0、zookeeper-3.4.9
  • ProductId为4的时候,必选组件包括:hadoop-2.8.4、knox-1.2.0、zookeeper-3.4.9
  • ProductId为7的时候,必选组件包括:hadoop-3.1.2、knox-1.2.0、zookeeper-3.4.9
  • ResourceSpec NewResourceSpec 节点资源的规格。
    SupportHA Integer 是否开启节点高可用。取值范围:
  • 0:表示不开启节点高可用。
  • 1:表示开启节点高可用。
  • InstanceName String 实例名称。
  • 长度限制为6-36个字符。
  • 只允许包含中文、字母、数字、-、_。
  • PayMode Integer 实例计费模式。取值范围:
  • 0:表示按量计费。
  • 1:表示包年包月。
  • Placement Placement 实例所在的位置。通过该参数可以指定实例所属可用区,所属项目等属性。
    TimeSpan Integer 购买实例的时长。结合TimeUnit一起使用。
  • TimeUnit为s时,该参数只能填写3600,表示按量计费实例。
  • TimeUnit为m时,该参数填写的数字表示包年包月实例的购买时长,如1表示购买一个月
  • TimeUnit String 购买实例的时间单位。取值范围:
  • s:表示秒。PayMode取值为0时,TimeUnit只能取值为s。
  • m:表示月份。PayMode取值为1时,TimeUnit只能取值为m。
  • LoginSettings LoginSettings 实例登录设置。通过该参数可以设置所购买节点的登录方式密码或者密钥。
  • 设置密钥时,密码仅用于组件原生WebUI快捷入口登录。
  • 未设置密钥时,密码用于登录所购节点以及组件原生WebUI快捷入口登录。
  • COSSettings COSSettings 开启COS访问需要设置的参数。
    SgId String 实例所属安全组的ID,形如sg-xxxxxxxx。该参数可以通过调用 DescribeSecurityGroups 的返回值中的SecurityGroupId字段来获取。
    PreExecutedFileSettings.N Array of PreExecuteFileSettings 引导操作脚本设置。
    AutoRenew Integer 包年包月实例是否自动续费。取值范围:
  • 0:表示不自动续费。
  • 1:表示自动续费。
  • ClientToken String 客户端Token。
    NeedMasterWan String 是否开启集群Master节点公网。取值范围:
  • NEED_MASTER_WAN:表示开启集群Master节点公网。
  • NOT_NEED_MASTER_WAN:表示不开启。
  • 默认开启集群Master节点公网。
    RemoteLoginAtCreate Integer 是否需要开启外网远程登录,即22号端口。在SgId不为空时,该参数无效。
    CheckSecurity Integer 是否开启安全集群。0表示不开启,非0表示开启。
    ExtendFsField String 访问外部文件系统。
    Tags.N Array of Tag 标签描述列表。通过指定该参数可以同时绑定标签到相应的实例。
    DisasterRecoverGroupIds.N Array of String 分散置放群组ID列表,当前只支持指定一个。
    CbsEncrypt Integer 集群维度CBS加密盘,默认0表示不加密,1表示加密
    MetaType String hive共享元数据库类型。取值范围:
  • EMR_NEW_META:表示集群默认创建
  • EMR_EXIT_METE:表示集群使用指定EMR-MetaDB。
  • USER_CUSTOM_META:表示集群使用自定义MetaDB。
  • UnifyMetaInstanceId String EMR-MetaDB实例
    MetaDBInfo CustomMetaInfo 自定义MetaDB信息
    ApplicationRole String 自定义应用角色。

    3. 输出参数

    参数名称 类型 描述
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 创建实例

    输入示例

    https://emr.tencentcloudapi.com/?Action=CreateInstance
    &ProductId=4
    &SupportHA=0
    &InstanceName=emr测试
    &PayMode=0
    &Placement.Zone=ap-guangzhou-3
    &Placement.ProjectId=0
    &AutoRenew=0
    &Software.0=hadoop-2.8.4
    &Software.1=zookeeper-3.4.9
    &Software.2=knox-1.2.0
    &ResourceSpec.MasterResourceSpec.MemSize=8192
    &ResourceSpec.MasterResourceSpec.Cpu=4
    &ResourceSpec.MasterResourceSpec.DiskSize=100
    &ResourceSpec.MasterResourceSpec.DiskType=CLOUD_PREMIUM
    &ResourceSpec.MasterResourceSpec.Spec=CVM.S2
    &ResourceSpec.MasterResourceSpec.RootSize=100
    &ResourceSpec.MasterResourceSpec.StorageType=5
    &ResourceSpec.CoreResourceSpec.MemSize=8192
    &ResourceSpec.CoreResourceSpec.Cpu=4
    &ResourceSpec.CoreResourceSpec.DiskSize=100
    &ResourceSpec.CoreResourceSpec.DiskType=CLOUD_PREMIUM
    &ResourceSpec.CoreResourceSpec.Spec=CVM.S2
    &ResourceSpec.CoreResourceSpec.RootSize=100
    &ResourceSpec.CoreResourceSpec.StorageType=5
    &ResourceSpec.MasterCount=1
    &ResourceSpec.CoreCount=2
    &VPCSettings.VpcId=vpc-ezt5qmqz
    &VPCSettings.SubnetId=subnet-jhgsahx0
    &LoginSettings.Password=tencent@cloud123
    &TimeSpan=3600
    &TimeUnit=s
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "RequestId": "d830face-6587-4263-8ab0-56bda265787d"
      }
    }

    5. 开发者资源

    API Explorer

    该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    FailedOperation 操作失败。
    FailedOperation.DuplicateOrderNotAllowed 重复的订单,请检查emr控制台。
    InternalError 内部错误。
    InternalError.AccountCgwError 内部服务调用异常。
    InternalError.CamCgwError 内部服务调用异常。
    InternalError.CamError 内部服务调用异常。
    InternalError.CbsCgwError 内部服务调用异常。
    InternalError.CbsError 内部服务调用异常。
    InternalError.CdbCgwError 内部服务调用异常。
    InternalError.CdbError 内部服务调用异常。
    InternalError.CheckQuotaErr cvm或cbs资源不够或软件不合法。
    InternalError.ConfigCgwError 内部服务调用异常。
    InternalError.CvmError 内部服务调用异常。
    InternalError.KmsError 内部服务调用异常。
    InternalError.ProjectCgwError 内部服务调用异常。
    InternalError.SgError 安全组接口调用异常。
    InternalError.TagError 内部服务调用异常。
    InternalError.TradeCgwError 内部服务调用异常。
    InternalError.VpcCgwError 内部服务调用异常。
    InternalError.VpcError 内部服务调用异常。
    InvalidParameter 参数错误。
    InvalidParameter.IncorrectCommonCount Common节点数量无效。
    InvalidParameter.IncorrectMasterCount Master节点数量无效。
    InvalidParameter.InvaildCoreCount core节点的数量不能超过20。
    InvalidParameter.InvalidAutoRenew 无效的自动续费标识。
    InvalidParameter.InvalidClientToken 无效的ClientToken。
    InvalidParameter.InvalidComponent 无效的组件。
    InvalidParameter.InvalidCoreCount Core节点数量无效。
    InvalidParameter.InvalidInstanceName 无效的集群名称。
    InvalidParameter.InvalidLoginSetting 无效的登录设置。
    InvalidParameter.InvalidPassword 无效密码。
    InvalidParameter.InvalidPaymode 无效的付费类型。
    InvalidParameter.InvalidPreExecutedFile 无效的引导操作脚本。
    InvalidParameter.InvalidProductId 无效的产品ID。
    InvalidParameter.InvalidProjectId 无效的项目ID。
    InvalidParameter.InvalidResourceSpec 无效的资源规格。
    InvalidParameter.InvalidSercurityGrpupId 无效的安全组ID。
    InvalidParameter.InvalidServiceName 服务名无效。
    InvalidParameter.InvalidSoftInfo 无效的SoftInfo。
    InvalidParameter.InvalidSoftWareVersion 软件版本无效。
    InvalidParameter.InvalidSubnetId 无效的子网ID。
    InvalidParameter.InvalidSupportHA 无效的高可用参数。
    InvalidParameter.InvalidTimeSpan 无效的timespan。
    InvalidParameter.InvalidTimeUnit 无效的TimeUnit。
    InvalidParameter.InvalidVpcId 无效的私有网络ID。
    InvalidParameter.InvalidZone 无效的可用区。
    InvalidParameter.PayModeResourceNotMatch 付费模式与资源不匹配。
    InvalidParameter.SoftwareNotInProduct 存在无效的产品组件。
    InvalidParameter.UngrantedPolicy 策略为授权。
    InvalidParameter.ZoneResourceNotMatch 可用区与资源不匹配。
    InvalidParameterValue 参数取值错误。
    MissingParameter 缺少参数错误。
    ResourceInsufficient.DiskInsufficient 硬盘规格不满足。
    ResourceInsufficient.InstanceInsufficient 不支持或售罄的节点规格。
    ResourceNotFound.TagsNotFound 没有查找到指定标签。
    ResourcesSoldOut. 资源售罄。
    ResourcesSoldOut.CbsSoldOut CBS资源售罄。
    ResourcesSoldOut.CvmSoldOut 云服务器已售罄。
    UnknownParameter 未知参数错误。
    UnsupportedOperation 操作不支持。
    目录