1. 接口描述
接口请求域名: emr.tencentcloudapi.com 。
创建EMR集群实例
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateInstance。 |
Version | 是 | String | 公共参数,本接口取值:2019-01-03。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ProductId | 是 | Integer | 产品ID,不同产品ID表示不同的EMR产品版本。取值范围: 51:表示STARROCKS-V1.4.0 54:表示STARROCKS-V2.0.0 27:表示KAFKA-V1.0.0 50:表示KAFKA-V2.0.0 16:表示EMR-V2.3.0 20:表示EMR-V2.5.0 30:表示EMR-V2.6.0 38:表示EMR-V2.7.0 25:表示EMR-V3.1.0 33:表示EMR-V3.2.1 34:表示EMR-V3.3.0 37:表示EMR-V3.4.0 44:表示EMR-V3.5.0 53:表示EMR-V3.6.0 示例值:4 |
Software.N | 是 | Array of String | 部署的组件列表。不同的EMR产品ID(ProductId:具体含义参考入参ProductId字段)对应不同可选组件列表,不同产品版本可选组件列表查询:组件版本 ; 填写实例值:hive、flink。 示例值:["hadoop-2.8.4\n","zookeeper-3.4.9\n","knox-1.2.0\n"] |
SupportHA | 是 | Integer | 是否开启节点高可用。取值范围: 示例值:0 |
InstanceName | 是 | String | 实例名称。 示例值:emr测试 |
PayMode | 是 | Integer | 实例计费模式。取值范围: 示例值:0 |
TimeSpan | 是 | Integer | 购买实例的时长。结合TimeUnit一起使用。 示例值:3600 |
TimeUnit | 是 | String | 购买实例的时间单位。取值范围: 示例值:s |
LoginSettings | 是 | LoginSettings | 实例登录设置。通过该参数可以设置所购买节点的登录方式密码或者密钥。 |
VPCSettings | 否 | VPCSettings | 私有网络相关信息配置。通过该参数可以指定私有网络的ID,子网ID等信息。 |
ResourceSpec | 否 | NewResourceSpec | 节点资源的规格。 |
COSSettings | 否 | COSSettings | 开启COS访问需要设置的参数。 |
Placement | 否 | Placement | 实例所在的位置。通过该参数可以指定实例所属可用区,所属项目等属性。 |
SgId | 否 | String | 实例所属安全组的ID,形如sg-xxxxxxxx。该参数可以通过调用 DescribeSecurityGroups 的返回值中的SecurityGroupId字段来获取。 示例值:sg-xxxxxxxxxx |
PreExecutedFileSettings.N | 否 | Array of PreExecuteFileSettings | 引导操作脚本设置。 |
AutoRenew | 否 | Integer | 包年包月实例是否自动续费。取值范围: 示例值:0 |
ClientToken | 否 | String | 唯一随机标识,时效5分钟,需要调用者指定 防止客户端重新创建资源,例如 a9a90aa6----fae36063280 示例值:a9a90aa6----fae36063280 |
NeedMasterWan | 否 | String | 是否开启集群Master节点公网。取值范围: 示例值:NEED_MASTER_WAN |
RemoteLoginAtCreate | 否 | Integer | 是否需要开启外网远程登录,即22号端口。在SgId不为空时,该参数无效。 示例值:22 |
CheckSecurity | 否 | Integer | 是否开启安全集群。0表示不开启,非0表示开启。 示例值:0 |
ExtendFsField | 否 | String | 访问外部文件系统。 示例值:fs |
Tags.N | 否 | Array of Tag | 标签描述列表。通过指定该参数可以同时绑定标签到相应的实例。 |
DisasterRecoverGroupIds.N | 否 | Array of String | 分散置放群组ID列表,当前只支持指定一个。 该参数可以通过调用 DescribeSecurityGroups 的返回值中的SecurityGroupId字段来获取。 示例值:["disa-xxxxx"] |
CbsEncrypt | 否 | Integer | 集群维度CBS加密盘,默认0表示不加密,1表示加密 示例值:0 |
MetaType | 否 | String | hive共享元数据库类型。取值范围: 示例值:EMR_EXIT_META |
UnifyMetaInstanceId | 否 | String | EMR-MetaDB实例 示例值:instdxxxxx |
MetaDBInfo | 否 | CustomMetaInfo | 自定义MetaDB信息 |
ApplicationRole | 否 | String | 自定义应用角色。 示例值:roleName |
SceneName | 否 | String | 场景化取值: Hadoop-Kudu Hadoop-Zookeeper Hadoop-Presto Hadoop-Hbase 示例值:Hadoop-Kudu |
ExternalService.N | 否 | Array of ExternalService | 共享组件信息 |
VersionID | 否 | Integer | 如果为0,则MultiZone、MultiDeployStrategy、MultiZoneSettings是disable的状态,如果为1,则废弃ResourceSpec,使用MultiZoneSettings。 示例值:1 |
MultiZone | 否 | Boolean | true表示开启跨AZ部署;仅为新建集群时的用户参数,后续不支持调整。 示例值:false |
MultiZoneSettings.N | 否 | Array of MultiZoneSetting | 节点资源的规格,有几个可用区,就填几个,按顺序第一个为主可用区,第二个为备可用区,第三个为仲裁可用区。如果没有开启跨AZ,则长度为1即可。 |
CosBucket | 否 | String | cos桶路径,创建StarRocks存算分离集群时用到 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
InstanceId | String | 实例ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:emr-xxxxx |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建实例
输入示例
POST / HTTP/1.1
Host: emr.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateInstance
<公共请求参数>
{
"ResourceSpec": {
"MasterResourceSpec": {
"StorageType": "5",
"DiskType": "CLOUD_PREMIUM",
"Cpu": "4",
"DiskSize": "100",
"MemSize": "8192",
"RootSize": "100",
"Spec": "CVM.S2"
},
"CoreCount": "2",
"CoreResourceSpec": {
"StorageType": "5",
"DiskType": "CLOUD_PREMIUM",
"Cpu": "4",
"DiskSize": "100",
"MemSize": "8192",
"RootSize": "100",
"Spec": "CVM.S2"
},
"MasterCount": "1"
},
"Placement": {
"ProjectId": "0",
"Zone": "ap-guangzhou-3"
},
"SupportHA": "0",
"TimeSpan": "3600",
"VPCSettings": {
"SubnetId": "subnet-xxxxxxx",
"VpcId": "vpc-xxxxxx"
},
"LoginSettings": {
"Password": "tencent@cloud123"
},
"PayMode": "0",
"AutoRenew": "0",
"TimeUnit": "s",
"Software": [
"zookeeper-3.4.9",
"hadoop-2.8.4",
"knox-1.2.0"
],
"InstanceName": "emr测试",
"ProductId": "4"
}
输出示例
{
"Response": {
"RequestId": "d830face-6587-4263-8ab0-56bda265787d",
"InstanceId": "emr-xxxx"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.DuplicateOrderNotAllowed | 重复的订单,请检查emr控制台。 |
FailedOperation.GetCvmServerFailed | 调用cvm服务失败。 |
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 | 内部服务调用异常。 |
InternalError.WoodServerError | 内部服务调用异常。 |
InvalidParameter | 参数错误。 |
InvalidParameter.HALessMasterCount | 参数错误。 |
InvalidParameter.IncorrectCommonCount | Common节点数量无效。 |
InvalidParameter.IncorrectMasterCount | Master节点数量无效。 |
InvalidParameter.InvalidAutoRenew | 无效的自动续费标识。 |
InvalidParameter.InvalidClientToken | 无效的ClientToken。 |
InvalidParameter.InvalidComponent | 无效的组件。 |
InvalidParameter.InvalidCoreCount | Core节点数量无效。 |
InvalidParameter.InvalidCosBucket | 无效的CosBucket |
InvalidParameter.InvalidCosFileURI | CosFileUri参数值无效。 |
InvalidParameter.InvalidDiskSize | 无效的磁盘大小。 |
InvalidParameter.InvalidExtendField | CustomConfig参数值无效。 |
InvalidParameter.InvalidInstanceName | 无效的集群名称。 |
InvalidParameter.InvalidInstanceType | 无效的机型。 |
InvalidParameter.InvalidLoginSetting | 无效的登录设置。 |
InvalidParameter.InvalidMetaDataJdbcUrl | 无效的元数据库URL。 |
InvalidParameter.InvalidMetaType | 无效的元数据表类型。 |
InvalidParameter.InvalidPassword | 无效密码。 |
InvalidParameter.InvalidPaymode | 无效的付费类型。 |
InvalidParameter.InvalidPreExecutedFile | 无效的引导操作脚本。 |
InvalidParameter.InvalidProductId | 无效的产品ID。 |
InvalidParameter.InvalidProjectId | 无效的项目ID。 |
InvalidParameter.InvalidResourceSpec | 无效的资源规格。 |
InvalidParameter.InvalidSecuritySupport | 该EMR版本不支持开启安全模式。 |
InvalidParameter.InvalidSercurityGrpupId | 无效的安全组ID。 |
InvalidParameter.InvalidServiceName | 服务名无效。 |
InvalidParameter.InvalidSoftDeployInfo | 参数InvalidSoftDeployInfo无效或错误。 |
InvalidParameter.InvalidSoftInfo | 无效的SoftInfo。 |
InvalidParameter.InvalidSoftWare | 参数错误。 |
InvalidParameter.InvalidSoftWareName | 软件名无效。 |
InvalidParameter.InvalidSoftWareVersion | 软件版本无效。 |
InvalidParameter.InvalidSubnetId | 无效的子网ID。 |
InvalidParameter.InvalidSupportHA | 无效的高可用参数。 |
InvalidParameter.InvalidTimeSpan | 无效的timespan。 |
InvalidParameter.InvalidTimeUnit | 无效的TimeUnit。 |
InvalidParameter.InvalidUnifyMeta | 无效的统一元数据库。 |
InvalidParameter.InvalidVpcId | 无效的私有网络ID。 |
InvalidParameter.InvalidZone | 无效的可用区。 |
InvalidParameter.NotContainMustSelectSoftware | 无效参数,不满足必须组件。 |
InvalidParameter.PayModeResourceNotMatch | 付费模式与资源不匹配。 |
InvalidParameter.SoftwareNotInProduct | 存在无效的产品组件。 |
InvalidParameter.UngrantedPolicy | 策略为授权。 |
InvalidParameter.UngrantedRole | 角色未授权。 |
InvalidParameter.ZoneResourceNotMatch | 可用区与资源不匹配。 |
InvalidParameterValue | 参数取值错误。 |
LimitExceeded.SecurityGroupNumLimitExceeded | 安全组数量超过限制。 |
MissingParameter | 缺少参数错误。 |
ResourceInsufficient.DiskInsufficient | 硬盘规格不满足。 |
ResourceInsufficient.InstanceInsufficient | 不支持或售罄的节点规格。 |
ResourceNotFound.SubnetNotFound | 找不到对应的子网。 |
ResourceNotFound.TagsNotFound | 没有查找到指定标签。 |
ResourcesSoldOut | 资源售罄。 |
ResourcesSoldOut.CbsSoldOut | CBS资源售罄。 |
ResourcesSoldOut.CvmSoldOut | 云服务器已售罄。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |