You need to enable JavaScript to run this app.
导航
DescribeCluster(集群详情)
最近更新时间:2023.09.22 10:38:26首次发布时间:2022.10.09 10:28:00

1 接口说明

名称: DescribeCluster
使用场景: 调用 DescribeCluster,查询 E-MapReduce(EMR)集群的基本信息,包括:付费、ECS机器概况和 EMR服务列表等。
前置条件: 已创建过 EMR 集群。

2 请求参数

RequestParam:
TOP公共参数:
Action=DescribeCluster
Version=2022-04-15
Region=cn-beijing

名称类型必填描述示例

ClusterId

String

N

EMR集群的集群ID

emr-xxx

3 请求示例

http(s)://[Endpoint]/?Action=DescribeCluster
&ClusterId=emr-12345
&Region=cn-beijing
&<公共请求参数>

4 返回参数

名称类型描述

ClusterId

String

EMR 集群的集群 ID

AccountIdLong集群创建的主账号 ID
ClusterNameString集群名称
ClusterTypeString集群类型

Status

String

集群状态,取值如下:

  • INIT:初始化中
  • FAILED:创建失败
  • RUNNING:运行中
  • EXCEPTION:异常
  • REBOOTING:重启中
  • RELEASING:释放中
  • RELEASED:已释放
  • RESUMING:恢复中
  • EXTENDING:扩容中
  • REDUCING:缩容中
  • SHUTDOWN:关停
  • WAIT_FOR_PAY:待支付
  • BOOTSTRAPPING:引导操作运行中
  • BOOTSTRAP_FAILED:引导操作执行失败
ReleaseVersionString集群版本
PayTypeString付费类型
ProjectString集群所属项目
CreatorIdString创建者的火山引擎账号 ID
CreatorNameString创建者的火山引擎账号名称
ArchivedBoolean是否已归档
InstanceNumInteger节点数量
ExpireTimeTimeStamp到期时间
ShutDownTimeTimeStamp关停时间
LaunchTimeTimeStamp启动时间
ReleaseTimeTimeStamp释放时间
CreateTimeTimeStamp创建时间
UpdateTimeTimeStamp更新时间
ClusterMetadataHostingTypeArray服务的数据库信息
InformationObject集群的相关信息
RequiredServicesArray必选服务
OptionalServicesArray可选服务
AutoRenewBoolean是否开启自动续费
HighAvailabilityEnabledBoolean是否开启高可用
AuthorityManagementEnabledBoolean是否开启权限管理
KerberosStatusStringKerberos 状态
IsFavoriteBoolean是否已收藏
SceneIdString场景 Id
SceneNameString场景名称
CanModifyChargeTypeBoolean是否可以转换计费类型
HaVip参考 VPC 文档
VipIdStringVip 的 Id
VipAddressStringVip 的地址
EcsRoleString集群绑定的 ECS 角色
MasterNodesPublicDnsInfoArrayMASTER 节点公网域名列表
NeedRepairPortAccessRulesBoolean是否需要一键修复端口访问规则
TagsList集群标签
PhsEnabledBoolean是否开启了 public history server

5 返回示例

{
    "ResponseMetadata": {
        "RequestId": "20211231172623010174235038095xxx", 
        "Action": "DescribeCluster", 
        "Version": "2022-04-15", 
        "Service": "emr_qa", 
        "Region": "cn-north-4", 
        "Error": null
    }, 
    "Result": {
        "ClusterId": "emr-xxx",
        "AccountId": 2100001324,
        "ClusterName": "Ambari接口代理测试",
        "ClusterType": "Hadoop",
        "Status": "RUNNING",
        "ReleaseVersion": "1.2.0",
        "ChargeType": "PostPaid",
        "Project": "default",
        "CreatorId": 25557,
        "CreatorName": "emr_dp",
        "Archived": false,
        "instanceNum": 3,
        "ExpireTime": null,
        "ShutDownTime": null,
        "LaunchTime": "2022-02-25T19:24:01",
        "ReleaseTime": null,
        "CreateTime": "2022-02-25T19:14:06",
        "UpdateTime": "2022-02-28T15:33:31",
        "ClusterMetadataHostingType":[
        {
            "Correlation":"HIVE",
            "DbType":null,
            "DbConnId":null,
            "HmsId":null
        },
        {
            "Correlation":"RANGER",
            "DbType":null,
            "DbConnId":null,
            "HmsId":null
        },
        {
            "Correlation":"AIRFLOW",
            "DbType":null,
            "DbConnId":null,
            "HmsId":null
        },
        {
            "Correlation":"DOLPHIN_SCHEDULER",
            "DbType":null,
            "DbConnId":null,
            "HmsId":null
        },
        {
            "Correlation":"OOZIE",
            "DbType":null,
            "DbConnId":null,
            "HmsId":null
        }
        ],
        "Information":[
            {
                "vpcId":"vpc-13fyxxxxx",
                "securityGroupId":"sg-1xxxxx",
                "subNetId":"subnet-rrgxxxxxx",
                "region":"cn-beijing",
                "zone":"cn-beijing-b",
                "eipNetworkLine":null,
                "CauseOfFailure":null
            }
        ],
        "RequiredServices": [
            {
                "Name": "HDFS",
                "Version": "3.3.1",
                "DisplayName": "HDFS"
            },
            {
                "Name": "HIVE",
                "Version": "3.1.2",
                "DisplayName": "Hive"
            }
        ],
        "OptionalServices": [
            {
                "Name": "RANGER",
                "Version": "2.1.0",
                "DisplayName": "Ranger"
            }
        ],
        "AutoRenew": false,
        "HighAvailabilityEnabled": false,
        "KerberosStatus": "ENABLED",
        "IsFavorite": true,
        "SceneId": "DataLake",
        "SceneName": "数据湖",
        "CanModifyChargeType": true
    }
}
{
    "ResponseMetadata": {
        "RequestId": null,
        "Action": null,
        "Version": null,
        "Service": null,
        "Region": null,
        "Error": {
            "Status": 500,
            "Code": "UNKNOWN_ERROR",
            "Message": "Cluster emr-xxx is not found."
        }
    },
    "Result": null
}