GetClusterCloneMeta - E-MapReduce - Alibaba Cloud Documentation Center

Retrieves the clone metadata of an E-MapReduce (EMR) cluster. You can use this metadata to quickly create a cluster by calling the CreateCluster operation.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

emr:GetClusterCloneMeta

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
ClusterId	string	Yes	The cluster ID.	c-b933c5aac8fe****

Response elements

Element	Type	Description	Example
	object	The returned data.
ClusterCloneMeta	object	The clone metadata of the cluster.
RegionId	string	The region ID.	cn-hangzhou
ResourceGroupId	string	The resource group ID.	rg-acfmzabjyop****
ClusterState	string	The state of the cluster. Valid values: STARTING: The cluster is starting. START_FAILED: The cluster failed to start. BOOTSTRAPPING: The cluster is performing bootstrap actions. RUNNING: The cluster is running. TERMINATING: The cluster is being terminated. TERMINATED: The cluster is terminated. TERMINATED_WITH_ERRORS: The cluster is terminated due to an exception. TERMINATE_FAILED: The cluster failed to be terminated.	RUNNING
ClusterId	string	The cluster ID.	c-b933c5aac7f7****
ClusterName	string	The cluster name.	emrtest
ClusterType	string	The type of the cluster. Valid values: DATALAKE: data lake. OLAP: data analytics. DATAFLOW: real-time data stream. DATASERVING: data service. CUSTOM: custom cluster. HADOOP: Hadoop.	DATALAKE
PaymentType	string	The billing method. Valid values: PayAsYouGo: pay-as-you-go. Subscription: subscription.	PayAsYouGo
SubscriptionConfig	SubscriptionConfig	The subscription configuration.
ReleaseVersion	string	The EMR release.	EMR-5.6.0
DeployMode	string	The deployment mode of applications in the cluster. Valid values: NORMAL: standard deployment. HA: high-availability deployment.	HA
SecurityMode	string	The Kerberos security mode of the cluster. Valid values: NORMAL: The Kerberos mode is disabled. KERBEROS: The Kerberos mode is enabled.	NORMAL
NodeAttributes	NodeAttributes	The node attributes.
Tags	array	The list of cluster tags.
	Tag	A tag.
EmrDefaultRole	string	The EMR server role.	AliyunEMRDefaultRole
Applications	array	The cluster applications.
	Application	An application.
ApplicationConfigs	array	The modified application configuration items.
	ApplicationConfig	A configuration item.
NodeGroups	array	An array of node group configurations. The number of array elements N can be from 1 to 100.
	NodeGroup	A node group.
BootstrapScripts	array	An array of bootstrap scripts. The number of array elements N can be from 1 to 10.
	Script	A bootstrap script.
ExistCloneConfig	boolean	Indicates whether the application configurations can be passed in when you clone a HADOOP cluster. Valid values: False: Not supported. True: Supported.	True
ScalingPolicies	array<object>	The Auto Scaling policies for each node group in the cluster.
	array<object>	An Auto Scaling policy.
NodeGroupId	string	The node group ID.	ng-869471354ecd****
ClusterId	string	The cluster ID.	c-b933c5aac8fe****
ScalingRules	array<object>	The list of scaling rules.
	object	A scaling rule.
RuleName	string	The name of the scaling rule.	scaling-out-memory
TriggerType	string	The type of the scaling rule. This parameter is required. Valid values: TIME_TRIGGER: time-based scaling. METRICS_TRIGGER: metric-based scaling.	TIME_TRIGGER
ActivityType	string	The type of the scaling activity. This parameter is required. Valid values: SCALE_OUT: scale-out. SCALE_IN: scale-in.	SCALE_OUT
AdjustmentValue	integer	The adjustment value. This parameter is required. It must be a positive integer. It specifies the number of instances to add or remove.	100
TimeTrigger	TimeTrigger	The description of the time-based scaling rule.
MetricsTrigger	MetricsTrigger	The description of the metric-based scaling rule.
ScalingPolicyId	string	The scaling policy ID.	asp-asduwe23znl***
Constraints	object	The constraints on the maximum and minimum number of nodes in the node group.
MaxCapacity	integer	The maximum number of nodes in the node group. Default value: 2000.	200
MinCapacity	integer	The minimum number of nodes in the node group. Default value: 0.	50
MaxOnDemandCapacity	integer	The maximum number of pay-as-you-go instances.	200
ScalingPolicyType	string	The type of the elastic policy.
NodeGroupName	string	The node group name.	emr-etltask
DeletionProtection	boolean	Indicates whether deletion protection is enabled for the cluster. Valid values: true: Deletion protection is enabled. false: Deletion protection is disabled. Default value: false.	false
CollationTimeZone	CollationTimeZone
RequestId	string	The request ID.	DD6B1B2A-5837-5237-ABE4-FF0C8944****

Examples

Success response

JSON format

{
  "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****"
}

Error codes

HTTP status code	Error code	Error message
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.