接口功能介绍
此接口提供查询用户根据id查询集群信息功能，系统接收用户输入的查询条件，返回符合条件的集群详细信息。
接口约束
只允许查询处于运行中状态的集群信息。
接口是否审批
否
URI
GET /v1/emr/openapi/cluster/clusterDetail/getById
Content-Type
application/json
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
id | 是 | String | 集群id | 00c3a04292996955752f073c995a1cc6 |
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
Cluster-Id | 是 | String | 集群id | 00c3a04292996955752f073c995a1cc6 | / |
请求体body参数
无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
statusCode | Integer | 状态码 | 200 | / |
message | String | 用来简述当前接口调用状态以及必要提示信息 | 请求成功 | / |
error | String | 错误码，请求成功时，不返回该字段 | EMR_400001 | / |
returnObj | Object | 返回结果 | / | returnObj |
表 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 | 集群名称 | 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}, | / |
datasourceConfigs | String | 数据源信息 | [] | / |
vpcId | String | vpc id | vpc-0k5xl6w5 | / |
subnetId | String | 子网id | subnet-i2ys8sp | / |
securityGroupId | String | 安全组id | [sg-4h7w9cl1] | / |
clusterDueTime | Integer | 集群到期时间 | 1709193751000 | / |
userId | String | 用户id | ba14c8e729e447d69698f81ac7d55555 | / |
accountId | String | 账号id | ed24e4b414a048b0a9cb995f59cc85jj | / |
clusterCreateTime | Integer | 集群创建时间 | 1706515357000 | / |
clusterState | String | 集群状态 | 运行中 | / |
createTime | Integer | 创建时间 | 1706515356000 | / |
updateTime | Integer | 更新时间 | 1706515356000 | / |
pathMap | Map of String | 组件名称:组件链接 | { "Kibana": "1,1", "ElasticSearch": "1,1" } | / |
枚举参数
无
请求头header示例
{
"Cluster-Id":"00c3a04292996955752f073c995a1cc6"
}
请求url示例
https://emr-global.ctapi.ctyun.cn/v1/emr/openapi/cluster/clusterDetail/getById?id=00c3a04292996955752f073c995a1cc6
请求体body示例
无
响应示例
请求成功返回值示例
{
"statusCode": 200,
"message": "success",
"returnObj": {
"id": "00c3a04292996955752f073c995a1cc6",
"managerClusterId": 1,
"iaasType": "公有云",
"regionId": "bb9fdb42056f11eda1610242ac110002",
"regionName": "华东1",
"availableZoneId": "cn-huadong1-jsnj1A-public-ctcloud",
"availableZoneName": "可用区1",
"clusterName": "test1218",
"payType": "包年包月",
"clusterType": "云搜索",
"clusterTypeVersion": "翼MR-2.12.0",
"clusterPlanCode": "cloud-search",
"componentNameList": "[{\"componentTitle\":\"ElasticSearch\",\"version\":\"7.10.2\"},{\"componentTitle\":\"Kibana\",\"version\":\"7.10.2\"}]",
"datasourceConfigs": "[]",
"vpcId": "vpc-vgo9wazk0m",
"subnetId": "subnet-6hd5rpedsp",
"securityGroupId": "[\"sg-mz2suubydc\"]",
"clusterDueTime": 1705543555000,
"userId": "ba14c8e729e447d69698f81ac7d506b5",
"accountId": "ed24e4b414a048b0a9cb995f59cc85dd",
"clusterCreateTime": 1702865155000,
"clusterState": "运行中",
"createTime": 1702865154000,
"updateTime": 1702979599000,
"pathMap": {
"Kibana": "1,1",
"ElasticSearch": "1,1"
}
}
}
请求失败返回值示例
{
"statusCode": 200,
"error": "EMR_400019",
"message": "集群id必传",
"returnObj": []
}