根據id查詢集群信息V2
更新時間 2025-09-04 18:10:24
最近更新時間: 2025-09-04 18:10:24
分享文章
接口功能介紹
此接口提供根據集群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
//emr-global.ctapi.daliqc.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": {}
}
狀態碼
請參考
錯誤碼
請參考