1. 接口描述
接口请求域名: emr.tencentcloudapi.com 。
创建EMR容器集群实例
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateCloudInstance。 |
Version | 是 | String | 公共参数,本接口取值:2019-01-03。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceName | 是 | String | 实例名称。 示例值:emrtest |
ClusterClass | 是 | String | 容器集群类型,取值范围 示例值:EMR-TKE |
Software.N | 是 | Array of String | 部署的组件列表,不同的EMR产品ID(ProductId:具体含义参考入参ProductId字段)对应不同可选组件列表,不同产品版本可选组件列表查询:组件版本 ; 示例值:["zookeeper-3.6.3","metastore-3.1.3","openldap-2.4.44","hiveserver2-3.1.3","spark-3.3.2"] |
PlatFormType | 是 | String | 容器平台类型,取值范围 示例值:tke |
CosBucket | 是 | String | cos存储桶 示例值:sparkhistorytest-1258469122 |
EksClusterId | 否 | String | 容器集群id 示例值:cls-k4bsjrtr |
ProductId | 否 | Integer | 产品Id,不同产品ID表示不同的EMR产品版本。取值范围: 示例值:60 |
ClientToken | 否 | String | 客户端token,唯一随机标识,时效5分钟,需要调用者指定 防止客户端重新创建资源,小于等于64个字符,例如 a9a90aa6----fae36063280 示例值:a9a90aa6----fae36063280 示例值:a9a90aa6----fae36063280 |
VPCSettings | 否 | VPCSettings | 私有网络相关信息配置。通过该参数可以指定私有网络的ID,子网ID等信息。 示例值:{"SubnetId":"subnet-xxxx3hi2","VpcId":"vpc-xxxx1fu7"} |
CloudResources.N | 否 | Array of CloudResource | 所有组件角色及其对应的Pod资源请求信息 |
SgId | 否 | String | 安全组Id,为空默认创建新的安全组 示例值:sg-jfluxxxx |
MetaDBInfo | 否 | CustomMetaDBInfo | 元数据库信息 MetaDB信息,当MetaType选择EMR_NEW_META时,MetaDataJdbcUrl MetaDataUser MetaDataPass UnifyMetaInstanceId不用填 当MetaType选择EMR_EXIT_META时,填写UnifyMetaInstanceId 当MetaType选择USER_CUSTOM_META时,填写MetaDataJdbcUrl MetaDataUser MetaDataPass |
Tags.N | 否 | Array of Tag | 标签信息 |
LoginSettings | 否 | LoginSettings | 登陆密码,LoginSettings中的Password字段 示例值:{"Password":"xxxxxxxx"} |
ExternalService.N | 否 | Array of ExternalService | 共享服务信息 |
ZoneId | 否 | Integer | 可用区id 示例值:100002 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
InstanceId | String | 实例ID 示例值:emr-jkbz9e9q |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建EMR容器实例
创建EMR容器实例
输入示例
POST / HTTP/1.1
Host: emr.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCloudInstance
<公共请求参数>
{
"InstanceName": "EMR-dzrgkpwq",
"LoginSettings": {
"Password": "xxxxxxxxxx"
},
"VPCSettings": {
"SubnetId": "subnet-xxxxo3x0",
"VpcId": "vpc-xxxxqmqz"
},
"CosBucket": "coslcl-xxxxxxxxxx",
"ExternalService": [],
"CloudResources": [
{
"ComponentName": "QuorumPeerMain",
"PodNumber": 3,
"LimitCpu": 1,
"LimitMemory": 2,
"Service": "ZOOKEEPER",
"VolumeDir": {
"VolumeType": "NEW_PVC",
"HostPath": {
"Path": "",
"Type": "DirectoryOrCreate"
}
},
"Disks": [
{
"DiskType": "CLOUD_PREMIUM",
"DiskCapacity": 100,
"DiskNumber": 1
}
]
},
{
"ComponentName": "Slapd",
"PodNumber": 2,
"LimitCpu": 1,
"LimitMemory": 2,
"Service": "OPENLDAP",
"VolumeDir": {
"VolumeType": "NEW_PVC",
"HostPath": {
"Path": "",
"Type": "DirectoryOrCreate"
}
},
"Disks": [
{
"DiskType": "CLOUD_PREMIUM",
"DiskCapacity": 100,
"DiskNumber": 1
}
]
},
{
"ComponentName": "HiveServer2Node",
"PodNumber": 1,
"LimitCpu": 1,
"LimitMemory": 2,
"Service": "HIVESERVER2",
"VolumeDir": {
"VolumeType": "NEW_PVC",
"HostPath": {
"Path": "",
"Type": "DirectoryOrCreate"
}
},
"Disks": [
{
"DiskType": "CLOUD_PREMIUM",
"DiskCapacity": 100,
"DiskNumber": 1
}
]
},
{
"ComponentName": "HiveMetaStoreNode",
"PodNumber": 1,
"LimitCpu": 1,
"LimitMemory": 2,
"Service": "METASTORE",
"VolumeDir": {
"VolumeType": "NEW_PVC",
"HostPath": {
"Path": "",
"Type": "DirectoryOrCreate"
}
},
"Disks": [
{
"DiskType": "CLOUD_PREMIUM",
"DiskCapacity": 100,
"DiskNumber": 1
}
]
},
{
"ComponentName": "SparkJobHistoryServer",
"PodNumber": 1,
"LimitCpu": 2,
"LimitMemory": 4,
"Service": "SPARK",
"VolumeDir": {
"VolumeType": "NEW_PVC",
"HostPath": {
"Path": "",
"Type": "DirectoryOrCreate"
}
},
"Disks": [
{
"DiskType": "CLOUD_PREMIUM",
"DiskCapacity": 100,
"DiskNumber": 1
}
]
}
],
"Tags": [
{
"TagKey": "test-key",
"TagValue": "v1"
}
],
"MetaDBInfo": {
"MetaType": "EMR_DEFAULT_META"
},
"Software": [
"zookeeper-3.6.3",
"metastore-3.1.3",
"openldap-2.4.44",
"hiveserver2-3.1.3",
"spark-3.3.2"
],
"ClusterClass": "EMR-TKE",
"PlatFormType": "tke",
"EksClusterId": "cls-xxxxxl3o",
"ProductId": 60,
"SgId": "sg-1111123nt",
"ZoneId": 1000010
}
输出示例
{
"Response": {
"RequestId": "d830face-6587-4263-8ab0-56bda2657xxx",
"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控制台。 |
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.TKEError | TKE调用出错。 |
InternalError.TagError | 内部服务调用异常。 |
InternalError.TradeCgwError | 内部服务调用异常。 |
InternalError.VpcCgwError | 内部服务调用异常。 |
InternalError.VpcError | 内部服务调用异常。 |
InvalidParameter | 参数错误。 |
InvalidParameter.IncorrectCommonCount | Common节点数量无效。 |
InvalidParameter.IncorrectMasterCount | Master节点数量无效。 |
InvalidParameter.InvalidAutoRenew | 无效的自动续费标识。 |
InvalidParameter.InvalidCLBServerVpcSetting | ExternalAccess.ClbSetting.VpcSetting参数无效。 |
InvalidParameter.InvalidClientToken | 无效的ClientToken。 |
InvalidParameter.InvalidComponent | 无效的组件。 |
InvalidParameter.InvalidCoreCount | Core节点数量无效。 |
InvalidParameter.InvalidDiskSize | 无效的磁盘大小。 |
InvalidParameter.InvalidExtendField | CustomConfig参数值无效。 |
InvalidParameter.InvalidExternalServiceVpcId | 无效组件依赖集群vpc。 |
InvalidParameter.InvalidInstanceName | 无效的集群名称。 |
InvalidParameter.InvalidInstanceType | 无效的机型。 |
InvalidParameter.InvalidMetaInstanceId | 无效的元数据库实例Id。 |
InvalidParameter.InvalidMetaType | 无效的元数据表类型。 |
InvalidParameter.InvalidPassword | 无效密码。 |
InvalidParameter.InvalidPaymode | 无效的付费类型。 |
InvalidParameter.InvalidPreExecutedFile | 无效的引导操作脚本。 |
InvalidParameter.InvalidProductId | 无效的产品ID。 |
InvalidParameter.InvalidProjectId | 无效的项目ID。 |
InvalidParameter.InvalidResourceSpec | 无效的资源规格。 |
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.InvalidVolumeType | 参数错误。 |
InvalidParameter.InvalidVpcId | 无效的私有网络ID。 |
InvalidParameter.InvalidZone | 无效的可用区。 |
InvalidParameter.NotContainMustSelectSoftware | 无效参数,不满足必须组件。 |
InvalidParameter.PayModeResourceNotMatch | 付费模式与资源不匹配。 |
InvalidParameter.SoftwareNotInProduct | 存在无效的产品组件。 |
InvalidParameter.UngrantedPolicy | 策略为授权。 |
InvalidParameter.UngrantedRole | 角色未授权。 |
InvalidParameter.ZoneResourceNotMatch | 可用区与资源不匹配。 |
InvalidParameterValue | 参数取值错误。 |
LimitExceeded.PodCpuLimitExceededAvailableCpu | Pod Cpu请求数量超过集群限制。 |
LimitExceeded.PodCpuLimitExceededNodeAvailableCpu | Pod Cpu请求数量超过节点限制。 |
LimitExceeded.PodMemoryLimitExceededAvailableMemory | Pod 内存请求数量超过集群限制。 |
LimitExceeded.SecurityGroupNumLimitExceeded | 安全组数量超过限制。 |
MissingParameter | 缺少参数错误。 |
ResourceInsufficient.DiskInsufficient | 硬盘规格不满足。 |
ResourceInsufficient.InstanceInsufficient | 不支持或售罄的节点规格。 |
ResourceNotFound.SubnetNotFound | 找不到对应的子网。 |
ResourceNotFound.TagsNotFound | 没有查找到指定标签。 |
ResourcesSoldOut.CbsSoldOut | CBS资源售罄。 |
ResourcesSoldOut.CvmSoldOut | 云服务器已售罄。 |
UnauthorizedOperation | 未授权操作。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |