创建EMR集群实例(新)

最近更新时间:2024-09-16 01:45:35

我的收藏

1. 接口描述

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

创建EMR集群实例

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateCluster。
Version String 公共参数,本接口取值:2019-01-03。
Region String 公共参数,详见产品支持的 地域列表
ProductVersion String EMR产品版本名称如EMR-V2.3.0 表示2.3.0版本的EMR, 当前支持产品版本名称查询:产品版本名称
示例值:EMR-V1.3.1
EnableSupportHAFlag Boolean 是否开启节点高可用。取值范围:
  • true:表示开启节点高可用。
  • false:表示不开启节点高可用。

  • 示例值:true
    InstanceName String 实例名称。
  • 长度限制为6-36个字符。
  • 只允许包含中文、字母、数字、-、_。

  • 示例值:emr测试
    InstanceChargeType String 实例计费模式。取值范围:
  • PREPAID:预付费,即包年包月。
  • POSTPAID_BY_HOUR:按小时后付费。

  • 示例值:PREPAID
    LoginSettings LoginSettings 实例登录设置。通过该参数可以设置所购买节点的登录方式密码或者密钥。
  • 设置密钥时,密码仅用于组件原生WebUI快捷入口登录。
  • 未设置密钥时,密码用于登录所购节点以及组件原生WebUI快捷入口登录。
  • SceneSoftwareConfig SceneSoftwareConfig 集群应用场景以及支持部署组件配置
    InstanceChargePrepaid InstanceChargePrepaid 即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。
    SecurityGroupIds.N Array of String 实例所属安全组的ID,形如sg-xxxxxxxx。该参数可以通过调用 DescribeSecurityGroups 的返回值中的SecurityGroupId字段来获取。
    示例值:sg-xxxxxxxxxx
    ScriptBootstrapActionConfig.N Array of ScriptBootstrapActionConfig 引导操作脚本设置。
    ClientToken String 唯一随机标识,时效性为5分钟,需要调用者指定 防止客户端重复创建资源,例如 a9a90aa6---****-fae360632808
    示例值:sdcdwxxxws
    NeedMasterWan String 是否开启集群Master节点公网。取值范围:
  • NEED_MASTER_WAN:表示开启集群Master节点公网。
  • NOT_NEED_MASTER_WAN:表示不开启。
  • 默认开启集群Master节点公网。
    EnableRemoteLoginFlag Boolean 是否开启外网远程登录。(在SecurityGroupId不为空时,该参数无效)不填默认为不开启 取值范围:
  • true:表示开启
  • false:表示不开启
  • EnableKerberosFlag Boolean 是否开启Kerberos认证。默认不开启 取值范围:
  • true:表示开启
  • false:表示不开启
  • CustomConf String 自定义软件配置
    Tags.N Array of Tag 标签描述列表。通过指定该参数可以同时绑定标签到相应的实例。
    DisasterRecoverGroupIds.N Array of String 分散置放群组ID列表,当前只支持指定一个。
    该参数可以通过调用 DescribeDisasterRecoverGroups的返回值中的DisasterRecoverGroupId字段来获取。
    示例值:["disa-xxxxx"]
    EnableCbsEncryptFlag Boolean 是否开启集群维度CBS加密。默认不加密 取值范围:
  • true:表示加密
  • false:表示不加密

  • 示例值:true
    MetaDBInfo CustomMetaDBInfo MetaDB信息,当MetaType选择EMR_NEW_META时,MetaDataJdbcUrl MetaDataUser MetaDataPass UnifyMetaInstanceId不用填
    当MetaType选择EMR_EXIT_META时,填写UnifyMetaInstanceId
    当MetaType选择USER_CUSTOM_META时,填写MetaDataJdbcUrl MetaDataUser MetaDataPass
    DependService.N Array of DependService 共享组件信息
    ZoneResourceConfiguration.N Array of ZoneResourceConfiguration 节点资源的规格,有几个可用区,就填几个,按顺序第一个为主可用区,第二个为备可用区,第三个为仲裁可用区。如果没有开启跨AZ,则长度为1即可。
    CosBucket String cos桶路径,创建StarRocks存算分离集群时用到

    3. 输出参数

    参数名称 类型 描述
    InstanceId String 实例ID
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:emr-xxxxx
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 创建EMR集群实例

    输入示例

    POST / HTTP/1.1
    Host: emr.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: CreateCluster
    <公共请求参数>
    
    {
        "DisasterRecoverGroupIds": [
            "disa"
        ],
        "DependService": [
            {
                "InstanceId": "emr-123",
                "ServiceName": "zookeeper"
            }
        ],
        "ZoneResourceConfiguration": [
            {
                "VirtualPrivateCloud": {
                    "SubnetId": "12",
                    "VpcId": "32"
                },
                "AllNodeResourceSpec": {
                    "CoreResourceSpec": {
                        "DataDisk": [
                            {
                                "Count": 0,
                                "DiskSize": 0,
                                "DiskType": "CLOUD_SSD"
                            }
                        ],
                        "SystemDisk": [
                            {
                                "Count": 0,
                                "DiskSize": 0,
                                "DiskType": "CLOUD_SSD"
                            }
                        ],
                        "LocalDataDisk": [
                            {
                                "Count": 0,
                                "DiskSize": 0,
                                "DiskType": "CLOUD_SSD"
                            }
                        ],
                        "InstanceType": "S2.MEDIUM8",
                        "Tags": [
                            {
                                "TagKey": "key",
                                "TagValue": "value"
                            }
                        ]
                    },
                    "CoreCount": 0,
                    "MasterResourceSpec": {
                        "InstanceType": "S2.MEDIUM8",
                        "Tags": [
                            {
                                "TagKey": "key",
                                "TagValue": "value"
                            }
                        ]
                    },
                    "TaskCount": 0,
                    "TaskResourceSpec": {
                        "InstanceType": "S2.MEDIUM8"
                    },
                    "CommonCount": 0,
                    "MasterCount": 0
                },
                "Placement": {
                    "ProjectId": 0,
                    "Zone": "GZ"
                },
                "ZoneTag": "key"
            }
        ],
        "ScriptBootstrapActionConfig": [
            {
                "CosFileName": "file",
                "Args": [
                    "region"
                ],
                "CosFileURI": "filefads",
                "ExecutionMoment": "moment"
            }
        ],
        "Tags": [
            {
                "TagKey": "key",
                "TagValue": "value"
            }
        ],
        "NeedMasterWan": "127.0.0.1",
        "EnableCbsEncryptFlag": true,
        "MetaDBInfo": {
            "MetaDataPass": "pass",
            "MetaDataUser": "user",
            "UnifyMetaInstanceId": "instance",
            "MetaDataJdbcUrl": "",
            "MetaType": ""
        },
        "LoginSettings": {
            "Password": "",
            "PublicKeyId": ""
        },
        "SecurityGroupIds": [
            ""
        ],
        "InstanceChargeType": "",
        "ProductVersion": "",
        "ClientToken": "",
        "SceneSoftwareConfig": {
            "SceneName": "",
            "Software": [
                ""
            ]
        },
        "EnableKerberosFlag": true,
        "CustomConf": "file.xml",
        "InstanceChargePrepaid": {
            "RenewFlag": true,
            "Period": 0
        },
        "InstanceName": "name",
        "EnableRemoteLoginFlag": true,
        "EnableSupportHAFlag": true
    }

    输出示例

    {
        "Response": {
            "InstanceId": "emr-1332",
            "RequestId": "fsafa-232"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    FailedOperation 操作失败。
    FailedOperation.GetCvmServerFailed 调用cvm服务失败。
    InternalError.CdbError 内部服务调用异常。
    InternalError.CvmError 内部服务调用异常。
    InternalError.TradeCgwError 内部服务调用异常。
    InvalidParameter.HALessMasterCount 参数错误。
    InvalidParameter.IncorrectMasterCount Master节点数量无效。
    InvalidParameter.InvalidAllNodeResourceSpec 不合法的AllNodeResourceSpec参数。
    InvalidParameter.InvalidComponent 无效的组件。
    InvalidParameter.InvalidCoreCount Core节点数量无效。
    InvalidParameter.InvalidCoreDiskType 参数错误。
    InvalidParameter.InvalidCosBucket 无效的CosBucket
    InvalidParameter.InvalidDependServiceAndEnableKerberosConflict DependService和EnableKerberos参数冲突。
    InvalidParameter.InvalidDiskNum 无效的磁盘数量。
    InvalidParameter.InvalidInstanceChargeType 不合法的实例计费模式。
    InvalidParameter.InvalidInstanceType 无效的机型。
    InvalidParameter.InvalidMasterDiskType 参数错误。
    InvalidParameter.InvalidMetaType 无效的元数据表类型。
    InvalidParameter.InvalidPassword 无效密码。
    InvalidParameter.InvalidProductVersion 不合法的产品版本。
    InvalidParameter.InvalidRenewFlag 不合法自动续费标识。
    InvalidParameter.InvalidResourceSpec 无效的资源规格。
    InvalidParameter.InvalidScriptBootstrapActionConfig 不合法的引导脚本执行参数。
    InvalidParameter.InvalidSoftInfo 无效的SoftInfo。
    InvalidParameter.InvalidZone 无效的可用区。
    InvalidParameter.KerberosSupport 不合法的支持Kerberos标识。
    ResourceInsufficient.InstanceInsufficient 不支持或售罄的节点规格。
    ResourceNotFound.SubnetNotFound 找不到对应的子网。
    ResourcesSoldOut.CvmSoldOut 云服务器已售罄。