Skip to content

Commit

Permalink
commit message
Browse files Browse the repository at this point in the history
  • Loading branch information
admin committed Mar 1, 2019
1 parent cc0ec5d commit 1613049
Showing 1 changed file with 154 additions and 46 deletions.
200 changes: 154 additions & 46 deletions intl.zh-CN/开发指南/API 参考/集群/创建集群.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,73 +4,181 @@

## 请求参数 {#section_wbp_dz1_kfb .section}

|字段|类型|是否必须|默认值|描述|
|字段|类型|是否必须|示例值|描述|
|--|--|----|---|--|
|Name|String|是|无|集群的名字。长度限制为1-64个字符，只允许包含中文、字母、数字、-、\_|
|RegionId|String|是|无|目前支持华东1，华东2，华南1，华北2，华北3，美西，新加坡，德国|
|ZoneId|String|否|无|华东1（杭州）支持：cn-hangzhou-b。 华北2（北京）支持：cn-beijing-a,cn-beijing-b,cn-beijing-c|
|LogEnable|Boolean|是|无|是否启用日志保存。要使用此功能，请确保您已经开通了[OSS服务](https://www.alibabacloud.com/product/oss/)。|
|LogPath|String|否，若LogEnable==true则必须|无|OSS上日志保存的路径，类似oss://bucketname/dir|
|SecurityGroupId|String|否|无|任何一个安全组Id。可以在ECS中创建一个然后使用。需要确认的是，若使用已有的安全组，会被增加上默认安全组策略：入只开放22端口，出开放所有端口。|
|SecurityGroupName|String|否|无|如果不指定安全组Id，那么将使用这个名字创建一个新的安全组。当集群创建完成以后，可以在集群详情中看到创建的安全组Id。这个安全组将会有带有默认的安全组策略：入只开放22端口，出开放所有端口。|
|IsOpenPublicIp|Boolean|否|true|是否开启公共Ip。若开启，默认会带有8MB的带宽。|
|EmrVer|String|是|无|E-MapReduce的产品版本。如”emr-2.4.1”,”emr-3.0.1”|
|ClusterType|String|是|无|集群的类型，当前只有HADOOP类型|
|HighAvailabilityEnable|Boolean|否|false|是否开启高可用，若开启高可用，需要2台Master节点|
|MasterPwdEnable|Boolean|否|无|是否设置Master节点的root密码。|
|MasterPwd|String|否，若MasterPwdEnable==true则必须|无|需要满足ECS的密码规则：8 - 30 个字符，且同时包含任意三项（大、小写字母，数字和特殊符号）|
|EcsOrder|String|是|无|集群包含的ECS机器信息，以json形式的格式。类似如下形式，”\[\{‘NodeCount’:1, ‘NodeType’:’MASTER’,’InstanceType’:’ecs.n1.large’,’DiskType’:’CLOUD\_EFFICIENCY’,’DiskCapacity’:80,’DiskCount’:1,’Index’:1\},\{‘NodeCount’:2, ‘NodeType’:’CORE’,’InstanceType’:’ecs.n1.large’,’DiskType’:’CLOUD\_EFFICIENCY’,’DiskCapacity’:40,’DiskCount’:4,’Index’:2\}\]“ [EcsOrder](intl.zh-CN/开发指南/API 参考/数据类型/EcsOrder.md#)|
|ChargeType|String|是|无|付费类型，PostPaid：按量付费,PrePaid：包年包月|
|Period|Integer|否，当ChargeType==PrePaid时必须|无|包年包月的时长，单位：月。1,2,3,4,5,6,7,8,9,12,24,36|
|BootstrapActions|List [BootstrapAction](intl.zh-CN/开发指南/API 参考/数据类型/BootstrapAction.md#)|否|无|引导操作列表，最多16个，超过只保留前16个|
|Configurations|String|否|无|提供一个oss文件路径，该文件的内容请参见用户手册|
|VpcId|String|否|无|vpc ID|
|VSwitchId|String|否|无|vpc中交换机ID|
|NetType|String|否|classic|classic/vpc,默认classic|
|ClusterType|String|是|HADOOP|集群类型|
|EmrVer|String|是|EMR-3.15.0|EMR版本|
|Name|String|是|bi\_hadoop|集群的名字。长度限制为1-64个字符，只允许包含中文、字母、数字、-、\_|
|RegionId|String|是|cn-hangzhou|区域。目前支持华东1，华东2，华南1，华北2，华北3，美西，新加坡，德国|
|ZoneId|String|否|cn-hangzhou-e|可用区。华东1（杭州）支持：cn-hangzhou-b。 华北2（北京）支持：cn-beijing-a,cn-beijing-b,cn-beijing-c|
|AccessKeyId|String|否|LTAI8ljWyu7yj9yG|AccessKeyId|
|AuthorizeContent|String|否|0|暂时无需填写|
|AutoRenew|Boolean|否|false|包年包月集群是否自动续费|
|BootstrapAction.N.Arg|String|否|--a=b|引导操作参数|
|BootstrapAction.N.Name|String|否|name|引导操作名字|
|BootstrapAction.N.Path|String|否|oss://bucket/path|引导操作脚本路径|
|Config.N.ConfigKey|String|否|fs.trash.interval|自定义配置项的key|
|Config.N.ConfigValue|String|否|60|自定义配置项的值|
|Config.N.Encrypt|String|否|0|保留字段|
|Config.N.FileName|String|否|yarn-site|自定义配置项所属文件名|
|Config.N.Replace|String|否|0|保留字段|
|Config.N.ServiceName|String|否|YARN|自定义配置项服务名（大写）|
|DepositType|String|否|HALF\_MANAGED|托管类型|
|EasEnable|Boolean|否|false|是否高安全集群|
|HighAvailabilityEnable|Boolean|否|true|是否高可用集群，用，若开启高可用，需要2台Master节点|
|HostGroup.N.AutoRenew|Boolean|否|false|机器组机器是否自动续费|
|HostGroup.N.ChargeType|String|否|PostPaid|机器组机器付费类型|
|HostGroup.N.ClusterId|String|否|0|保留字段，无需填写|
|HostGroup.N.Comment|String|否|0|保留字段，无需填写|
|HostGroup.N.CreateType|String|否|0|保留字段，无需填写|
|HostGroup.N.DiskCapacity|Integer|否|80|机器组的数据盘容量|
|HostGroup.N.DiskCount|Integer|否|4|机器组的数据盘数量|
|HostGroup.N.DiskType|String|否|CLOUD\_SSD|机器组的数据盘类型|
|HostGroup.N.GpuDriver|String|否|cuda9|GPU驱动|
|HostGroup.N.HostGroupId|String|否|0|保留字段|
|HostGroup.N.HostGroupName|String|否|主实例组|机器组名字|
|HostGroup.N.HostGroupType|String|否|MASTER|机器组类型|
|HostGroup.N.InstanceType|String|否|ecs.mn4.2xlarge|机器组型号|
|HostGroup.N.NodeCount|Integer|否|1|机器组节点数|
|HostGroup.N.Period|Integer|否|30|包年包月时间（天）|
|HostGroup.N.SysDiskCapacity|Integer|否|80|机器组的系统盘容量|
|HostGroup.N.SysDiskType|String|否|CLOUD\_SSD|机器组的系统盘类型|
|HostGroup.N.VSwitchId|String|否|vsw-bp10tvjyc77psy0z5h0ni|虚拟交换机ID|
|InitCustomHiveMetaDB|Boolean|否|false|保留字段，无需填写|
|InstanceGeneration|String|否|ecs-3|ECS实例分代|
|IoOptimized|Boolean|否|true|是否开启IO优化，默认true|
|instanceGeneration|String|否|无|ecs系列，取值为ecs-1或者ecs-2|
|IsOpenPublicIp|Boolean|否|true|是否开启公网Ip。若开启，默认会带有8MB的带宽。|
|KeyPairName|String|否|test\_pair|密钥对|
|LogPath|String|否|oss//bucketname/path无|OSS日志路径|
|MachineType|String|否|ECS|机器类型|
|OptionSoftWareList.N|RepeatList|否|\["ZOOKEEPER","LIVY"\]|可选软件列表|
|SecurityGroupId|String|否|sg-bp1id7ajv83kmqwq2isx|安全组Id。可以在ECS中创建一个然后使用。需要确认的是，若使用已有的安全组，会被增加上默认安全组策略：入只开放22端口，出开放所有端口。|
|SecurityGroupName|String|否|emr-sg|需要新建的安全组名称。如果不指定安全组Id，那么将使用这个名字创建一个新的安全组。当集群创建完成以后，可以在集群详情中看到创建的安全组Id。这个安全组将会有带有默认的安全组策略：入只开放22端口，出开放所有端口。|
|SshEnable|Boolean|否|true|是否开启SSH|
|UseCustomHiveMetaDB|Boolean|否|false|保留字段，无需填写|
|UseLocalMetaDb|Boolean|否|true|是否使用本地Hive元数据库|
|UserDefinedEmrEcsRole|String|否|AliyunEmrEcsDefaultRole|用于ECS调用的EMR权限名|
|UserInfo.N.Password|String|否|pwd|集群密码|
|UserInfo.N.UserId|String|否|12345|knox账号的aliyun用户ID|
|UserInfo.N.UserName|String|否|tom|knox账号用户名|
|MasterPwd|String|否|pwd|master节点SSH访问密码。需要满足ECS的密码规则：8 - 30 个字符，且同时包含任意三项（大、小写字母，数字和特殊符号）|
|ChargeType|String|是|无|付费类型，PostPaid：按量付费,PrePaid：包年包月|
|Period|Integer|否|30|包年包月时间（天）|
|RelatedClusterId|String|否|C-D7958B72E59BAB88|当前集群是gateway时，其关联的主集群ID|
|Configurations|String|否|0|无需填写|
|VpcId|String|否|vpc-bp1l4urd87xlh7i4bju4h|vpc ID|
|VSwitchId|String|否|vsw-bp10tvjyc77psy0z5h0ni|交换机ID|
|WhiteListType|String|否|""|暂时无需填写|
|NetType|String|否|vpc|网络类型|

## 返回参数 {#section_xxl_hz1_kfb .section}

|字段|类型|描述|
|--|--|--|
|ClusterId|String|集群Id|
|EmrOrderId|String|Emr服务费订单Id|
|MasterOrderId|String|Master节点Ecs订单Id|
|CoreOrderId|String|Core节点Ecs订单Id|
|字段|类型|示例值|描述|
|--|--|---|--|
|RequestId|String|BF4FBAC6-B03E-4BFB-B6DB-EB53C34F2E22|请求ID|
|ClusterId|String|C-D7958B72E59BAB88|集群ID|
|EmrOrderId|String|0|EMR服务订单Id|
|MasterOrderId|String|0|Master节点Ecs订单Id|
|CoreOrderId|String|0|Core节点Ecs订单Id|

## 示例 {#section_yr3_jz1_kfb .section}

- 请求示例

```
https://emr.aliyuncs.com/?Action=CreateCluster
&Name=smokeTestCreateCluster1
&ClusterType=HADOOP
&HighAvailabilityEnable=false
&SecurityGroupId=sg-234r6xoqe
&LogEnable=false
&EmrVer=EMR+1.1.0
&ZoneId=cn-hangzhou-b
&IsOpenPublicIp=true
/?ClusterType=HADOOP
&EmrVer=EMR-3.15.0
&Name=bi_hadoop
&RegionId=cn-hangzhou
&MasterPwdEnable=false
&VpcId=vpc-239kkz237
&VSwitch=vsw-234iqq7ae
&AccessKeyId=LTAI8ljWyu7yj9yG
&AutoRenew=false
&ChargeType=PostPaid
&DepositType=HALF_MANAGED
&HighAvailabilityEnable=true
&InstanceGeneration=ecs-3
&IoOptimized=true
&IsOpenPublicIp=true
&KeyPairName=
&LogPath=oss//bucketname/path
&MachineType=ECS
&MasterPwd=pwd
&NetType=vpc
&EcsOrder=[{"nodeCount":1,"nodeType":"master","instanceType":"ecs.n1.large","diskType":"CLOUD_EFFICIENCY","diskCapacity":80}]
&公共请求参数
&OptionSoftWareList.1=["ZOOKEEPER","LIVY"]
&Period=30
&SecurityGroupId=
&SecurityGroupName=
&SshEnable=
&UseLocalMetaDb=
&UserDefinedEmrEcsRole=AliyunEmrEcsDefaultRole
&VpcId=vpc-bp1l4urd87xlh7i4bju4h
&VSwitchId=vsw-bp10tvjyc77psy0z5h0ni
&ZoneId=cn-hangzhou-e
&BootstrapAction.1.Arg=--a=b
&BootstrapAction.1.1ame=name
&BootstrapAction.1.Path=oss://bucket/path
&Config.1.ConfigKey=
&Config.1.ConfigValue=
&Config.1.Encrypt=
&Config.1.FileName=
&Config.1.Replace=
&Config.1.ServiceName=
&HostGroup.1.AutoRenew=false
&HostGroup.1.ChargeType=PostPaid
&HostGroup.1.ClusterId=
&HostGroup.1.Comment=
&HostGroup.1.CreateType=
&HostGroup.1.DiskCapacity=80
&HostGroup.1.DiskCount=4
&HostGroup.1.DiskType=CLOUD_SSD
&HostGroup.1.GpuDriver=
&HostGroup.1.HostGroupId=
&HostGroup.1.HostGroupName=主实例组
&HostGroup.1.HostGroupType=MASTER
&HostGroup.1.InstanceType=ecs.mn4.2xlarge
&HostGroup.1.1odeCount=1
&HostGroup.1.Period=30
&HostGroup.1.SysDiskCapacity=80
&HostGroup.1.SysDiskType=CLOUD_SSD
&HostGroup.1.VSwitchId=vsw-bp10tvjyc77psy0z5h0ni
&UserInfo.1.Password=pwd
&UserInfo.1.UserId=12345
&UserInfo.1.UserName=
&AuthorizeContent=
&Configurations=
&EasEnable=false
&InitCustomHiveMetaDB=
&RelatedClusterId=
&UseCustomHiveMetaDB=
&WhiteListType=
&<公共请求参数>
```
- 正常返回示例
JSON 格式
```
{
"ClusterId":"C-4DE6DA872B0E0D58",
"RequestId":"F4DE89FB-7054-475C-B7E2-B9A38152DA7E"
}
```
- 返回格式
- 异常返回示例
JSON 格式
```
{
"RequestId": "34B08619-2636-49F9-AB4E-CD8D347B1E07",
"InstanceId": "C-13A570B821D4BAB3"
"code":"RAM.Permission.NotAllow",
"message":"It is not allow to execute this operation,please use RAM to authorize!",
"requestId":"9AEDC439-1F63-491D-B8C6-9737C372BF3A",
"successResponse":false
}
```
## 错误码 {#section_img_my5_cgb .section}
[查看本产品错误码](https://error-center.alibabacloud.com/status/product/Emr)

0 comments on commit 1613049

Please sign in to comment.