GetClusterCloneMeta - 获取集群克隆元数据

获取EMR集群克隆元数据信息,便于通过 CreateCluster API快速创建集群。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
emr:GetClusterCloneMetaget
*全部资源
*

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。

cn-hangzhou
ClusterIdstring

集群 ID。

c-b933c5aac8fe****

返回参数

名称类型描述示例值
object

返回数据

ClusterCloneMetaobject

集群克隆元数据。

RegionIdstring

地域 ID。

cn-hangzhou
ResourceGroupIdstring

资源组 ID。

rg-acfmzabjyop****
ClusterStatestring

集群状态。取值范围:

  • STARTING:启动中。
  • START_FAILED:启动失败。
  • BOOTSTRAPPING:引导操作初始化。
  • RUNNING:运行中。
  • TERMINATING:终止中。
  • TERMINATED:已终止。
  • TERMINATED_WITH_ERRORS:发生异常导致终止
  • TERMINATE_FAILED:终止失败。
RUNNING
ClusterIdstring

集群 ID。

c-b933c5aac7f7****
ClusterNamestring

集群名称。

emrtest
ClusterTypestring

集群类型。取值范围:

  • DATALAKE:新版数据湖。
  • OLAP:数据分析。
  • DATAFLOW:实时数据流。
  • DATASERVING:数据服务。
  • CUSTOM:自定义混部集群。
  • HADOOP:旧版数据湖。
DATALAKE
PaymentTypestring

付费类型。取值范围:

  • PayAsYouGo:后付费。
  • Subscription:预付费。
PayAsYouGo
SubscriptionConfigSubscriptionConfig

预付费配置。

ReleaseVersionstring

EMR 发行版。

EMR-5.6.0
DeployModestring

集群中的应用部署模式。取值范围:

  • NORMAL:非高可用部署。
  • HA:高可用部署。
HA
SecurityModestring

集群 Kerberos 安全模式。取值范围:

  • NORMAL:普通模式,不开启 Kerberos 模式。
  • KERBEROS:开启 Kerberos 模式。
NORMAL
NodeAttributesNodeAttributes

节点属性。

Tagsarray

集群标签列表。

TagTag

标签。

EmrDefaultRolestring

EMR 服务角色。

AliyunEMRDefaultRole
Applicationsarray

集群应用。

ApplicationApplication

应用。

ApplicationConfigsarray

修改过的应用配置项。

ApplicationConfigApplicationConfig

配置项。

NodeGroupsarray

节点组配置数组。数组元素个数 N 的取值范围:1~100。

NodeGroupNodeGroup

节点组。

BootstrapScriptsarray

引导脚本数组。数组元素个数 N 的取值范围:1~10。

ScriptScript

引导脚本。

ExistCloneConfigboolean

HADOOP 集群是支持克隆创建集群时传入的应用配置。取值范围:

  • False:不支持。
  • True:支持。
ScalingPoliciesarray<object>

集群各节点组的弹性伸缩策略。

ScalingPolicyobject

弹性伸缩策略。

NodeGroupIdstring

节点组 ID。

ng-869471354ecd****
ClusterIdstring

集群 ID。

c-b933c5aac8fe****
ScalingRulesarray<object>

弹性伸缩规则列表。

ScalingRuleDTOobject

弹性伸缩规则。

RuleNamestring

弹性伸缩规则名称。

scaling-out-memory
TriggerTypestring

伸缩规则类型。必填参数。取值范围:

  • TIME_TRIGGER:按时间伸缩。
  • METRICS_TRIGGER:按负载伸缩。
TIME_TRIGGER
ActivityTypestring

伸缩活动类型。必填参数。取值范围:

  • SCALE_OUT:扩容。
  • SCALE_IN:缩容。
SCALE_OUT
AdjustmentValueinteger

调整值。必填参数,需要为正数,代表需要扩容或者缩容的实例数量。

100
TimeTriggerTimeTrigger

按照时间伸缩描述。

MetricsTriggerMetricsTrigger

按照负载伸缩描述。

ScalingPolicyIdstring

伸缩策略 ID。

asp-asduwe23znl***
Constraintsobject

节点组的节点数最大最小值约束。

MaxCapacityinteger

