この API を呼び出して、クラスターテンプレートを作成できます。クラスターテンプレートは、データ開発中に新しいクラスターを初期化するために使用します。
デバッグ
リクエストパラメーター
| パラメーター | データ型 | 必須／任意 | 例 | 説明 |
|---|---|---|---|---|
| Action | String | 必須 | CreateClusterTemplate |
実行する API ( CreateLaunchTemplate) を設定します。 |
| ClusterType | String | 必須 | HADOOP |
クラスターのタイプを設定します。 |
| TemplateName | String | 必須 | templateName2 |
テンプレートの名前を設定します。 |
| EmrVer | String | 必須 | EMR-3.15.0 |
クラスターのバージョンを設定します。 |
| RegionId | String | 必須 | cn-hangzhou |
クラスターが配置されているリージョンの ID を設定します。 |
| Configurations | String | 任意 | [{"classification": "core-site","properties": {"fs.trash.interval": "61"}},{"classification": "hadoop-log4j","properties": {"hadoop.log.file": "hadoop1.log","hadoop.root.logger": "INFO","a.b.c": "ABC"}}] |
ソフトウェアのカスタム設定項目です。 JSON ファイルを使用して、クラスターを起動する前にソフトウェアの設定を変更できます。 |
| EasEnable | Boolean | 任意 | true |
高セキュリティクラスターを使用するかどうかを指定します。 |
| HighAvailabilityEnable | Boolean | 任意 | true |
高セキュリティクラスターを使用するかどうかを指定します。 |
| InitCustomHiveMetaDb | Boolean | 任意 | true |
値がtrue の場合、hive-site.xml ファイルのinit.meta.dbの値がtrueであることを示します。 |
| InstanceGeneration | String | 任意 | ecs-3 |
クラスター内の ECS インスタンスの世代を設定します。 |
| IoOptimized | Boolean | 任意 | true |
ECS インスタンスの I/O が最適化されているかどうかを指定します。 |
| IsOpenPublicIp | Boolean | 任意 | true |
パブリック IP アドレスが割り当て済みであるかどうかを指定します。 |
| LogPath | String | 任意 | oss://bucket/path |
OSS バケットに保存されるログのパスを指定します。 |
| MachineType | String | 任意 | ECS |
ホストのタイプを設定します。 設定可能な値はデフォルト値 (ECS) のみです。 |
| MasterPwd | String | 任意 | pwd |
マスターノードのパスワードを設定します。 |
| NetType | String | 任意 | vpc |
ネットワークのタイプを指定します。 |
| OptionSoftWareList.N | RepeatList | 任意 | ["HBASE","FLINK"] |
オプションサービスのリストです。 |
| Period | Integer | 任意 | 36 |
サブスクリプションクラスターの有効期間を設定します。 |
| SecurityGroupId | String | 任意 | sg-bp1id7ajv83kmqwq**** |
セキュリティグループの ID を指定します。 |
| SecurityGroupName | String | 任意 | sg-name |
作成するセキュリティグループの名前を設定します。 |
| SshEnable | Boolean | 任意 | true |
クラスター内のホストで SSH 認証を使用するかどうかを指定します。 |
| UseCustomHiveMetaDb | Boolean | 任意 | false |
Hive Metastore を使用するかどうかを指定します。 |
| UseLocalMetaDb | Boolean | 任意 | false |
ローカルの Hive Metastore を使用するかどうかを指定します。 |
| UserDefinedEmrEcsRole | String | 任意 | AliyunEmrEcsDefaultRole |
ECS リソースにアクセスするために EMR に割り当てられている RAM ロールを設定します。 |
| VpcId | String | 任意 | vpc-bp1l4urd87xlh7i4bju4h |
VSwitch が所属する VPC の ID を設定します。 |
| VSwitchId | String | 任意 | vsw-bp10tvjyc77psy0z5h0ni |
VSwitch の ID を設定します。 |
| ZoneId | String | 任意 | cn-hangzhou-d |
リージョンの ID を設定します。 |
| BootstrapAction.N.Arg | String | 任意 | --a |
ブートストラップアクションに渡す引数を設定します。 |
| BootstrapAction.N.Name | String | 任意 | action_name |
ブートストラップアクションの名前を設定します。 |
| BootstrapAction.N.Path | String | 任意 | oss://bucket/path |
ブートストラップアクションスクリプトのパスを設定します。 |
| Config.N.ConfigKey | String | 任意 | fs.trash.interval |
カスタム設定項目のキーを設定します。 |
| 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 |
カスタム設定項目を使用して設定されたサービスの名前を設定します。 すべて大文字である必要があります。 |
| HostGroup.N.AutoRenew | Boolean | 任意 | false |
クラスターの自動スケーリングを有効にするかどうかを指定します。 |
| HostGroup.N.ChargeType | String | 任意 | PostPaid |
ノードグループの課金方法を設定します。 |
| HostGroup.N.ClusterId | String | 任意 | 0 |
予約済みパラメーターです。指定する必要はありません。 |
| HostGroup.N.Comment | String | 任意 | header |
ホストグループの説明を記載します。 |
| HostGroup.N.CreateType | String | 任意 | ON-DEMAND |
ホストグループの作成方法を設定します。 |
| HostGroup.N.DiskCapacity | Integer | 任意 | 80 |
ホストグループのデータディスク容量を設定します。 |
| HostGroup.N.DiskCount | Integer | 任意 | 1 |
ホストグループのデータディスクの数を設定します。 |
| HostGroup.N.DiskType | String | 任意 | CLOUD_EFFICIENCY |
ホストグループのデータディスクタイプを設定します。 |
| HostGroup.N.HostGroupId | String | 任意 | 0 |
予約済みパラメーターです。指定する必要はありません。 |
| HostGroup.N.HostGroupName | String | 任意 | Master instance group |
ホストグループ名を設定します。 |
| HostGroup.N.HostGroupType | String | 任意 | MASTER |
ホストグループのタイプを設定します。 |
| HostGroup.N.InstanceType | String | 任意 | ecs.g5.xlarge |
ホストグループのインスタンスタイプを設定します。 |
| HostGroup.N.MultiInstanceTypes | String | 任意 | ecs.sn1.xlarge,ecs.sn2.xlarge |
複数のインスタンスタイプをコンマ (,) で区切って設定します。 |
| HostGroup.N.NodeCount | Integer | 任意 | 2 |
インスタンス内のノード数を設定します。 |
| HostGroup.N.Period | Integer | No | 30 |
ホストグループの有効期間を設定します。 |
| HostGroup.N.SysDiskCapacity | Integer | No | 80 |
ホストグループのシステムディスク容量を設定します。 |
| HostGroup.N.SysDiskType | String | 任意 | CLOUD_SSD |
マスターノードのシステムディスクタイプを設定します。 |
| HostGroup.N.VSwitchId | String | 任意 | vsw-bp10tvjyc77psy0z5**** |
VSwitch の ID を設定します。 |
| AccessKeyId | String | 任意 | LTAI8ljWyu7y**** |
Alibaba Cloud によって提供された AccessKey ID を設定します。ユーザーの身元を識別するために使用されます。 |
| AutoRenew | Boolean | 任意 | false |
サブスクリプションを自動的に更新するかどうかを指定します。 |
| DepositType | String | 任意 | HALF_MANAGED |
クラスターのホスティングタイプを設定します。 |
レスポンスパラメーター
| パラメーター | データ型 | 例 | 説明 |
|---|---|---|---|
| ClusterTemplateId | String | CT-35498C56B3F12002 |
クラスターテンプレートの ID を示します。 |
| RequestId | String | 8CA40D40-2092-4A09-9F07-2F9C1399FB11 |
リクエストの ID を示します。 |
コーディング例
リクエストの例
http(s)://[Endpoint]/? Action=CreateClusterTemplate
&ClusterType=HADOOP
&TemplateName=templateName2
&BootstrapAction.1.1ame=action_name
&BootstrapAction.1.Path=oss://bucket/path
&Config.1.ConfigKey=fs.trash.interval
&Config.1.ConfigValue=60
&Config.1.FileName=yarn-site
&Config.1.ServiceName=YARN
&HostGroup.1.HostGroupType=MASTER
&HostGroup.1.InstanceType=ecs.g5.xlarge
&HostGroup.1.1odeCount=2
&EmrVer=EMR-3.15.0
&RegionId=cn-hangzhou
&<共通リクエストパラメーター>
通常のレスポンス例
XML 形式
<CreateClusterTemplateResponse>
<code>200</code>
<data>
<RequestId>8CA40D40-2092-4A09-9F07-2F9C1399FB11</RequestId>
<ClusterTemplateId>CT-35498C56B3F1****</ClusterTemplateId>
</data>
<requestId>8CA40D40-2092-4A09-9F07-2F9C1399FB11</requestId>
<successResponse>true</successResponse>
</CreateClusterTemplateResponse>JSON 形式
{
"successResponse":true,
"requestId":"8CA40D40-2092-4A09-9F07-2F9C1399FB11",
"data":{
"RequestId":"8CA40D40-2092-4A09-9F07-2F9C1399FB11",
"ClusterTemplateId":"CT-35498C56B3F1****"
},
"code":"200"
}エラーコード
| HTTP ステータスコード | エラーコード | エラーメッセージ | 説明 |
|---|---|---|---|
| 403 | Forbidden | User not authorized to operate on the specified resource. | 指定した操作を実行する権限がない場合に返されるエラーメッセージです。 認証については、Alibaba Cloud アカウントのユーザーにお問い合わせください。 |
| 400 | ECSInfo.DiskSize.TooSmall | disk size per ecs should be >= 80GB. | ディスク容量が現在の要件を満たすことができない場合に返されるエラーメッセージです。 ディスク容量を拡張してください。 |
| 403 | User.OtherUserResource.NotAllow | It is not allowed to operate other user's resource | 他のユーザーのリソースにアクセスする権限が付与されていない場合に返されるエラーメッセージです。 |
| 403 | User.Account.Abnormal | The User Account maybe is out of service! | Alibaba Cloud アカウントが無効な場合に返されるエラーメッセージです。 |
| 403 | Master.Pwd.Cannot.Blank | Master password can not be blank when enable password! | マスターノードのパスワードが入力されていない場合に返されるエラーメッセージです。 正しいパスワードを入力してください。 |
| 403 | LogPath.Cannot.Blank | Log path can not be blank when enablbe log! | ログパスが指定されていない場合に返されるエラーメッセージです。 正しいログパスを指定してください。 |
| 403 | EMR.Version.Not.Exist | Specified emr version [%s] does not exist in region [%s]! | 指定された EMR バージョンがが存在しない場合に返されるエラーメッセージです。 正しい EMR バージョンを指定してください。 |
| 400 | HighAvailability.Master.NodeCount.Not.Match | HighAvailability parameter does not match the master's node count | HighAvailability パラメーターの値がマスターノードの数と一致しない場合に返されるエラーメッセージです。 高可用性 (HA) クラスターには 2 つのマスターノードが必要です。 |
| 400 | HighAvailability.is.not.permitted.in.this.emr.version | HighAvailability parameter is not permitted in this emr version | EMR バージョンが HA クラスターをサポートしていない場合に返されるエラーメッセージです。 有効なEMRバージョンを指定してください。 |
| 400 | InvalidParameter.Period | Invalid parameter 'period'. | サブスクリプションクラスターのパラメーター "period" が正しくない場合に返されるエラーです。 |
| 400 | Balance.Not.Enough | Account balance is not enough! | Alibaba Cloud アカウントの残高が不足している場合に返されるエラーメッセージです。 アカウントの残高は CNY 100 以上である必要があります。 |
| 403 | VSwitch.NotBelongTo.Zone | VSwitchid should belong to the ZoneId! | 指定された VSwitch がゾーン内に存在しない場合に返されるエラーメッセージです。 |
| 400 | InsufficientBalance | Your account does not have enough balance. | Alibaba Clound アカウントの残高が不足している場合に返されるエラーメッセージです。 アカウントの残高は CNY 100 以上である必要があります。 |
| 400 | Create.PrePaid.Cluster.Failed | Create prepaid cluster order failed:[%s] | サブスクリプションクラスターの作成時にエラーが発生した場合に返されるエラーメッセージです。 |
| 400 | ECSInfo.ECSOrder.INVALID | invalid parameter format(ecsorderinfo) | ECS インスタンスの作成時に正しく設定されていないパラメーターが存在した場合に返されるエラーメッセージです。 |
| 400 | Ecs.InstanceType.NotSupported | Unsupported ecs instance type [%s] at zone [%s] with IO-optimized [%s] and network type [%s]. | サポート外のインスタンスタイプが指定された場合に返されるエラーメッセージです。 インスタンスタイプを選択し直してください。 |
| 400 | DiskType.Invalid | Unsupported disk type [%s] at zone [%s] with IO-optimized [%s] and network type [%s]. | サポートされていないディスクタイプが指定された場合に返されるエラーメッセージです。 ディスクタイプを選択し直してください。 |
| 400 | Unsupported.DiskType | Ecs instance type [%s] does not support disk type [%] | ECS インスタンスがサポートしていないディスクタイプが指定された場合に返されるエラーメッセージです。 |
| 400 | Unsupported.ZoneId | Zone [%s] is invalid or not supported in emr | 指定されたゾーンにインスタンスを作成できない場合に返されるエラーメッセージです。 ゾーンを変更してください。 |
| 400 | ECSInfo.DiskSize.TooBig | Disk size exceeded max value limit. | ディスクサイズが上限を超えた場合に返されるエラーメッセージです。 ディスクサイズを縮小してください。 |
| 400 | ECSInfo.DiskCount.ExceedLimit | Disk count exceeded max value limit. | ディスクブロックの数が上限を超えた場合に返されるエラーメッセージです。 ディスクブロックの数を削減してください。 |
| 400 | ECSInfo.NodeType.Unsupported | the specify node type is unsupport. | サポート外のネットワークタイプが指定された場合に返されるエラーメッセージです。 サポートされているノードタイプを選択してください。 |
| 400 | Must.Specify.MasterNode | master node is mandatory. | マスターノードを指定していない場合に返されるエラーメッセージです。 |
| 400 | Only.Support.One.Master | Only one master node is supported in emr cluster | EMR クラスターのマスターノード数が 1 以外の場合に返されるエラーメッセージです。 |
| 400 | Have.Orders.Wait.For.Pay | Have other orders wait for pay | 他の注文に対する支払が完了していない場合に返されるエラーメッセージです。 |
| 400 | Unsupported.IoOptimization.Option | IO-optimization option [%s] is not supported at zone [%s] and network type [%s]. | 現在のゾーンで I/O 最適化 インスタンスがサポートされていない場合に返されるエラーメッセージです。 |
| 400 | Unsupported.EcsInstanceGeneration | Unsupported ecs instance generation [%s] at zone [%s] with IO-optimized [%s] and network type [%s]. | 現在のゾーンのネットワークタイプで I/O 最適化 インスタンスがサポートされていない場合に返されるエラーメッセージです。 |
| 400 | AuthRealNameNotPass | User real name authenticate failed! | Alibaba Clound アカウントの実名検証に失敗した場合に返されるエラーメッセージです。 |
| 403 | EMR.Version.OptionSoftWare.UnSupported | only emr version >= 2.0.0 support optionsoftware. | オプションのソフトウエアを設定できない場合に返されるエラーメッセージです。 オプションソフトウエアの設定は、EMR 2.0.0 以降のバージョンでのみサポートされています |
| 403 | Check.Account.Failed | Verify account's registration info failed:[%s]. | Alibaba Cloud アカウントに関する情報が不完全でアカウントの確認時にエラーが発生した場合に返されるエラーメッセージです。 アカウントに関する情報をすべて入力します。 |
| 500 | InternalError | The request processing has failed due to some unknown error. | 内部エラーが発生した場合に返されるエラーメッセージです。 チケットを起票してください。 |
エラーコードについては、「API エラーセンター」をご参照ください。