All Products
Search
Document Center

E-MapReduce:GetClusterCloneMeta

Last Updated:Oct 17, 2024

Obtains metadata of the E-MapReduce (EMR) cluster that you want to clone. This helps you call the CreateCluster API operation to quickly create an EMR cluster.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID.

cn-hangzhou
ClusterIdstringYes

The cluster ID.

c-b933c5aac8fe****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

ClusterCloneMetaobject

The metadata of the cluster that you want to clone.

RegionIdstring

The region ID.

cn-hangzhou
ResourceGroupIdstring

The resource group ID.

rg-acfmzabjyop****
ClusterStatestring

The status of the cluster. Valid values:

  • STARTING
  • START_FAILED
  • BOOTSTRAPPING
  • RUNNING
  • TERMINATING
  • TERMINATED
  • TERMINATED_WITH_ERRORS
  • TERMINATE_FAILED
RUNNING
ClusterIdstring

The cluster ID.

c-b933c5aac7f7****
ClusterNamestring

The name of the cluster.

emrtest
ClusterTypestring

The cluster type. Valid values:

  • DATALAKE
  • OLAP
  • DATAFLOW
  • DATASERVING
  • CUSTOM
  • HADOOP
DATALAKE
PaymentTypestring

The billing method of the cluster. Valid values:

  • PayAsYouGo
  • Subscription
PayAsYouGo
SubscriptionConfigSubscriptionConfig

The subscription configurations.

ReleaseVersionstring

The EMR version.

EMR-5.6.0
DeployModestring

The deployment mode of master nodes in the cluster. Valid values:

  • NORMAL: regular mode.
  • HA: high availability mode.
HA
SecurityModestring

The security mode of the cluster. Valid values:

  • NORMAL: regular mode. Kerberos is not enabled.
  • KERBEROS: Kerberos mode. Kerberos is enabled.
NORMAL
NodeAttributesNodeAttributes

The attributes of all ECS instances.

Tagsarray

The list of tags.

TagTag

The tag.

EmrDefaultRolestring

The EMR service role.

AliyunEMRDefaultRole
Applicationsarray

The services deployed in the cluster.

ApplicationApplication

The service.

ApplicationConfigsarray

The modified configuration items.

ApplicationConfigApplicationConfig

The configuration item.

NodeGroupsarray

The node groups. Number of elements in the array: 1 to 100.

NodeGroupNodeGroup

The node group.

BootstrapScriptsarray

The bootstrap actions. Number of elements in the array: 1 to 10.

ScriptScript

The bootstrap action.

ExistCloneConfigboolean

Indicates whether the service configurations of a Hadoop cluster that you made during cluster creation can be cloned. Valid values:

  • False
  • True
ScalingPoliciesarray<object>

The auto scaling policies of each node group in the cluster.

ScalingPolicyobject

The auto scaling policy.

NodeGroupIdstring

The node group ID.

ng-869471354ecd****
ClusterIdstring

The cluster ID.

c-b933c5aac8fe****
ScalingRulesarray<object>

The list of auto scaling rules.

ScalingRuleDTOobject

The auto scaling rule.

RuleNamestring

The name of the auto scaling rule.

scaling-out-memory
TriggerTypestring

The trigger mode of the auto scaling rule. This parameter is required. Valid values:

  • TIME_TRIGGER: time-based scaling.
  • METRICS_TRIGGER: load-based scaling.
TIME_TRIGGER
ActivityTypestring

The scaling type. This parameter is required. Valid values:

  • SCALE_OUT
  • SCALE_IN
SCALE_OUT
AdjustmentValueinteger

The adjustment value of the auto scaling rule. This parameter is required. The parameter value must be a positive integer, which indicates the number of instances to be added or removed.

100
TimeTriggerTimeTrigger

The description of time-based scaling.

MetricsTriggerMetricsTrigger

The description of load-based scaling.

ScalingPolicyIdstring

The ID of the auto scaling policy.

asp-asduwe23znl***
Constraintsobject

The maximum and minimum number of nodes in the node group.

MaxCapacityinteger

The maximum number of nodes in the node group. Default value: 2000.

200
MinCapacityinteger

The minimum number of nodes in the node group. Default value: 0.

50
RequestIdstring

The request ID.

DD6B1B2A-5837-5237-ABE4-FF0C8944****

Examples

Sample success responses

JSONformat

{
  "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****",
      "DiskEncrypted": false,
      "DiskKMSKeyId": "0e478b7a-4262-4802-b8cb-00d3fb40****",
      "DataDiskEncrypted": false,
      "DataDiskKMSKeyId": "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",
        "Status": "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,
        "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": ""
      }
    ],
    "BootstrapScripts": [
      {
        "ScriptName": "",
        "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
        }
      }
    ]
  },
  "RequestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****"
}

Error codes

HTTP status codeError codeError message
400ConflictParametersParameters that must not be used together. %s
400IncompleteSignatureThe request signature is invalid.
400InvalidActionThe action %s requested is invalid.
400InvalidParameterThe specified parameter %s is not valid.
400InvalidParameterValueThe input parameter %s is invalid or out of range.
400MissingActionThe action %s requested is missing.
400MissingParameterThe input parameter %s that is mandatory for processing this request is not supplied.
400NotAuthorizedYou do not have permission to perform this action. %s
400ThrottlingExceptionThe request was denied due to request throttling. %s
404ResourceNotFoundThe resource not found by %s.
500InternalErrorThe request processing has failed due to some unknown error, exception or failure.
503ServiceFailureThe request has failed due to a temporary failure of %s service.
503ServiceUnavailableThe request has failed due to a temporary failure of the server.

For a list of error codes, visit the Service error codes.