EMR クラスタークローンメタデータ API リファレンス - E-MapReduce

E-MapReduce (EMR) クラスターのクローンメタデータを取得します。このメタデータを使用すると、CreateCluster 操作を呼び出してクラスターを迅速に作成できます。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

emr:GetClusterCloneMeta

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リージョン ID。	cn-hangzhou
ClusterId	string	必須	クラスター ID。	c-b933c5aac8fe****

レスポンスフィールド

フィールド	型	説明	例
	object	戻り値。
ClusterCloneMeta	object	クラスターのクローンメタデータ。
RegionId	string	リージョン ID。	cn-hangzhou
ResourceGroupId	string	リソースグループ ID。	rg-acfmzabjyop****
ClusterState	string	クラスターの状態。有効値： STARTING：クラスターは起動中です。 START_FAILED：クラスターの起動に失敗しました。 BOOTSTRAPPING：クラスターはブートストラップアクションを実行中です。 RUNNING：クラスターは実行中です。 TERMINATING：クラスターは終了処理中です。 TERMINATED：クラスターは終了しました。 TERMINATED_WITH_ERRORS：例外によりクラスターは終了しました。 TERMINATE_FAILED：クラスターの終了に失敗しました。	RUNNING
ClusterId	string	クラスター ID。	c-b933c5aac7f7****
ClusterName	string	クラスター名。	emrtest
ClusterType	string	クラスターのタイプ。有効値： DATALAKE：データレイク。 OLAP：データ分析。 DATAFLOW：リアルタイムデータストリーム。 DATASERVING：データサービス。 CUSTOM：カスタムクラスター。 HADOOP：Hadoop。	DATALAKE
PaymentType	string	課金方法。有効値： PayAsYouGo：従量課金。 Subscription：サブスクリプション。	PayAsYouGo
SubscriptionConfig	SubscriptionConfig	サブスクリプション構成。
ReleaseVersion	string	EMR のリリースバージョン。	EMR-5.6.0
DeployMode	string	クラスター内のアプリケーションのデプロイモード。有効値： NORMAL：標準デプロイ。 HA：高可用性デプロイ。	HA
SecurityMode	string	クラスターの Kerberos セキュリティモード。有効値： NORMAL：Kerberos モードは無効です。 KERBEROS：Kerberos モードは有効です。	NORMAL
NodeAttributes	NodeAttributes	ノード属性。
Tags	array	クラスタータグのリスト。
	Tag	タグ。
EmrDefaultRole	string	EMR サーバーロール。	AliyunEMRDefaultRole
Applications	array	クラスターアプリケーション。
	Application	アプリケーション。
ApplicationConfigs	array	変更されたアプリケーション設定項目。
	ApplicationConfig	設定項目。
NodeGroups	array	ノードグループ構成の配列。配列要素の数 N は 1～100 です。
	NodeGroup	ノードグループ。
BootstrapScripts	array	ブートストラップスクリプトの配列。配列要素の数 N は 1～10 です。
	Script	ブートストラップスクリプト。
ExistCloneConfig	boolean	HADOOP クラスターをクローンする際にアプリケーション構成を渡すことができるかどうかを示します。有効値： False：サポートされていません。 True：サポートされています。	True
ScalingPolicies	array<object>	クラスター内の各ノードグループの Auto Scaling ポリシー。
	array<object>	Auto Scaling ポリシー。
NodeGroupId	string	ノードグループ ID。	ng-869471354ecd****
ClusterId	string	クラスター ID。	c-b933c5aac8fe****
ScalingRules	array<object>	スケーリングルールのリスト。
	object	スケーリングルール。
RuleName	string	スケーリングルールの名前。	scaling-out-memory
TriggerType	string	スケーリングルールのタイプ。このパラメーターは必須です。有効値： TIME_TRIGGER：時間ベースのスケーリング。 METRICS_TRIGGER：メトリックベースのスケーリング。	TIME_TRIGGER
ActivityType	string	スケーリングアクティビティのタイプ。このパラメーターは必須です。有効値： SCALE_OUT：スケールアウト。 SCALE_IN：スケールイン。	SCALE_OUT
AdjustmentValue	integer	調整値。このパラメーターは必須です。正の整数である必要があります。追加または削除するインスタンスの数を指定します。	100
TimeTrigger	TimeTrigger	時間ベースのスケーリングルールの説明。
MetricsTrigger	MetricsTrigger	メトリックベースのスケーリングルールの説明。
ScalingPolicyId	string	スケーリングポリシー ID。	asp-asduwe23znl***
Constraints	object	ノードグループ内のノードの最大数と最小数に関する制約。
MaxCapacity	integer	ノードグループ内のノードの最大数。デフォルト値：2000。	200
MinCapacity	integer	ノードグループ内のノードの最小数。デフォルト値：0。	50
MaxOnDemandCapacity	integer	従量課金インスタンスの最大数。	200
ScalingPolicyType	string	スケーリングポリシーのタイプ。
NodeGroupName	string	ノードグループ名。	emr-etltask
DeletionProtection	boolean	クラスターで削除保護が有効になっているかどうかを示します。有効値： true：削除保護は有効です。 false：削除保護は無効です。デフォルト値：false。	false
CollationTimeZone	CollationTimeZone
RequestId	string	リクエスト ID。	DD6B1B2A-5837-5237-ABE4-FF0C8944****

