接口功能介绍
此接口提供查询用户集群信息功能，系统接收用户输入的查询条件，返回用户输入的资源池下符合条件的集群详细信息，不会返回已删除的集群信息。
接口约束
不会返回已删除的集群信息。
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
https://emr-global.ctapi.ctyun.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": {}
}
状态码
请参考 状态码
错误码
请参考 错误码
