接口功能介绍
此接口提供查询用户集群节点组详情功能，系统接收用户输入的查询条件，返回符合条件的集群节点组信息。
接口约束
只允许查询处于运行中状态的集群的节点组详情。
URI
POST /v2/emr/openapi/cluster/nodeGroup/getGroupAndHostByCondition
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| clusterId | 是 | String | 集群id | bdbbc8cc1288a78e5851839dc26f58b9 | |
| nodeState | 否 | Integer | 主机状态（1:启动中,2:正在关机,4:已删除,8:运行中,9:已关机） | 1 | |
| selectKey | 否 | String | 模糊查询参数，可以通过节点名称、内网IP、外网IP进行模糊查询 | 10.0.0.2 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码，成功：200，失败：500 | 200 | |
| message | String | 用来简述当前接口调用状态以及必要提示信息 | 请求成功 | |
| error | String | 错误码，请求成功时，不返回该字段 | EMR_400000 | |
| returnObj | Object | 返回结果 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| id | String | 节点组id | 175187849787779 | |
| clusterId | String | 集群id | da595eb1d81503b323fdc01d9bf786b7 | |
| payType | Integer | 付费类型 | 1 | |
| nodeGroupType | String | 节点类型code码 | MASTER | |
| nodeGroupName | String | 节点类型code值 | master | |
| imageId | String | 镜像id | f8d28855-ffda-426d-96e2-0f6bf46877e0 | |
| hostNum | Integer | 主机数量 | 3 | |
| computeSpecificationId | Integer | 主机规格id | 101 | |
| iaasVmSpecCode | String | IAAS虚机规格编码 | s7.2xlarge.4 | |
| cpuNum | Integer | cpu核数集群列表 | 8 | |
| memory | Integer | 内存大小 | 32 | |
| diskSpecificationList | String | 磁盘规格列表 | [{diskFunctionType:1,diskFunctionName:系统盘,diskType:cloud,diskTypeName:云硬盘,ioType:SSD-genric,ioTypeName:通用型SSD,volume:200,diskNum:1}] | |
| createTime | Integer | 创建时间 | 1706515356000 | |
| updateTime | Integer | 更新时间 | 1706515356000 | |
| mountPublicIp | Boolean | 是否挂载公网 | false | |
| iaasVmSpecId | String | IAAS虚机规格id | b307034d-cbc3-27bb-24f7-a97565814236 | |
| highest | Boolean | 节点组规格是否最高 | false | |
| regionId | String | 资源池id | bb9fdb42056f11eda1610242ac110002 | |
| availableZoneId | String | 可用区id | cn-huadong1-jsnj1A-public-ctcloud | |
| vpcId | String | vpc id | vpc-fr2xjo1gj0 | |
| clusterHostDtoList | Array of Objects | 集群节点组列表 | clusterHostDtoList |
表 clusterHostDtoList
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| id | String | 主键id | 0088babec7bab47b20409df6646db856 | |
| nodeGroupId | String | 节点组id | 1753298494213554178 | |
| iaasHostId | String | 平台主机id | b2f2377d-3f0b-bc74-b9c5-67bb557b0e63 | |
| hostName | String | 主机名称 | bigdata-emr-vm-l7zb3wnk | |
| manageIp | String | 管理IP | 10.2.3.0 | |
| serviceIp | String | 内网IP | 192.168.0.149 | |
| publicIp | String | 公网IP | 212.168.0.150 | |
| ipv6ServiceIp | String | ipv6内网ip | 240e:982:db0f:6c00:d1ea:8588:69fa:96 | |
| ipv6PublicIp | String | ipv6公网ip | 240e:982:db0f:6c00:d1ea:8588:69fa:97 | |
| state | Integer | 机器状态枚举(创建主机时机器状态，非即时状态） | 8 | |
| vpcId | String | vpc id | vpc-fr2xjo1gj0 | |
| subnetId | String | 子网id | subnet-vkixrw8xw7 | |
| regionId | String | 资源池id | bb9fdb42056f11eda1610242ac110002 | |
| availableZoneId | String | 可用区id | cn-huadong1-jsnj1A-public-ctcloud | |
| eipId | String | 弹性IP id | eip_sssww | |
| bandwidthId | String | 绑定ipv6的带宽id | bandwidth-fnzgeac441 | |
| jobId | String | 开机jobId | compute_8d9eabb5-89a5-44de-beae-583bf624f6d5 | |
| masterOrderId | String | IT的主订单id | b8d68f4c36734227ac4c8fb7bba58ae9 | |
| iaasMasterOrderId | String | IAAS的主订单id | INT022024091218592892305018 | |
| paasResourceId | String | 订单来源 | 6276b490c2504f4ba90e90e857b043e4 | |
| isDeleted | Integer | 判断是否删除了当前节点（发生撤单时会删除该节点）(0:未删除,1:已删除) | 0 | |
| createTime | Integer | 创建时间 | 1706515356000 | |
| updateTime | Integer | 更新时间 | 1706515356000 | |
| isDoctorAgent | Boolean | 是否安装Doctor插件 | False | |
| hostStateValue | String | 机器状态 | 运行中 | |
| deployRoleInstance | Array of Strings | 部署角色实例 | [ "NodeMaster" ] |
枚举参数
无
请求示例
请求url
https://emr-global.ctapi.ctyun.cn/v2/emr/cluster/openapi/clusterNodeGroup/getGroupAndHostByCondition
请求头header
无
请求体body
{
"clusterId":"e7afb3bd9d7117d116893c03a352f4e3"
}
响应示例
退订成功示例：
{
"statusCode": 200,
"message": "success",
"returnObj": [
{
"id": "1848620195079360514",
"clusterId": "e7afb3bd9d7117d116893c03a352f4e3",
"payType": 1,
"nodeGroupType": "MASTER",
"nodeGroupName": "master",
"imageId": "35e905b2-96f3-449d-a569-89bad1b419c5",
"hostNum": 3,
"computeSpecificationId": 98,
"iaasVmSpecCode": "s7.2xlarge.4",
"cpuNum": 8,
"memory": 32,
"diskSpecificationList": "[{\"diskFunction\":\"SYSTEM\",\"diskFunctionName\":\"系统盘\",\"diskType\":\"cloud\",\"diskTypeName\":\"云硬盘\",\"ioType\":\"SATA\",\"ioTypeName\":\"普通IO\",\"volume\":80,\"diskNum\":1},{\"diskFunction\":\"DATA\",\"diskFunctionName\":\"数据盘\",\"diskType\":\"cloud\",\"diskTypeName\":\"云硬盘\",\"ioType\":\"SATA\",\"ioTypeName\":\"普通IO\",\"volume\":80,\"diskNum\":1}]",
"createTime": 1729580375000,
"updateTime": 1730021300000,
"mountPublicIp": false,
"iaasVmSpecId": "b307034d-cbc3-27bb-24f7-a97565814236",
"highest": null,
"regionId": "bb9fdb42056f11eda1610242ac110002",
"availableZoneId": "cn-huadong1-jsnj1A-public-ctcloud",
"vpcId": "vpc-yrecox87qe",
"clusterHostDtoList": [
{
"id": "1848620196580921345",
"nodeGroupId": "1848620195079360514",
"iaasHostId": "7b9e58a6-8270-568d-c1d4-16e996f43718",
"hostName": "bigdata-vm-1729580376-k09wy",
"manageIp": "-",
"serviceIp": "192.168.0.42",
"publicIp": "-",
"ipv6ServiceIp": "",
"ipv6PublicIp": "-",
"state": 8,
"vpcId": "vpc-yrecox87qe",
"subnetId": "subnet-pxpru3r0as",
"regionId": "bb9fdb42056f11eda1610242ac110002",
"availableZoneId": "cn-huadong1-jsnj1A-public-ctcloud",
"eipId": null,
"bandwidthId": null,
"jobId": "compute_9ed0c255-998b-419f-98f8-8281f06ff485",
"masterOrderId": "",
"iaasMasterOrderId": "INT022024102214593521544350",
"paasResourceId": "PaasResourceId",
"isDeleted": 0,
"createTime": 1729580375000,
"updateTime": 1729580375000,
"hostStateValue": "运行中",
"deployRoleInstance": [
"NameNode",
"JournalNode",
"ZKFC",
"HDFSClient",
"ZKServer",
"KDCMaster",
"SSSD",
"TrinoCoordinator",
"YARNClient",
"FlinkHistoryServer",
"FlinkClient"
]
},
{
"id": "1848620196585115649",
"nodeGroupId": "1848620195079360514",
"iaasHostId": "49980a64-aa7e-44ab-6296-9c8136482c27",
"hostName": "bigdata-vm-1729580376-k09wy-0001",
"manageIp": "-",
"serviceIp": "192.168.0.46",
"publicIp": "-",
"ipv6ServiceIp": "",
"ipv6PublicIp": "-",
"state": 8,
"vpcId": "vpc-yrecox87qe",
"subnetId": "subnet-pxpru3r0as",
"regionId": "bb9fdb42056f11eda1610242ac110002",
"availableZoneId": "cn-huadong1-jsnj1A-public-ctcloud",
"eipId": null,
"bandwidthId": null,
"jobId": "compute_9ed0c255-998b-419f-98f8-8281f06ff485",
"masterOrderId": "",
"iaasMasterOrderId": "INT022024102214593521544350",
"paasResourceId": "PaasResourceId",
"isDeleted": 0,
"createTime": 1729580375000,
"updateTime": 1729580375000,
"hostStateValue": "运行中",
"deployRoleInstance": [
"JournalNode",
"HDFSClient",
"ZKServer",
"Slapd",
"SSSD",
"ResourceManager",
"JobHistory",
"YARNClient",
"FlinkClient"
]
},
{
"id": "1848620196585115650",
"nodeGroupId": "1848620195079360514",
"iaasHostId": "848b2edb-8635-149c-71dd-1cdba1035377",
"hostName": "bigdata-vm-1729580376-k09wy-0002",
"manageIp": "-",
"serviceIp": "192.168.0.48",
"publicIp": "-",
"ipv6ServiceIp": "",
"ipv6PublicIp": "-",
"state": 8,
"vpcId": "vpc-yrecox87qe",
"subnetId": "subnet-pxpru3r0as",
"regionId": "bb9fdb42056f11eda1610242ac110002",
"availableZoneId": "cn-huadong1-jsnj1A-public-ctcloud",
"eipId": null,
"bandwidthId": null,
"jobId": "compute_9ed0c255-998b-419f-98f8-8281f06ff485",
"masterOrderId": "",
"iaasMasterOrderId": "INT022024102214593521544350",
"paasResourceId": "PaasResourceId",
"isDeleted": 0,
"createTime": 1729580375000,
"updateTime": 1729580375000,
"hostStateValue": "运行中",
"deployRoleInstance": [
"NameNode",
"JournalNode",
"ZKFC",
"HDFSClient",
"ZKServer",
"KDCSlave",
"Slapd",
"SSSD",
"ResourceManager",
"YARNClient",
"FlinkClient"
]
}
]
}
]
}
请求参数类型不正确示例：
{
"statusCode": 500,
"error": "EMR_401001",
"message": "请求参数类型错误",
"returnObj": "{\"nodeState\": \"应为int范围内整数\",\"clusterId\": \"应为字符串\"}"
}
请求参数值无效示例：
{
"statusCode": 500,
"error": "EMR_401002",
"message": "请求参数值无效",
"returnObj": "{\"clusterId\":\"不能为空\"}"
}
查询无权限的集群示例：
{
"statusCode": 500,
"error": "EMR_401004",
"message": "非法操作",
"returnObj": {}
}
非运行集群无法查看示例：
{
"statusCode": 500,
"error": "EMR_401006",
"message": "非运行中集群无法查看信息",
"returnObj": {}
}
状态码
请参考 状态码
错误码
请参考 错误码
