接口功能介绍
此接口提供根据实例id查询实例信息功能，返回符合条件的实例详细信息。
接口约束
1.入参字段必须按Query参数传入。
URI
GET /os/openapi/v1/cluster/getClusterById
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| clusterId | 是 | String | 实例id | OpenSearch-UTLGQLHQPJNJSDCRPPJBP |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码，成功：200，失败：500 | 200 | |
| error | String | 错误码，请求成功时，不返回该字段 | OS_400000 | |
| message | String | 用来简述当前接口调用状态以及必要提示信息 | 请求成功 | |
| returnObj | Object | 返回结果 | 表 returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| clusterId | String | 实例id | OpenSearch-UTLGQLHQPJNJSDCRPPJBP | |
| clusterName | String | 实例名称 | ostest | |
| state | String | 健康状态： GREEN/YELLOW/RED |
GREEN | |
| enableIpv6 | String | OPEN：开启ipv6访问 CLOSE：关闭ipv6 访问 NOT_DISPLAY：不展示ipv6 |
OPEN | |
| regionName | String | 资源池名称 | 华东1 | |
| vpcName | String | vpc名称 | vpc-ipv6 | |
| vpcId | String | vpcId | vpc-8p9hpn4o8g | |
| subnetName | String | 子网名称 | subnet-ipv6 | |
| subnetId | String | 子网id | subnet-mp6a3hce8q | |
| clusterType | Integer | 实例类型： 1：表示OpenSearch 2：表示Elasticsearch |
1 | |
| clusterTypeName | String | 类型名称 | OpenSearch/Elasticsearch | |
| clusterTypeVersion | String | 实例版本 | 2.9.0 | |
| payType | String | 付费类型 | 包年包月 | |
| clusterDueTime | Integer | 实例到期时间 | 1745033321000 | |
| createTime | Integer | 创建时间 | 1742353726000 | |
| userName | String | 访问控制-用户名 | admin | |
| osVmSpecName | String | 映射的主机名称（节点规格名称） | esearch-4c16g | |
| clusterMessage | String | 错误原因：异常撤单的会有原因 | 实例开通失败，已自动退单，失败原因：后端服务部署失败 | |
| cpuNum | Integer | cpu大小 | 4 | |
| memory | Integer | 内存大小 | 16 | |
| hostNum | Integer | 主机数量 | 3 | |
| diskVolumn | Integer | 存储空间 | 40 | |
| componentName | String | 组件名称 | kibana/dashboard | |
| loadBalancerName | String | 负载均衡器名称 | ||
| routerHostInfo | Object | 组件节点信息 | 表routerHostInfo | |
| dataHostInfos | Array of Objects | 数据节点组类型信息 | 表dataHostInfos | |
| exclusiveMasterHostInfos | Array of Objects | 专属MASTER数据节点组类型信息 | 表exclusiveMasterHostInfos | |
| coordinateHostInfos | Array of Objects | 协调节点组类型信息 | 表coordinateHostInfos | |
| coldHostInfos | Array of Objects | 冷数据节点组类型信息 | 表coldHostInfos |
表 routerHostInfo
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| hostIp | String | 内网ip | 192.168.0.51 | |
| availableZoneId | String | 区域id | cn-huadong1-jsnj1A-public-ctcloud | |
| state | String | RUNNING 、FAILED | RUNNING | |
| stateType | Integer | 2：运行中 5：失败 | 2 | |
| ipv6HostIp | String | ipv6地址 | 240e:982:db42:b100:3fa7:7228:2489:486c |
表 dataHostInfos
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| hostIp | String | 内网ip | 192.168.0.58 | |
| availableZoneId | String | 区域id | cn-huadong1-jsnj1A-public-ctcloud | |
| state | String | RUNNING 、FAILED | RUNNING | |
| stateType | Integer | 2：运行中 5：FAILED | 2 | |
| ipv6HostIp | String | ipv6地址 | 240e:982:db42:b100:bc5a:cddf:7a49:9d4d | |
| iaasVmSpecCode | String | IAAS虚机规格编码 | esearch-4c16g | |
| ioTypeName | String | 磁盘IO类型名称 | 高IO | |
| cpuNum | Integer | cpu核数 | 4 | |
| memory | Integer | 内存大小 | 16 | |
| diskVolumn | Integer | 硬盘大小 | 40 |
表 exclusiveMasterHostInfos
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| hostIp | String | 内网ip | 192.168.0.58 | |
| availableZoneId | String | 区域id | cn-huadong1-jsnj1A-public-ctcloud | |
| state | String | RUNNING 、FAILED | RUNNING | |
| stateType | Integer | 2：运行中 5：FAILED | ||
| ipv6HostIp | String | ipv6地址 | 240e:982:db42:b100:bc5a:cddf:7a49:9d4d | |
| iaasVmSpecCode | String | IAAS虚机规格编码 | esearch-4c16g | |
| ioTypeName | String | 磁盘IO类型名称 | 高IO | |
| cpuNum | Integer | cpu核数 | 4 | |
| memory | Integer | 内存大小 | 16 | |
| diskVolumn | Integer | 硬盘大小 | 40 |
表 coldHostInfos
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| hostIp | String | 内网ip | 192.168.0.58 | |
| availableZoneId | String | 区域id | cn-huadong1-jsnj1A-public-ctcloud | |
| state | String | RUNNING 、FAILED | RUNNING | |
| stateType | Integer | 2：运行中 5：FAILED | 2 | |
| ipv6HostIp | String | ipv6地址 | 240e:982:db42:b100:bc5a:cddf:7a49:9d4d | |
| iaasVmSpecCode | String | IAAS虚机规格编码 | esearch-4c16g | |
| ioTypeName | String | 磁盘IO类型名称 | 高IO | |
| cpuNum | Integer | cpu核数 | 4 | |
| memory | Integer | 内存大小 | 16 | |
| diskVolumn | Integer | 硬盘大小 | 40 |
枚举参数
无
请求示例
请求url
https://ctcsx-global.ctapi.ctyun.cn/os/openapi/v1/cluster/getClusterById
请求头header
无
请求体body
无
响应示例
请求成功示例：
{
"statusCode": 200,
"message": "success",
"returnObj": {
"clusterId": "Elasticsearch-CAQPBFJJLMKODRDPFH",
"clusterName": "test-wmy",
"state": "GREEN",
"regionId": "bb9fdb42056f11eda1610242ac110002",
"regionName": "华东1",
"azName": "可用区1",
"availableZoneId": "cn-huadong1-jsnj1A-public-ctcloud",
"vpcName": "vpc-ipv6",
"vpcId": "vpc-8p9hpn4o8g",
"subnetName": "subnet-ipv6",
"enableIpv6": "OPEN",
"subnetId": "subnet-mp6a3hce8q",
"securityGroupId": "sg-mkritasxrd",
"securityGroupnName": "Default-Security-Group",
"clusterType": 2,
"clusterTypeName": "Elasticsearch",
"clusterTypeVersion": "7.10.2",
"payType": "包年包月",
"clusterDueTime": 1745033321000,
"createTime": 1742353726000,
"userName": "root",
"osVmSpecName": "esearch-4c16g",
"hostNum": 3,
"diskVolumn": 40,
"cpuNum": 4,
"memory": 16,
"componentName": "kibana,cerebro",
"loadBalancerName": null,
"routerHostInfo": {
"availableZoneId": "cn-huadong1-jsnj1A-public-ctcloud",
"hostIp": "192.168.0.51",
"state": "RUNNING",
"stateType": 8,
"ipv6HostIp": "240e:982:db42:b100:6375:4e37:a1a2:11d9"
},
"dataHostInfos": [
{
"availableZoneId": "cn-huadong1-jsnj1A-public-ctcloud",
"hostIp": "192.168.0.54",
"state": "RUNNING",
"stateType": 8,
"ipv6HostIp": "240e:982:db42:b100:8db2:a0b8:cdd3:6e8f",
"iaasVmSpecCode": "esearch-4c16g",
"ioTypeName": "通用型SSD",
"cpuNum": 4,
"memory": 16,
"diskVolumn": 40
},
{
"availableZoneId": "cn-huadong1-jsnj1A-public-ctcloud",
"hostIp": "192.168.0.52",
"state": "RUNNING",
"stateType": 8,
"ipv6HostIp": "240e:982:db42:b100:66ee:8b6e:2b22:74d1",
"iaasVmSpecCode": "esearch-4c16g",
"ioTypeName": "通用型SSD",
"cpuNum": 4,
"memory": 16,
"diskVolumn": 40
},
{
"availableZoneId": "cn-huadong1-jsnj1A-public-ctcloud",
"hostIp": "192.168.0.53",
"state": "RUNNING",
"stateType": 8,
"ipv6HostIp": "240e:982:db42:b100:2c58:865c:c62d:1c9d",
"iaasVmSpecCode": "esearch-4c16g",
"ioTypeName": "通用型SSD",
"cpuNum": 4,
"memory": 16,
"diskVolumn": 40
}
],
"exclusiveMasterHostInfos": [
{
"availableZoneId": "cn-huadong1-jsnj1A-public-ctcloud",
"hostIp": "192.168.0.69",
"state": "RUNNING",
"stateType": 8,
"ipv6HostIp": "240e:982:db42:b100:13d:6592:882e:c96",
"iaasVmSpecCode": "esearch-4c16g",
"ioTypeName": "通用型SSD",
"cpuNum": 4,
"memory": 16,
"diskVolumn": 40
},
{
"availableZoneId": "cn-huadong1-jsnj1A-public-ctcloud",
"hostIp": "192.168.0.68",
"state": "RUNNING",
"stateType": 8,
"ipv6HostIp": "240e:982:db42:b100:c50c:b6e5:7687:55b4",
"iaasVmSpecCode": "esearch-4c16g",
"ioTypeName": "通用型SSD",
"cpuNum": 4,
"memory": 16,
"diskVolumn": 40
},
{
"availableZoneId": "cn-huadong1-jsnj1A-public-ctcloud",
"hostIp": "192.168.0.70",
"state": "RUNNING",
"stateType": 8,
"ipv6HostIp": "240e:982:db42:b100:629d:f888:d89b:fe6d",
"iaasVmSpecCode": "esearch-4c16g",
"ioTypeName": "通用型SSD",
"cpuNum": 4,
"memory": 16,
"diskVolumn": 40
}
],
"coordinateHostInfos": [
{
"availableZoneId": "cn-huadong1-jsnj1A-public-ctcloud",
"hostIp": "192.168.0.72",
"state": "RUNNING",
"stateType": 8,
"ipv6HostIp": "240e:982:db42:b100:30e8:552f:6797:2d41",
"iaasVmSpecCode": "esearch-4c16g",
"ioTypeName": "超高IO",
"cpuNum": 4,
"memory": 16,
"diskVolumn": 40
},
{
"availableZoneId": "cn-huadong1-jsnj1A-public-ctcloud",
"hostIp": "192.168.0.91",
"state": "RUNNING",
"stateType": 8,
"ipv6HostIp": "240e:982:db42:b100:2034:f2f3:a68a:9809",
"iaasVmSpecCode": "esearch-4c16g",
"ioTypeName": "超高IO",
"cpuNum": 4,
"memory": 16,
"diskVolumn": 40
},
{
"availableZoneId": "cn-huadong1-jsnj1A-public-ctcloud",
"hostIp": "192.168.0.71",
"state": "RUNNING",
"stateType": 8,
"ipv6HostIp": "240e:982:db42:b100:5867:57ef:7f54:c479",
"iaasVmSpecCode": "esearch-4c16g",
"ioTypeName": "超高IO",
"cpuNum": 4,
"memory": 16,
"diskVolumn": 40
}
],
"coldHostInfos": [
{
"availableZoneId": "cn-huadong1-jsnj1A-public-ctcloud",
"hostIp": "192.168.0.93",
"state": "RUNNING",
"stateType": 8,
"ipv6HostIp": "240e:982:db42:b100:8766:501d:1f7d:a33d",
"iaasVmSpecCode": "esearch-4c16g",
"ioTypeName": "通用型SSD",
"cpuNum": 4,
"memory": 16,
"diskVolumn": 40
},
{
"availableZoneId": "cn-huadong1-jsnj1A-public-ctcloud",
"hostIp": "192.168.0.94",
"state": "RUNNING",
"stateType": 8,
"ipv6HostIp": "240e:982:db42:b100:562a:78fd:f964:6bd5",
"iaasVmSpecCode": "esearch-4c16g",
"ioTypeName": "通用型SSD",
"cpuNum": 4,
"memory": 16,
"diskVolumn": 40
},
{
"availableZoneId": "cn-huadong1-jsnj1A-public-ctcloud",
"hostIp": "192.168.0.95",
"state": "RUNNING",
"stateType": 8,
"ipv6HostIp": "240e:982:db42:b100:c154:2687:814e:2b3d",
"iaasVmSpecCode": "esearch-4c16g",
"ioTypeName": "通用型SSD",
"cpuNum": 4,
"memory": 16,
"diskVolumn": 40
}
]
}
}
请求失败示例：
{
"statusCode": 500,
"error": "OS_400000",
"message": "请求失败"
}
ak 传错示例：
{
"statusCode": "CTAPI_10002",
"returnObj": {
},
"code": "10002",
"message": "ctyun-EOP: Invalid APP ID in request",
"error": "10002",
"requestId": "b0747f9e5ef24a7e95ad9324dbe6d885",
"eopErrCode": "10002"
}
sk传错示例:
{
"statusCode": "CTAPI_10009",
"returnObj": {
},
"code": "10009",
"message": "ctyun-EOP: signature verification failed",
"error": "10009",
"requestId": "ee133410bed24812b8f70cc27299401b",
"eopErrCode": "10009"
}
请求参数值无效示例：
{
"statusCode": 500,
"error": "OS_401002",
"message": "请求参数值无效",
"returnObj": "{"clusterId":"不能为空"}"
}
资源池不存在示例:
{
"statusCode": 500,
"error": "OS_401005",
"message": "该实例不存在",
"returnObj": {}
}
用户无权限:
{
"statusCode": 500,
"error": "OS_401004",
"message": "非法操作",
"returnObj": {
}
}
状态码
请参考 状态码
错误码
请参考 错误码
