tencent cloud

弹性 MapReduce

动态与公告
产品动态
产品公告
安全公告
产品简介
产品概述
产品优势
产品架构
产品功能
应用场景
约束与限制
技术支持范围
产品发行版
购买指南
EMR on CVM 计费说明
EMR on TKE 计费说明
EMR Serverless HBase 计费说明
快速入门
EMR on CVM 快速入门
EMR on TKE 快速入门
EMR on CVM 操作指南
规划集群
管理权限
配置集群
管理集群
管理服务
监控告警
智能管家
EMR on TKE 操作指南
EMR on TKE 简介
配置集群
管理集群
管理服务
监控运维
应用分析
EMR Serverless HBase 操作指南
EMR Serverless HBase 产品简介
配额与限制
规划实例
管理实例
监控告警
开发指南
EMR 开发指南
Hadoop开发指南
Spark 开发指南
HBASE开发指南
Phoenix on Hbase 开发指南
Hive 开发指南
Presto开发指南
Sqoop 开发指南
Hue 开发指南
Oozie 开发指南
Flume 开发指南
Kerberos 开发指南
Knox 开发指南
Alluxio 开发指南
Kylin 开发指南
Livy 开发指南
Kyuubi 开发指南
Zeppelin 开发指南
Hudi 开发指南
Superset 开发指南
Impala 开发指南
Druid 开发指南
Tensorflow 开发指南
Kudu 开发指南
Ranger 开发指南
Kafka 开发指南
Iceberg 开发指南
StarRocks 开发指南
Flink 开发指南
JupyterLab 开发指南
MLflow 开发指南
实践教程
EMR on CVM 运维实践
数据迁移实践
自定义伸缩实践教程
API 文档
History
Introduction
API Category
Cluster Resource Management APIs
Cluster Services APIs
User Management APIs
Data Inquiry APIs
Scaling APIs
Configuration APIs
Other APIs
Serverless HBase APIs
YARN Resource Scheduling APIs
Making API Requests
Data Types
Error Codes
常见问题
EMR on CVM常见问题
服务等级协议
联系我们

CreateCluster

PDF
聚焦模式
字号
最后更新时间: 2025-11-13 20:49:18

1. API Description

Domain name for API request: emr.intl.tencentcloudapi.com.

