文档首页/ 云搜索服务 CSS/ API参考（联盟区域）/ API V1/ 集群管理/ 获取可升级的目标镜像ID
更新时间：2026-01-12 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取可升级的目标镜像ID

功能介绍

该接口用于获取当前集群的可升级目标镜像ID，根据升级类型可分为：

  • 同版本升级：升级集群的内核补丁。集群升级至当前版本的最新镜像，用于修复问题或优化性能。例如，集群版本为“7.10.2(7.10.2_24.3.3_0102)”，同版本升级后，集群版本会升级到7.10.2版本最新的镜像“7.10.2(7.10.2_24.3.4_0109)”（版本号仅做示例，非现网实际版本号）。

  • 跨版本升级：升级集群的版本。集群升级至目标版本的最新镜像，用于功能加强或版本收编。例如，集群版本为“7.6.2(7.6.2_24.3.3_1224)”，跨版本升级后，集群版本会升级到7.10.2版本最新的镜像“7.10.2(7.10.2_24.3.4_0109)”（版本号仅做示例，非现网实际版本号）。

  • 跨引擎升级：将Elasticsearch集群升级至OpenSearch集群。Elasticsearch集群升级至OpenSearch集群目标版本的最新镜像，用于引擎变更。例如，Elasticsearch集群版本为“7.10.2(7.10.2_24.3.3_0102)”，跨引擎升级后，Elasticsearch集群会升级到OpenSearch 1.3.6版本最新的镜像“1.3.6(1.3.6_24.3.4_0109)”（版本号仅做示例，非现网实际版本号）。该功能暂不支持。

调用方法

请参见如何调用API。

URI

GET /v1.0/{project_id}/clusters/{cluster_id}/target/{upgrade_type}/images

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID。获取方法请参见获取项目ID和名称。

约束限制：

不涉及

取值范围：

账户的项目ID。

默认取值：

不涉及

cluster_id

是

String

参数解释：

指定升级的集群的ID。获取方法请参见获取集群ID。

约束限制：

不涉及

取值范围：

集群ID。

默认取值：

不涉及

upgrade_type

是

String

参数解释：

集群镜像升级类型。

约束限制：

不涉及

取值范围：

  • same：同版本升级。

  • cross：跨版本升级。

  • cross-engine：跨引擎升级。

默认取值：

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

参数解释：

指定查询起始值，默认值为0

约束限制：

不涉及

取值范围：

0-1000

默认取值：

0

limit

否

Integer

参数解释：

指定查询个数，默认值为10，即一次查询10个镜像信息。

约束限制：

不涉及

取值范围：

1-1000

默认取值：

10

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

needUploadUpgradePlugin

Boolean

参数解释：

是否需要上传升级后版本的插件。

取值范围：

不涉及

imageInfoList

Array of GetTargetImageIdDetail objects

参数解释：

镜像详情信息。

取值范围：

不涉及

totalSize

Integer

参数解释：

目标镜像数量。

取值范围：

不涉及
表4 GetTargetImageIdDetail

参数

参数类型

描述

id

String

参数解释：

可以升级的目标镜像ID。

取值范围：

不涉及

displayName

String

参数解释：

可以升级的目标镜像名称。

取值范围：

不涉及

imageDesc

String

参数解释：

镜像描述信息。

取值范围：

不涉及

datastoreType

String

参数解释：

集群引擎类型。

取值范围：

  • elasticsearch：基于开源Elasticsearch提供在线分布式搜索、日志统计报表、语义搜索等功能。

  • logstash：基于开源Logstash提供数据收集、转换、清洗、解析等功能。

  • opensearch：基于开源OpenSearch提供分布式搜索、日志统计报表、语义搜索等功能，是CSS服务Elasticsearch集群的下一代版本。

datastoreVersion

String

参数解释：

镜像引擎版本。

取值范围：

不涉及

priority

Integer

参数解释：

目标镜像优先级，数值越大，优先级越高。

取值范围：

不涉及

请求示例

获取集群可跨版本升级的目标镜像：

GET https://{Endpoint}/v1.0/{project_id}/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/target/cross/images

响应示例

状态码：200

请求已成功。

{
  "needUploadUpgradePlugin" : false,
  "imageInfoList" : [ ],
  "totalSize" : 0
}

状态码

状态码

描述

200

请求已成功。

400

非法请求。

建议直接修改该请求，不要重试该请求。

403

请求被拒绝访问。

返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。

错误码

请参见错误码。

父主题： 集群管理