この API を呼び出して、クラスターテンプレートの詳細情報を照会できます。
デバッグ
リクエストパラメーター
| パラメーター | データ型 | 必須／任意 | 例 | 説明 |
|---|---|---|---|---|
| Action | String | 必須 | DescribeClusterTemplate | 実行する API ( DescribeClusterTemplate) を設定します。 |
| BizId | String | 必須 | CT-35498C56B3F1**** | クラスターテンプレートの ID を設定します。 |
| AccessKeyId | String | 任意 | LTAI8ljWyu7y**** | Alibaba Cloud によって提供された AccessKey ID を設定します。ユーザーの身元を識別するために使用されます。 |
レスポンスパラメーター
| パラメーター | データ型 | 例 | 説明 |
|---|---|---|---|
| RequestId | String | 29A1D3B7-661C-4FCD-8577-DE93C8F6CA55 | リクエストの ID を示します。 |
| TemplateInfo | クラスターテンプレートの情報を示します。 | ||
| AllowNotebook | Boolean | false | Notebook アプリが許可されているかどうかを示します。 |
| BootstrapActionList | ブートストラップアクションの一覧を示します。 | ||
| BootstrapAction | ブートストラップアクションの情報を示します。 | ||
| Arg | String | --a | ブートストラップアクションに渡された引数を示します。 |
| Name | String | action_name | ブートストラップアクションの名前を示します。 |
| Path | String | oss://bucket/path | ブートストラップアクションスクリプトのパスを示します。 |
| ClusterType | String | HADOOP | クラスターのタイプを示します。 |
| ConfigList | カスタム設定項目の一覧を示します。 | ||
| Config | カスタム設定項目の情報を示します。 | ||
| ConfigKey | String | fs.trash.interval | カスタム設定項目のキーを示します。 |
| ConfigValue | String | 60 | カスタム設定項目の値を示します。 |
| Encrypt | String | 0 | 予約済みのパラメーターです。 |
| FileName | String | yarn-site | カスタム設定項目が設定されたファイルの名前を設定します。 |
| Replace | String | 0 | 予約済みのパラメーターです。 |
| ServiceName | String | YARN | カスタム設定項目を使用して設定されたサービスの名前を設定します。 すべて大文字である必要があります。 |
| 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 ファイルを使用して、クラスターを起動する前にソフトウェア設定を変更できます。 |
| CreateSource | String | 2 | クラスターテンプレートの作成方法を示します。 |
| DepositType | String | FULL_MANAGED | ホスティングタイプを示します。 |
| EasEnable | Boolean | true | クラスターが高セキュリティクラスターかどうかを示します。 |
| EmrVer | String | EMR-3.16.0 | E-MapReduce (EMR) のバージョンを示します。 |
| GmtCreate | Long | 1543765033000 | クラスターテンプレートが作成された時刻を示します。 |
| GmtModified | Long | 1543765033000 | クラスターテンプレートが変更された時刻を示します。 |
| HighAvailabilityEnable | Boolean | true | クラスターが高可用性クラスターかどうかを示します。 |
| HostGroupList | ホストグループの一覧を示します。 | ||
| HostGroup | ホストグループの情報を示します。 | ||
| ChargeType | String | PostPaid | 課金方法を設定します。 |
| DiskCapacity | Integer | 80 | ホストグループのデータディスク容量を示します。 |
| DiskCount | Integer | 4 | ホストグループのデータディスクの数を示します。 |
| DiskType | String | CLOUD_SSD | ホストグループのデータディスクタイプを示します。 |
| HostGroupId | String | 0 | 予約済みのパラメーターです。 |
| HostGroupName | String | Master instance group | ホストグループ名を示します。 |
| HostGroupType | String | MASTER | ホストグループのタイプを示します。 |
| InstanceType | String | ecs.mn4.2xlarge | ホストグループのインスタンスタイプを示します。 |
| MultiInstanceTypes | String | ecs.sn1.xlarge,ecs.sn2.xlarge | 複数のインスタンスタイプをコンマ (,) で区切って設定します。 |
| NodeCount | Integer | 2 | ホストグループ内のノード数を示します。 |
| Period | String | 36 | サブスクリプションの有効期限を 日数で示します。 |
| SysDiskCapacity | Integer | 40 | ホストグループのシステムディスク容量を示します。 |
| SysDiskType | String | CLOUD_SSD | ホストグループのシステムディスクタイプを示します。 |
| Id | String | CT-4A6799A79D73**** | クラスターテンプレートの ID を示します。 |
| InitCustomHiveMetaDb | Boolean | true | 予約済みのパラメーターです。 |
| InstanceGeneration | String | ecs-3 | クラスター内の ECS (Elastic Compute Service) インスタンスの世代を示します。 |
| IoOptimized | Boolean | true | ECS インスタンスの I/O が最適化されているかどうかを示します。 |
| IsOpenPublicIp | Boolean | true | パブリック IP アドレスが割り当てられ済みかどうかを示します。 |
| KeyPairName | String | test_kp | SSH (Secure Shell) キーペアの名前を示します。 |
| LogEnable | Boolean | true | OSS (Object Storage Service) のロギングが有効かどうかを示します。 |
| LogPath | String | oss//bucketname/path | OSS バケットに保存されるログのパスを示します。 |
| MachineType | String | ECS | クラスター内のホストのタイプを示します。 |
| MasterNodeTotal | Integer | 1 | マスターノードの数を示します。 |
| MasterPwd | String | testpd | マスターノードへのログインに使用されるパスワードを示します。 |
| MetaStoreConf | String | rds-xxx.com | Hive Metastore の設定情報を示します。 |
| MetaStoreType | String | local | Hive Metastore がデプロイされているモードを示します。 |
| NetType | String | vpc | ネットワークタイプを示します。 |
| SecurityGroupId | String | sg-bp1id7ajv83kmqwq2isx | セキュリティグループの ID を示します。 |
| SecurityGroupName | String | emr_sg | 作成するセキュリティグループの名前を設定します。 |
| SoftwareInfoList | ["ZOOKEEPER"] | オプションサービスの一覧を示します。 | |
| SoftwareInfo | オプションサービスの情報を示します。 | ||
| SshEnable | Boolean | true | SSH 認証が有効かどうかを示します。 |
| TemplateName | String | template_name_2 | クラスターテンプレートの名前を示します。 |
| UseCustomHiveMetaDb | Boolean | false | 予約済みのパラメーターです。 |
| UseLocalMetaDb | Boolean | true | ローカルの Hive メタデータベースを使用するかどうかを示します。 |
| UserDefinedEmrEcsRole | String | AliyunEmrEcsDefaultRole | ECS リソースにアクセスするために EMR に割り当てられている RAM ロールを示します。 |
| UserId | String | 125046002175**** | ユーザーの ID を示します。 |
| VSwitchId | String | vsw-bp10tvjyc77psy0z5**** | VSwitch の ID を示します。 |
| VpcId | String | vpc-bp1l4urd87xlh7i4b**** | クラスターが所属する VPC の ID を示します。 |
| ZoneId | String | cn-hangzhou-d | ゾーンの ID を示します。 |
コーディング例
リクエストの例
http(s)://[Endpoint]/? Action=DescribeClusterTemplate
&BizId=CT-35498C56B3F1****
&<共通リクエストパラメーター>
通常のレスポンス例
XML 形式
<DescribeClusterTemplateResponse>
<requestId>29A1D3B7-661C-4FCD-8577-DE93C8F6CA55</requestId>
<templateInfo>
<clusterType>HADOOP</clusterType>
<createSource>2</createSource>
<depositType>HALF_MANAGED</depositType>
<easEnable>false</easEnable>
<emrVer>EMR-3.16.0</emrVer>
<gmtCreate>1543765033000</gmtCreate>
<gmtModified>1543765033000</gmtModified>
<highAvailabilityEnable>false</highAvailabilityEnable>
<hostGroupList>
<chargeType>PostPaid</chargeType>
<diskCapacity>80</diskCapacity>
<diskCount>1</diskCount>
<diskType>CLOUD_EFFICIENCY</diskType>
<hostGroupId></hostGroupId>
<hostGroupName>Master instance group</hostGroupName>
<hostGroupType>MASTER</hostGroupType>
<instanceType>ecs.n4.xlarge</instanceType>
<nodeCount>1</nodeCount>
</hostGroupList>
<hostGroupList>
<chargeType>PostPaid</chargeType>
<diskCapacity>80</diskCapacity>
<diskCount>4</diskCount>
<diskType>CLOUD_EFFICIENCY</diskType>
<hostGroupId></hostGroupId>
<hostGroupName>Core instance group</hostGroupName>
<hostGroupType>CORE</hostGroupType>
<instanceType>ecs.n4.xlarge</instanceType>
<nodeCount>2</nodeCount>
</hostGroupList>
<id>CT-35498C56B3F1****</id>
<ioOptimized>true</ioOptimized>
<isOpenPublicIp>true</isOpenPublicIp>
<logEnable>false</logEnable>
<machineType>ECS</machineType>
<masterNodeTotal>0</masterNodeTotal>
<netType>vpc</netType>
<securityGroupId>sg-bp1id7ajv83kmqwq****</securityGroupId>
<securityGroupName>emxxx</securityGroupName>
<softwareInfoList>FLUME</softwareInfoList>
<softwareInfoList>FLINK</softwareInfoList>
<sshEnable>false</sshEnable>
<templateName>template_name_2</templateName>
<useLocalMetaDb>true</useLocalMetaDb>
<userDefinedEmrEcsRole>AliyunEmrEcsDefaultRole</userDefinedEmrEcsRole>
<userId>125046002175****</userId>
<vSwitchId>vsw-bp10tvjyc77psy0z5****</vSwitchId>
<vpcId>vpc-bp1l4urd87xlh7i4b****</vpcId>
<zoneId>cn-hangzhou-b</zoneId>
</templateInfo>
</DescribeClusterTemplateResponse>JSON 形式
{
"requestId":"29A1D3B7-661C-4FCD-8577-DE93C8F6CA55",
"templateInfo":{
"gmtModified":1543765033000,
"clusterType":"HADOOP",
"logEnable":false,
"configList":[],
"id":"CT-35498C56B3F1****",
"emrVer":"EMR-3.16.0",
"useLocalMetaDb":true,
"masterNodeTotal":0,
"vpcId":"vpc-bp1l4urd87xlh7i4b****",
"userId":"125046002175****",
"isOpenPublicIp":true,
"highAvailabilityEnable":false,
"depositType":"HALF_MANAGED",
"gmtCreate":1543765033000,
"machineType":"ECS",
"sshEnable":false,
"vSwitchId":"vsw-bp10tvjyc77psy0z5****",
"bootstrapActionList":[],
"securityGroupId":"sg-bp1id7ajv83kmqwq****",
"easEnable":false,
"zoneId":"cn-hangzhou-b",
"userDefinedEmrEcsRole":"AliyunEmrEcsDefaultRole",
"softwareInfoList":[
"FLUME",
"FLINK"
],
"hostGroupList":[
{
"instanceType":"ecs.n4.xlarge",
"diskCount":1,
"diskCapacity":80,
"diskType":"CLOUD_EFFICIENCY",
"chargeType":"PostPaid",
"hostGroupName":"Master instance group",
"hostGroupId":"",
"nodeCount":1,
"hostGroupType":"MASTER"
},
{
"instanceType":"ecs.n4.xlarge",
"diskCount":4,
"diskCapacity":80,
"diskType":"CLOUD_EFFICIENCY",
"chargeType":"PostPaid",
"hostGroupName":"Core instance group",
"hostGroupId":"",
"nodeCount":2,
"hostGroupType":"CORE"
}
],
"netType":"vpc",
"securityGroupName":"emxxx",
"ioOptimized":true,
"createSource":"2",
"templateName":"template_name_2"
}
}エラーコード
| HTTP ステータスコード | エラーコード | エラーメッセージ | 説明 |
|---|---|---|---|
| 403 | Params.Illegal | The specified parameters are wrongly formed.. | 指定されたパラメータの書式が正しくない場合に返されるエラーメッセージです。 |
| 403 | User.OtherUserResource.NotAllow | It is not allowed to operate other user's resource | 他のユーザーのリソースを管理する権限が付与されていない場合に返されるエラーメッセージです。 |
| 500 | InternalError | The request processing has failed due to some unknown error. | 内部エラーが発生した場合に返されるエラーメッセージです。 チケットを起票してください。 |
エラーコードについては、「API エラーセンター」をご参照ください。