This API is used to create an EMR cluster instance.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: CreateCluster.
Version Yes String Common Params. The value used for this API: 2019-01-03.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
ProductVersion Yes String The EMR version, such as EMR-V2.3.0 that indicates the version 2.3.0 of EMR. You can query the EMR version here.
EnableSupportHAFlag Yes Boolean Whether to enable high availability for nodes. Valid values:
  • true: Enable
  • false: Disable
  • InstanceName Yes String The instance name.
  • Length limit: 6-36 characters.
  • Can contain only Chinese characters, letters, digits, hyphens (-), and underscores (_).
  • InstanceChargeType Yes String The instance billing mode. Valid values:
  • POSTPAID_BY_HOUR: The postpaid mode by hour.
  • LoginSettings Yes LoginSettings The instance login setting. This parameter allows you to set a login password or key for your purchased node.
  • If a key is set, the password will be used for login to the native component WebUI only.
  • If no key is set, the password will be used for login to all purchased nodes and the native component WebUI.
  • SceneSoftwareConfig Yes SceneSoftwareConfig The configuration of cluster application scenario and supported components.
    InstanceChargePrepaid No InstanceChargePrepaid The details of the monthly subscription, including the instance period and auto-renewal. It is required if InstanceChargeType is PREPAID.
    SecurityGroupIds.N No Array of String The ID of the security group to which the instance belongs, in the format of sg-xxxxxxxx. You can call the DescribeSecurityGroups API and obtain this parameter from the SecurityGroupId field in the response.
    ScriptBootstrapActionConfig.N No Array of ScriptBootstrapActionConfig The Bootstrap action script settings.
    ClientToken No String Unique random identifier with the time efficiency of 5 minutes, which needs to be specified by the caller to prevent the client from repeatedly creating resources, for example, a9a90aa6---****-fae360632808.
    NeedMasterWan No String Whether to enable public IP access for master nodes. Valid values:
  • NEED_MASTER_WAN: Enable public IP for master nodes.
  • NOT_NEED_MASTER_WAN: Disable.
  • The public IP is enabled for master nodes by default.
    EnableRemoteLoginFlag No Boolean Whether to enable remote login over the public network. It is invalid if SecurityGroupId is passed in. It is disabled by default. Valid values:
  • true: Enable
  • false: Disable
  • EnableKerberosFlag No Boolean Whether to enable Kerberos authentication. Valid values:
  • true: Enable
  • false (default): Disable
  • CustomConf No String Custom software configuration
    Tags.N No Array of Tag The tag description list. This parameter is used to bind a tag to a resource instance.
    DisasterRecoverGroupIds.N No Array of String The list of spread placement group IDs. Only one can be specified.
    You can call the DescribeDisasterRecoverGroups API and obtain this parameter from the DisasterRecoverGroupId field in the response.
    EnableCbsEncryptFlag No Boolean Whether to enable the cluster-level CBS encryption. Valid values:
  • true: Enable
  • false (default): Disable
  • MetaDBInfo No CustomMetaDBInfo The metadatabase information. If MetaType is EMR_NEW_META, MetaDataJdbcUrl, MetaDataUser, MetaDataPass, and UnifyMetaInstanceId are not required.
    If MetaType is EMR_EXIT_META, UnifyMetaInstanceId is required.
    If MetaType is USER_CUSTOM_META, MetaDataJdbcUrl, MetaDataUser, and MetaDataPass are required.
    DependService.N No Array of DependService The shared component information.
    ZoneResourceConfiguration.N No Array of ZoneResourceConfiguration The node resource specs. A spec is specified for each AZ, with the first spec for the primary AZ, the second for the backup AZ, and the third for the arbitrator AZ. If the multi-AZ mode is not enabled, only one spec is required.
    CosBucket No String COS bucket path, which is used when you create StarRocks compute-storage separation clusters.
    NodeMarks.N No Array of NodeMark Node identifier information: currently used only in Terraform.
    LoadBalancerId No String clb id

    3. Output Parameters

    Parameter Name Type Description
    InstanceId String Instance ID.
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Creating an EMR Cluster Instance

    Input Example

    POST / HTTP/1.1
    Host: emr.intl.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: CreateCluster
    <Common request parameters>
    
    {
        "EnableKerberosFlag": false,
        "SceneSoftwareConfig": {
            "SceneName": "Hadoop-Default",
            "Software": [
                "hdfs-3.2.2",
                "yarn-3.2.2",
                "zookeeper-3.6.3",
                "openldap-2.4.44",
                "knox-1.6.1",
                "hive-3.1.3"
            ]
        },
        "MetaDBInfo": {
            "MetaType": "EMR_DEFAULT_META"
        },
        "NeedMasterWan": "NEED_MASTER_WAN",
        "EnableCbsEncryptFlag": false,
        "LoginSettings": {
            "Password": "xxxxxxx"
        },
        "SecurityGroupIds": [
            "sg-xxx"
        ],
        "InstanceChargeType": "POSTPAID_BY_HOUR",
        "ProductVersion": "EMR-V3.5.0",
        "ClientToken": "fasdlfhaldfhdlahfd4134322",
        "EnableRemoteLoginFlag": true,
        "InstanceChargePrepaid": {
            "RenewFlag": true,
            "Period": 1
        },
        "InstanceName": "EMR350-JH6",
        "EnableSupportHAFlag": false,
        "ZoneResourceConfiguration": [
            {
                "VirtualPrivateCloud": {
                    "SubnetId": "subnet-xxx",
                    "VpcId": "vpc-1df1dafd"
                },
                "AllNodeResourceSpec": {
                    "MasterResourceSpec": {
                        "SystemDisk": [
                            {
                                "Count": 1,
                                "DiskSize": 50,
                                "DiskType": "CLOUD_HSSD"
                            }
                        ],
                        "DataDisk": [
                            {
                                "Count": 1,
                                "DiskSize": 100,
                                "DiskType": "CLOUD_SSD"
                            }
                        ],
                        "LocalDataDisk": [],
                        "InstanceType": "S6.2XLARGE32",
                        "Tags": []
                    },
                    "CoreCount": 2,
                    "CoreResourceSpec": {
                        "SystemDisk": [
                            {
                                "Count": 1,
                                "DiskSize": 50,
                                "DiskType": "CLOUD_SSD"
                            }
                        ],
                        "DataDisk": [
                            {
                                "Count": 1,
                                "DiskSize": 300,
                                "DiskType": "CLOUD_TSSD"
                            }
                        ],
                        "LocalDataDisk": [],
                        "InstanceType": "SA4.8XLARGE64",
                        "Tags": []
                    },
                    "TaskCount": 0,
                    "CommonCount": 0,
                    "MasterCount": 1
                },
                "Placement": {
                    "ProjectId": 0,
                    "Zone": "ap-guangzhou-7"
                }
            }
        ]
    }

    Output Example

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

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    FailedOperation Operation failed.
    FailedOperation.GetCvmServerFailed Failed to call the CVM service.
    InternalError.CdbError An error occurred while calling another service API.
    InternalError.CvmError An error occurred while calling another service API.
    InternalError.TradeCgwError An error occurred while calling another service API.
    InvalidParameter.HALessMasterCount Parameter error.
    InvalidParameter.IncorrectMasterCount The number of master nodes is invalid.
    InvalidParameter.InvalidAllNodeResourceSpec Invalid AllNodeResourceSpec.
    InvalidParameter.InvalidComponent Invalid component.
    InvalidParameter.InvalidCoreCount The number of core nodes is invalid.
    InvalidParameter.InvalidCoreDiskType Parameter error.
    InvalidParameter.InvalidCosBucket The CosBucket parameter is invalid.
    InvalidParameter.InvalidDependServiceAndEnableKerberosConflict Conflict betweenDependService and EnableKerberos.
    InvalidParameter.InvalidDiskNum Invalid number of disks.
    InvalidParameter.InvalidInstanceChargeType Invalid instance billing mode.
    InvalidParameter.InvalidInstanceType Invalid model.
    InvalidParameter.InvalidLoadBalancer Invalid LoadBalancerId.
    InvalidParameter.InvalidMasterDiskType Invalid parameter.
    InvalidParameter.InvalidMetaType Invalid metadata table type.
    InvalidParameter.InvalidPassword Invalid password.
    InvalidParameter.InvalidProductVersion Invalid product version.
    InvalidParameter.InvalidRenewFlag Invalid auto-renewal identifier.
    InvalidParameter.InvalidResourceSpec Invalid resource specification.
    InvalidParameter.InvalidScriptBootstrapActionConfig Invalid bootstrap script execution parameter.
    InvalidParameter.InvalidSoftInfo Invalid SoftInfo.
    InvalidParameter.InvalidZone Invalid AZ.
    InvalidParameter.KerberosSupport Invalid identifier for Kerberos support.
    ResourceInsufficient.InstanceInsufficient The node specification is unsupported or has been sold out.
    ResourceNotFound.SubnetNotFound No corresponding subnet found.
    ResourcesSoldOut.CvmSoldOut CVM instances have been sold out.

    帮助和支持

    本页内容是否解决了您的问题?

    填写满意度调查问卷,共创更好文档体验。

    文档反馈