例

成功レスポンス

JSONJSON

{
  "ClusterCloneMeta": {
    "RegionId": "cn-hangzhou",
    "ResourceGroupId": "rg-acfmzabjyop****",
    "ClusterState": "RUNNING",
    "ClusterId": "c-b933c5aac7f7****",
    "ClusterName": "emrtest",
    "ClusterType": "DATALAKE",
    "PaymentType": "PayAsYouGo",
    "SubscriptionConfig": {
      "PaymentDurationUnit": "Month",
      "PaymentDuration": 12,
      "AutoPayOrder": false,
      "AutoRenew": true,
      "AutoRenewDurationUnit": "Month",
      "AutoRenewDuration": 12
    },
    "ReleaseVersion": "EMR-5.6.0",
    "DeployMode": "HA",
    "SecurityMode": "NORMAL",
    "NodeAttributes": {
      "VpcId": "vpc-bp1tgey2p0ytxmdo5****",
      "ZoneId": "cn-beijing-h",
      "SecurityGroupId": "sg-hp3abbae8lb6lmb1****",
      "RamRole": "AliyunECSInstanceForEMRRole",
      "KeyPairName": "emr_login",
      "MasterRootPassword": "Adxefswfd****",
      "SystemDiskEncrypted": false,
      "SystemDiskKMSKeyId": "0e478b7a-4262-4802-b8cb-00d3fb40****",
      "DataDiskEncrypted": false,
      "DataDiskKMSKeyId": "0e478b7a-4262-4802-b8cb-00d3fb40****",
      "DiskEncrypted": false,
      "DiskKMSKeyId": "0e478b7a-4262-4802-b8cb-00d3fb40****"
    },
    "Tags": [
      {
        "Key": "department",
        "Value": "IT"
      }
    ],
    "EmrDefaultRole": "AliyunEMRDefaultRole",
    "Applications": [
      {
        "ApplicationName": "HDFS",
        "ApplicationVersion": "2.6.0"
      }
    ],
    "ApplicationConfigs": [
      {
        "ApplicationName": "HDFS",
        "ConfigFileName": "hdfs-site.xml",
        "ConfigItemKey": "dfs.namenode.checkpoint.period",
        "ConfigItemValue": "3600s",
        "ConfigScope": "NODE_GROUP",
        "NodeGroupName": "core-1",
        "NodeGroupId": "ng-869471354ecd****"
      }
    ],
    "NodeGroups": [
      {
        "ZoneId": "cn-beijing-h",
        "NodeGroupId": "ng-869471354ecd****",
        "NodeGroupName": "core-1",
        "NodeGroupType": "CORE",
        "RunningNodeCount": 3,
        "InstanceTypes": [
          ""
        ],
        "PaymentType": "PayAsYouGo",
        "DataDisks": [
          {
            "Category": "cloud_essd",
            "Size": 80,
            "PerformanceLevel": "PL1",
            "Count": 5
          }
        ],
        "SystemDisk": {
          "Category": "cloud_essd",
          "Size": 60,
          "PerformanceLevel": "PL1",
          "Count": 1
        },
        "NodeGroupState": "CREATED",
        "AdditionalSecurityGroupIds": [
          ""
        ],
        "WithPublicIp": false,
        "VSwitchIds": [
          ""
        ],
        "SpotStrategy": "NoSpot",
        "SpotBidPrices": [
          {
            "InstanceType": "ecs.g7.2xlarge",
            "BidPrice": 1000
          }
        ],
        "StateChangeReason": {
          "Code": "MissingParameter",
          "Message": "The instance type is required."
        },
        "MinimalNodeCount": 0,
        "MaximalNodeCount": 200,
        "GracefulShutdown": false,
        "SpotInstanceRemedy": true,
        "CompensateWithOnDemand": true,
        "NodeResizeStrategy": "PRIORITY",
        "CostOptimizedConfig": {
          "OnDemandBaseCapacity": 80,
          "OnDemandPercentageAboveBaseCapacity": 80,
          "SpotInstancePools": 2
        },
        "DeploymentSetStrategy": "NONE",
        "AutoCompensateState": true,
        "ExtraAttributes": {
          "key": ""
        },
        "AckConfig": {
          "AckInstanceId": "",
          "NodeSelectors": [
            {
              "Key": "department",
              "Value": "IT"
            }
          ],
          "Tolerations": [
            {
              "Key": "",
              "Value": "",
              "Operator": "",
              "Effect": ""
            }
          ],
          "Namespace": "",
          "RequestCpu": 0,
          "RequestMemory": 0,
          "LimitCpu": 0,
          "LimitMemory": 0,
          "DataDiskStorageClass": "",
          "DataDiskSize": 0,
          "CustomLabels": [
            {
              "Key": "department",
              "Value": "IT"
            }
          ],
          "CustomAnnotations": [],
          "MountHostCgroup": true,
          "NodeAffinity": "",
          "PodAntiAffinity": "",
          "PodAffinity": "",
          "PreStartCommand": [
            ""
          ],
          "Pvcs": [
            {
              "DataDiskStorageClass": "",
              "DataDiskSize": 0,
              "Path": "",
              "Name": ""
            }
          ],
          "Volumes": [
            {
              "Name": "",
              "Path": "",
              "Type": ""
            }
          ],
          "VolumeMounts": [
            {
              "Name": "",
              "Path": ""
            }
          ]
        },
        "IaaSType": "",
        "PrivatePoolOptions": {
          "PrivatePoolIds": [
            ""
          ],
          "MatchCriteria": "Open"
        },
        "Status": "CREATED"
      }
    ],
    "BootstrapScripts": [
      {
        "ScriptName": "脚本名-1",
        "ScriptPath": "oss://bucket1/update_hosts.sh",
        "ScriptArgs": "-host 10.0.10.5 -m 30",
        "Priority": 1,
        "NodeSelector": {
          "NodeSelectType": "CLUSTER",
          "NodeNames": [
            ""
          ],
          "NodeGroupId": "ng-869471354ecd****",
          "NodeGroupIds": [
            "ng-869471354ecd****"
          ],
          "NodeGroupTypes": [
            ""
          ],
          "NodeGroupName": "master-1",
          "NodeGroupNames": [
            "master-1"
          ]
        },
        "ExecutionMoment": "BEFORE_INSTALL",
        "ExecutionFailStrategy": "FAILED_CONTINUE"
      }
    ],
    "ExistCloneConfig": true,
    "ScalingPolicies": [
      {
        "NodeGroupId": "ng-869471354ecd****",
        "ClusterId": "c-b933c5aac8fe****",
        "ScalingRules": [
          {
            "RuleName": "scaling-out-memory",
            "TriggerType": "TIME_TRIGGER",
            "ActivityType": "SCALE_OUT",
            "AdjustmentValue": 100,
            "TimeTrigger": {
              "LaunchTime": "",
              "StartTime": 1639714800000,
              "EndTime": 1639714800000,
              "LaunchExpirationTime": 600,
              "RecurrenceType": "WEEKLY",
              "RecurrenceValue": "MON,FRI,SUN"
            },
            "MetricsTrigger": {
              "TimeWindow": 30,
              "EvaluationCount": 2,
              "CoolDownInterval": 300,
              "TimeConstraints": [
                {
                  "StartTime": "06:00:00",
                  "EndTime": "23:59:59"
                }
              ],
              "ConditionLogicOperator": "Or",
              "Conditions": [
                {
                  "MetricName": "yarn_resourcemanager_root_availablememoryusage",
                  "Tags": [],
                  "Statistics": "AVG",
                  "ComparisonOperator": "LT",
                  "Threshold": 12.5
                }
              ]
            }
          }
        ],
        "ScalingPolicyId": "asp-asduwe23znl***",
        "Constraints": {
          "MaxCapacity": 200,
          "MinCapacity": 50,
          "MaxOnDemandCapacity": 200
        },
        "ScalingPolicyType": "",
        "NodeGroupName": "emr-etltask"
      }
    ],
    "DeletionProtection": false
  },
  "RequestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	ConflictParameters	Parameters that must not be used together. %s
400	IncompleteSignature	The request signature is invalid.
400	InvalidAction	The action %s requested is invalid.
400	InvalidParameter	The specified parameter %s is not valid.
400	InvalidParameterValue	The input parameter %s is invalid or out of range.
400	MissingAction	The action %s requested is missing.
400	MissingParameter	The input parameter %s that is mandatory for processing this request is not supplied.
400	NotAuthorized	You do not have permission to perform this action. %s
400	ThrottlingException	The request was denied due to request throttling. %s
500	InternalError	The request processing has failed due to some unknown error, exception or failure.
404	ResourceNotFound	The resource not found by %s.
503	ServiceFailure	The request has failed due to a temporary failure of %s service.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。