接口功能介绍
此接口提供根据集群id查询集群信息功能，返回符合条件的集群详细信息。
接口约束
只允许查询处于运行中状态的集群信息。
URI
GET /v2/emr/openapi/cluster/clusterDetail/getById
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| id | 是 | String | 集群 | e7afb3bd9d7117d116893c03a352f4e3 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码，成功：200，失败：500 | 200 | |
| message | String | 用来简述当前接口调用状态以及必要提示信息 | 请求成功 | |
| error | String | 错误码，请求成功时，不返回该字段 | EMR_400000 | |
| returnObj | Object | 返回结果 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| id | String | 集群id | 00c3a04292996955752f073c995a1cc6 | |
| managerClusterId | Integer | manager定义的集群id | 1 | |
| iaasType | String | 平台 | 公有云 | |
| regionId | String | 资源池id | bb9fdb42056f11eda1610242ac110002 | |
| regionName | String | 资源池名称 | 华东1 | |
| availableZoneId | String | 可用区id | cn-huadong1-jsnj1A-public-ctcloud | |
| availableZoneName | String | 可用区名称 | 可用区1 | |
| clusterName | String | 集群名称 | test1218 | |
| payType | String | 付费类型 | 包年包月 | |
| clusterType | String | 集群类型 | 云搜索 | |
| clusterTypeVersion | String | 产品版本 | 翼MR-2.12.0 | |
| clusterPlanCode | String | 集群规划编码 | cloud-search | |
| componentNameList | String | 组件名称列表 | [{componentTitle:ElasticSearch,version:7.10.2},{componentTitle:Kibana,version:7.10.2}]] | |
| datasourceConfigs | String | 数据源信息 | [] | |
| vpcId | String | vpc id | vpc-0k5xl6w5 | |
| subnetId | String | 子网id | subnet-i2ys8sp | |
| securityGroupId | String | 安全组id | [sg-4h7w9cl1] | |
| loginType | String | 登录方式 | PASSWORD | |
| clusterDueTime | Integer | 集群到期时间 | 1709193751000 | |
| userId | String | 用户id | ba14c8e729e447d69698f81ac7d55555 | |
| accountId | String | 账号id | ed24e4b414a048b0a9cb995f59cc85jj | |
| clusterCreateTime | Integer | 集群创建时间 | 1706515357000 | |
| clusterState | String | 集群状态 | 运行中 | |
| managerVersion | String | manager版本号 | 2.15.1 | |
| enableIpv6 | String | Ipv6是否开启(OPEN:打开, CLOSE:关闭, NOT_DISPLAY:不展示,null:不展示) | OPEN | |
| createTime | Integer | 创建时间 | 1706515356000 | |
| updateTime | Integer | 更新时间 | 1706515356000 | |
| autoRenewStatus | Integer | 是否开启自动续订的状态(0:不自动续订,1:自动续订) | 1 | |
| clusterRunningSeconds | Long | 集群运行时间 | 0 | |
| pathMap | Map of String | 组件名称:组件链接 | { "Kibana": "1,1", "ElasticSearch": "1,1" } |
枚举参数
无
请求示例
请求url
https://emr-global.ctapi.ctyun.cn/v2/emr/openapi/cluster/clusterDetail/getById?id=e7afb3bd9d7117d116893c03a352f4e3
请求头header
无
请求体body
无
响应示例
请求成功示例：
{
"statusCode": 200,
"message": "success",
"returnObj": {
"id": "e7afb3bd9d7117d116893c03a352f4e3",
"managerClusterId": 1,
"iaasType": "公有云",
"regionId": "bb9fdb42056f11eda1610242ac110002",
"regionName": "华东1",
"availableZoneId": "cn-huadong1-jsnj1A-public-ctcloud",
"availableZoneName": "可用区1",
"clusterName": "test_zdy_1022",
"payType": "包年包月",
"clusterType": "自定义",
"clusterTypeVersion": "翼MR-2.16.1",
"clusterPlanCode": "customize",
"componentNameList": "[{\"componentTitle\":\"OpenLDAP\",\"version\":\"2.4.50\"},{\"componentTitle\":\"Kerberos\",\"version\":\"1.18.2\"},{\"componentTitle\":\"ZooKeeper\",\"version\":\"3.7.1\"},{\"componentTitle\":\"HDFS\",\"version\":\"3.3.3\"},{\"componentTitle\":\"Trino\",\"version\":\"406\"},{\"componentTitle\":\"YARN\",\"version\":\"3.3.3\"},{\"componentTitle\":\"Iceberg\",\"version\":\"1.4.3\"},{\"componentTitle\":\"Flink\",\"version\":\"1.16.2\"}]",
"datasourceConfigs": "[]",
"vpcId": "vpc-yrecox87qe",
"subnetId": "subnet-pxpru3r0as",
"securityGroupId": "[\"sg-ayhf17g4at\"]",
"loginType": "PASSWORD",
"clusterDueTime": 1732258775000,
"userId": "716559f47c52477a95a8d59ba0f8a341",
"accountId": "6cd3cad039824f0ebd19182bb8c971ca",
"clusterCreateTime": 1729580375000,
"clusterState": "运行中",
"managerVersion": "24.10.0dev",
"enableIpv6": "NOT_DISPLAY",
"createTime": 1729580374000,
"updateTime": 1730021300000,
"autoRenewStatus": 0,
"clusterRunningSeconds": 0,
"pathMap": {
"OpenLDAP": "1,1",
"Kerberos": "1,2",
"ZooKeeper": "1,3",
"Iceberg": "1,8",
"HDFS": "1,4",
"Trino": "1,5",
"Flink": "1,7",
"YARN": "1,6"
}
}
}
验签失败示例：
{
"statusCode": 500,
"error": "EMR_401000",
"message": "OpenAPI认证失败",
"returnObj": {}
}
请求参数值无效示例：
{
"statusCode": 500,
"error": "EMR_401002",
"message": "请求参数值无效",
"returnObj": "{\"id\":\"不能为空\"}"
}
查询无权限的集群示例：
{
"statusCode": 500,
"error": "EMR_401004",
"message": "非法操作",
"returnObj": {}
}
非运行集群无法查看示例：
{
"statusCode": 500,
"error": "EMR_401006",
"message": "非运行中集群无法查看信息",
"returnObj": {}
}
状态码
请参考 状态码
错误码
请参考 错误码
