查询集群信息

最近更新时间:2019-08-01 10:36:57

接口描述

本接口(EmrDescribeCluster)用于查询集群详细信息。

接口请求域名:emr.api.qcloud.com

输入参数

以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,见 公共请求参数 页面。其中,此接口的 Action 字段为 EmrDescribeCluster。

参数名称 是否必选 类型 描述
ClusterIds.n String 数组 EMR 集群 ID,emr-xxxx 格式
ClusterNames.n String 数组 EMR 集群名字
ProjectIds.n Int 数组 项目 ID
PageNo Int 第几页,首页从1开始
PageSize Int 每页记录数,默认20

输出参数

参数名称 类型 描述
code Int 公共错误码,0表示成功,其他值表示失败。详见错误码页面的 公共错误码
message String 模块错误信息描述,与接口相关。
data.totalCnt Int 查询的集群总个数。
data.n.clusterId String 集群 ID
data.n.ftitle String 集群状态描述
data.n.clusterName String 集群名称
data.n.regionId Int 地区 ID
data.n.zoneId Int 可用区 ID
data.n.appId int 应用 ID
data.n.uin String 用户 ID
data.n.projectId Int 项目 ID
data.n.vpcId Int vpcId
data.n.subnetId Int 子网 ID
data.n.status Int 集群状态: 1:流程中,2:运行中
data.n.addtime String 集群创建时间
data.n.runetime String 集群运行时间
data.n.config.softInfo String 数组 部署软件
data.n.config.masterNodes Int Master 节点个数
data.n.config.coreNodes Int Core 节点个数
data.n.config.taskNodes Int Task 节点个数
data.n.config.comNodes Int Common 节点个数
data.n.config.masterResource.spec String Master,CVM 规格
data.n.config.masterResource.storageType Int 硬盘类型,1:本地盘,2:云硬盘,3:SSD 本地盘
data.n.config.masterResource.memSize Int 内存容量,单位为 G
data.n.config.masterResource.cpu Int CPU 核数
data.n.config.masterResource.diskSize Int 数据盘容量,单位为 G
data.n.config.coreResource.spec String Core,CVM 规格
data.n.config.coreResource.storageType Int 硬盘类型,1:本地盘,2:云硬盘,3:SSD 本地盘
data.n.config.coreResource.memSize Int 内存容量,单位为 G
data.n.config.coreResource.cpu Int CPU 核数
data.n.config.coreResource.diskSize Int 数据盘容量,单位为 G
data.n.config.taskResource.spec String Task,CVM 规格
data.n.config.taskResource.storageType Int 硬盘类型,1:本地盘,2:云硬盘,3:SSD 本地盘
data.n.config.taskResource.memSize Int 内存容量,单位为 G
data.n.config.taskResource.cpu Int CPU 核数
data.n.config.taskResource.diskSize Int 数据盘容量,单位为 G
data.n.config.comResource.spec String Common,CVM 规格
data.n.config.comResource.storageType Int 硬盘类型,1:本地盘,2:云硬盘,3:SSD 本地盘
data.n.config.comResource.memSize Int 内存容量,单位为 G
data.n.config.comResource.cpu Int CPU 核数
data.n.config.comResource.diskSize Int 数据盘容量,单位为 G
data.n.config.oncos bool 是否集成 COS
data.n.config.logCosPath String COS 日志文件路径
data.n.config.cosInfo.secretId String COS 的 secretId
data.n.config.cosInfo.secretKey String COS 的 secretKey
data.n.masterIp String 集群外网 IP
data.n.emrVersion String 集群版本

示例

输入

  https://emr.api.qcloud.com/v2/index.php?Action=EmrDescribeCluster
  &<公共请求参数>
  &ClusterId=emr-jhgtdrk6

输出

{
    "code": 0,
    "message": "",
    "codeDesc": "Success",
    "data": {
        "totalCnt": 1,
        "clusterList": [
            {
                "clusterId": "emr-jov423ny",
                "ftitle": "集群运行中",
                "clusterName": "",
                "regionId": 1,
                "zoneId": 100002,
                "appId": 1253534036,
                "projectId": 0,
                "vpcId": 8247,
                "subnetId": 26036,
                "status": 2,
                "addtime": "2017-05-10 16:09:54",
                "runetime": "0天1小时27分钟33秒",
                "config": {
                    "softInfo": [
                        "hadoop-2.7.3",
                        "zookeeper-3.4.9",
                        "hive-2.1.1",
                        "hbase-1.2.4",
                        "ganglia-3.7.2"
                    ],
                    "masterResource": {
                        "spec": "标准型.S1",
                        "storageType": 1,
                        "cpu": 8,
                        "memSize": 16,
                        "diskSize": 100
                    },
                    "coreResource": {
                        "spec": "标准型.S1",
                        "storageType": 1,
                        "cpu": 8,
                        "memSize": 16,
                        "diskSize": 500
                    },
                    "taskResource": {
                        "spec": "标准型.S1",
                        "storageType": 1,
                        "cpu": 4,
                        "memSize": 16,
                        "diskSize": 100
                    },
                    "comResource": {
                        "spec": "标准型.S1",
                        "storageType": 0,
                        "cpu": 2,
                        "memSize": 4,
                        "diskSize": 50
                    },
                    "oncos": false,
                    "logCosPath": "",
                    "cosInfo": {
                        "secretId": "",
                        "secretKey": ""
                    },
                    "masterNodes": 1,
                    "coreNodes": 2,
                    "taskNodes": 0,
                    "comNodes": 0
                },
                "masterIp": "192.168.27.199",
                "emrVersion": "EMR-V0.0.1"
            }
        ]
    }
}