节点组最大节点数。 默认值:2000。

200
MinCapacityinteger

节点组最小节点数。 默认值:0。

50
MaxOnDemandCapacityinteger

最大按量值。

ScalingPolicyTypestring

弹性策略类型

RequestIdstring

请求 ID。

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

示例

正常返回示例

JSON格式

{
  "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": "EAQ#86****",
      "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": "SPARK",
        "ApplicationVersion": "3.2.1"
      }
    ],
    "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-hangzhou",
        "NodeGroupId": "ng-869471354ecd****",
        "NodeGroupName": "core-1",
        "NodeGroupType": "MASTER",
        "RunningNodeCount": 3,
        "InstanceTypes": [
          "ecs.g7.2xlarge"
        ],
        "PaymentType": "Subscription",
        "DataDisks": [
          {
            "Category": "cloud_essd",
            "Size": 80,
            "PerformanceLevel": "PL1",
            "Count": 5
          }
        ],
        "SystemDisk": {
          "Category": "cloud_essd",
          "Size": 60,
          "PerformanceLevel": "PL1",
          "Count": 1
        },
        "NodeGroupState": "RESIZING",
        "AdditionalSecurityGroupIds": [
          ""
        ],
        "WithPublicIp": true,
        "VSwitchIds": [
          "vsw-bp1opd2qejvhsabfe****"
        ],
        "SpotStrategy": "NoSpot",
        "SpotBidPrices": [
          {
            "InstanceType": "ecs.g7.2xlarge",
            "BidPrice": 1000
          }
        ],
        "StateChangeReason": {
          "Code": "UserRequest",
          "Message": "The instance type is required."
        },
        "MinimalNodeCount": 0,
        "MaximalNodeCount": 200,
        "GracefulShutdown": false,
        "SpotInstanceRemedy": false,
        "NodeResizeStrategy": "PRIORITY",
        "CostOptimizedConfig": {
          "OnDemandBaseCapacity": 80,
          "OnDemandPercentageAboveBaseCapacity": 80,
          "SpotInstancePools": 2
        },
        "DeploymentSetStrategy": "NONE",
        "AutoCompensateState": false,
        "ExtraAttributes": {
          "key": "true"
        },
        "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": [
            "master-1-1"
          ],
          "NodeGroupId": "ng-869471354ecd****",
          "NodeGroupIds": [
            "ng-869471354ecd****"
          ],
          "NodeGroupTypes": [
            "MASTER"
          ],
          "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": "17:30",
              "StartTime": 1639714800000,
              "EndTime": 1639714800000,
              "LaunchExpirationTime": 600,
              "RecurrenceType": "WEEKLY",
              "RecurrenceValue": "MON,FRI,SUN"
            },
            "MetricsTrigger": {
              "TimeWindow": 30,
              "EvaluationCount": 2,
              "CoolDownInterval": 300,
              "TimeConstraints": [
                {
                  "StartTime": "06:00",
                  "EndTime": "23:59"
                }
              ],
              "ConditionLogicOperator": "Or",
              "Conditions": [
                {
                  "MetricName": "yarn_resourcemanager_queue_PendingVCores",
                  "Tags": [],
                  "Statistics": "AVG",
                  "ComparisonOperator": "LT",
                  "Threshold": 12.5
                }
              ]
            }
          }
        ],
        "ScalingPolicyId": "asp-asduwe23znl***",
        "Constraints": {
          "MaxCapacity": 200,
          "MinCapacity": 50,
          "MaxOnDemandCapacity": 0
        },
        "ScalingPolicyType": ""
      }
    ],
    "DeletionProtection": true
  },
  "RequestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****"
}

错误码

HTTP status code错误码错误信息描述
400ConflictParametersParameters that must not be used together. %s多个参数间存在冲突。
400IncompleteSignatureThe request signature is invalid.API请求签名不合法。
400InvalidActionThe action %s requested is invalid.不合法的Action。
400InvalidParameterThe specified parameter %s is not valid.参数错误。
400InvalidParameterValueThe input parameter %s is invalid or out of range.参数值超出范围。
400MissingActionThe action %s requested is missing.缺少Action参数
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.请求超时或者服务不可用。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-11-28OpenAPI 返回结构发生变更查看变更详情