接口功能介绍
此接口提供查询用户集群信息功能，系统接收用户输入的查询条件，返回用户输入的资源池下符合条件的集群详细信息，不会返回已删除的集群信息。
接口约束
无
接口是否审批
否
URI
POST /v1/emr/openapi/cluster/clusterDetail/selectPage
Content-Type
application/json
路径参数
无
Query参数
无
请求头header参数
无
请求体body参数
请求体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:数据服务,4:数据分析,5:云搜索) | 1 | / |
响应参数
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码 | 200 | / |
| message | String | 用来简述当前接口调用状态以及必要提示信息 | 请求成功 | / |
| error | String | 错误码，请求成功时，不返回该字段 | EMR_400001 | / |
| returnObj | Object | 返回结果 | / | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| total | Integer | 总集群数量 | 23 | / |
| size | Integer | 当前查询返回的集群数量 | 1 | / |
| current | Integer | 当前页 | 1 | / |
| orders | Array of Objects | 排序字段和排序方式 | / | orderItem |
| optimizeCountSql | Boolean | 自动优化count SQL查询 | true | / |
| searchCount | Boolean | 是否进行count查询，默认true | true | / |
| countId | String | 进行count查询的id | 1 | / |
| maxLimit | Integer | 单页分页条数限制 | 20 | / |
| pages | Integer | 总页数 | 5 | / |
| records | Array of Objects | 集群列表 | / | records |
表 orderItem
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| column | String | 需要进行排序的字段 | regionId | / |
| acs | Boolean | 是否正序排列，默认true | true | / |
表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 | / |
枚举参数
无
请求头header示例
无
请求url示例
https://emr-global.ctapi.ctyun.cn/v1/emr/openapi/cluster/clusterDetail/selectPage
请求体body示例
{
"clusterName":"",
"clusterStateCode": 2,
"clusterTypeCode": 2,
"pageIndex": 1,
"pageSize": 10,
"regionId":"bb9fdb42056f11eda1619242ac110002"
}
响应示例
请求成功返回值示例
{
"statusCode": 200,
"message": "success",
"returnObj": {
"records": [
{
"id": "2cd01a834b8e0c14d4a03c01d6052924",
"managerClusterId": 1,
"iaasType": "公有云",
"regionId": "bb9fdb42056f11eda1610242ac110002",
"regionName": "华东1",
"availableZoneId": "cn-huadong1-jsnj1A-public-ctcloud",
"availableZoneName": "可用区1",
"clusterName": "sjfw-sxy-0207-3",
"payType": "包年包月",
"clusterType": "数据服务",
"clusterTypeVersion": "翼MR-2.12.1",
"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\"},{\"componentTitle\":\"Ranger\",\"version\":\"2.2.0\"}]",
"datasourceConfigs": "[{\"compType\":\"Ranger\",\"properties\":[{\"propName\":\"DB_Host\",\"propValue\":\"192.168.0.156\"},{\"propName\":\"DB_Port\",\"propValue\":\"13049\"},{\"propName\":\"DB_Name\",\"propValue\":\"ranger0207_4_sxy\"},{\"propName\":\"DB_User\",\"propValue\":\"root\"},{\"propName\":\"DB_Password\",\"propValue\":\"t3O15dEAnNxQbKytUnCpi+ir5lbdkt45Zxm9BSO1YoIlowerqD0dCA22hMVLDwhff5na3fz4KAnNW7fQpP84ZaKgX6XRovjEsWJ0Gyn9ss0NZ3nRI7jjOW08CnNOmGRirY3OebmYO9PsSucjVMGCPAplyhnjMefhGJHOFnvw4xU=\"}]}]",
"vpcId": "vpc-fr2xjo1gj0",
"subnetId": "subnet-vkixrw8xw7",
"securityGroupId": "[\"sg-72kksosxfn\"]",
"loginType": "PASSWORD",
"clusterDueTime": 1709795918000,
"userId": "ba14c8e729e447d69698f81ac7d506b5",
"accountId": "ed24e4b414a048b0a9cb995f59cc85dd",
"clusterCreateTime": 1707290310000,
"clusterState": "运行中",
"managerVersion": "2.15.1",
"enableIpv6": "NOT_DISPLAY",
"createTime": 1707290309000,
"updateTime": 1707291860000,
"autoRenewStatus": 0
}
],
"total": 1,
"size": 10,
"current": 1,
"orders": [],
"optimizeCountSql": true,
"searchCount": true,
"countId": "",
"maxLimit": null,
"pages": 1
}
}
请求失败返回值示例
{
"statusCode": 200,
"error": "EMR_400010",
"message": "pageIndex,regionId为必填项，未传",
"returnObj": []
}
