集群信息分頁查詢V2
更新時間 2025-09-04 18:10:25
最近更新時間: 2025-09-04 18:10:25
分享文章
接口功能介紹
此接口提供查詢用戶集群信息功能，系統接收用戶輸入的查詢條件，返回用戶輸入的資源池下符合條件的集群詳細信息，不會返回已刪除的集群信息。
接口約束
不會返回已刪除的集群信息。
URI
POST /v2/emr/openapi/cluster/clusterDetail/selectPage
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 資源池id | bb9fdb42056f11eda1610242ac110002 | |
| pageIndex | 是 | Integer | 頁碼，參數值需為正整數 | 1 | |
| pageSize | 是 | Integer | 每頁記錄數，參數值需為正整數 | 10 | |
| clusterName | 否 | String | 集群名稱 | cluster_name | |
| clusterStateCode | 否 | Integer | 集群狀態碼(1啟動中,2運行中,3異常終止,4釋放中,5已終止,10已凍結) | 1 | |
| clusterTypeCode | 否 | Integer | 集群類型碼(1:數據湖,2:數據服務,3:自定義,4:數據分析,5:云搜索,6:實時數據流) | 1 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 狀態碼，成功：200，失敗：500 | 200 | |
| message | String | 用來簡述當前接口調用狀態以及必要提示信息 | 請求成功 | |
| error | String | 錯誤碼，請求成功時，不返回該字段 | EMR_400000 | |
| returnObj | Object | 返回結果 |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| records | Array of Objects | 集群列表 | records | |
| total | Integer | 總數量 | 23 | |
| pageSize | Integer | 每頁記錄數 | 10 | |
| pageIndex | Integer | 頁碼 | 1 |
表 records
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| id | String | 集群id | 8571aa313aaf77d45bf6765805a9ce55 | |
| 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 | 集群名稱 | test_vpc_24 | |
| 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:自動續訂) | 0 |
枚舉參數
無
請求示例
請求url
//emr-global.ctapi.daliqc.cn/v2/emr/openapi/cluster/clusterDetail/selectPage
請求頭header
無
請求體body
{
"regionId":"bb9fdb42056f11eda1619242ac110002",
"pageIndex": 1,
"pageSize": 10
}
響應示例
請求成功示例：
{
"statusCode": 200,
"message": "success",
"returnObj": {
"records": [
{
"id": "99aea8cc693d05d9f94bc1fa6eb3cd67",
"managerClusterId": 1,
"iaasType": "公有云",
"regionId": "bb9fdb42056f11eda1610242ac110002",
"regionName": "華東1",
"availableZoneId": "cn-huadong1-jsnj1A-public-ctcloud",
"availableZoneName": "可用區1",
"clusterName": "test2",
"payType": "包年包月",
"clusterType": "數據服務",
"clusterTypeVersion": "翼MR-2.15.2",
"clusterPlanCode": "data-service",
"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\":\"YARN\",\"version\":\"3.3.3\"},{\"componentTitle\":\"HBase\",\"version\":\"2.4.12\"}]",
"datasourceConfigs": "[]",
"vpcId": "vpc-yrecox87qe",
"subnetId": "subnet-pxpru3r0as",
"securityGroupId": "[\"sg-ayhf17g4at\"]",
"loginType": "PASSWORD",
"clusterDueTime": 1732334100000,
"userId": "716559f47c52477a95a8d59ba0f8a341",
"accountId": "6cd3cad039824f0ebd19182bb8c971ca",
"clusterCreateTime": 1724384364000,
"clusterState": "異常終止",
"managerVersion": "24.7.0dev",
"enableIpv6": "NOT_DISPLAY",
"createTime": 1724384363000,
"updateTime": 1727256300000,
"autoRenewStatus": 0
}
],
"total": 1,
"pageSize": 10,
"pageIndex": 1
}
}
請求參數類型不正確示例：
{
"statusCode": 500,
"error": "EMR_401001",
"message": "請求參數類型錯誤",
"returnObj": "{\"regionId\": \"應為字符串\",\"pageIndex\": \"應為int范圍內整數\"}"
}
請求參數值無效示例：
{
"statusCode": 500,
"error": "EMR_401002",
"message": "請求參數值無效",
"returnObj": "{\"pageSize\": \"不能為null\",\"clusterStateCode\": \"只能取[1, 2, 3, 4, 5, 10]中的一個值\",\"regionId\": \"只允許輸入字母、數字、-\",\"pageIndex\": \"必須是正數\"}"
}
資源池不存在時示例：
{
"statusCode": 500,
"error": "EMR_401003",
"message": "資源池id不存在",
"returnObj": {}
}
狀態碼
請參考
錯誤碼
請參考
