UpdateInstance_Elasticsearch_API文档-阿里云OpenAPI开发者门户

接口说明

调用该接口时，请注意：

当实例状态为生效中（activating）、失效（invalid）和冻结（inactive）时，无法变更配置。
如果集群负载过高且索引没有副本，同时在升配或者降配过程中存在大量的写入或查询等情况，业务可能会出现偶发的访问超时现象。建议在集群变更前，在客户端访问机制中配置重试机制，以减小对业务的影响。
每次只能变更一种类型的节点（数据节点、专有主节点、冷数据节点、协调节点、Kibana 节点、弹性节点）的配置。
出于您的集群健康和稳定性的考虑，自 2021 年 5 月起，阿里云 Elasticsearch 已不支持购买 1 核 2 GB 规格、专有主节点的 2 核 2 GB 规格和 7.4 版本实例，如果您已确认已购规格不再支持售卖，那么您需要先完成以下操作：
- 对于 1 核 2 GB 和 2 核 2 GB 规格，建议提前升配至购买页开放的稳定的售卖规格。购买页开放的售卖规格请参见购买页面参数（商业版）或者购买页面参数（增强版）。
- 对于 7.4 版本，建议您重新选购 7.10 版本实例，然后再进行数据迁移。数据迁移请参见迁移方案选取指南。

更多注意事项，请参见升配集群和降配集群。

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

elasticsearch:UpdateInstance	Update	Instance acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}	无	无

请求语法

PUT /openapi/instances/{InstanceId} HTTP/1.1

路径参数

字段名称	字段详情
InstanceIdstring	实例 ID。示例值:es-cn-n6w1ptcb30009****参考取值来源: ListInstance

请求参数

字段名称	字段详情
clientTokenstring	用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，最大不超过 64 个 ASCII 字符。示例值:5A2CFF0E-5718-45B5-9D4D-70B3FF****
orderActionTypestring	配置变更类型，可选值：展开详情示例值:upgrade
bodyobject	请求体参数。示例值:{ "nodeSpec": { "spec": "elasticsearch.r5.xlarge" } }
forceboolean	是否强制重启：展开详情示例值:false

请求说明

Elasticsearch 支持的节点规格列表，请参见阿里云 Elasticsearch 定价信息、产品规格。

请求体参数示例如下：升配

说明升配时，不支持降低存储空间数值、存储类型配置、节点数量、规格的 CPU 核数或内存值。

升配存储空间目前仅支持数据节点、冷数据节点和弹性数据节点升配存储空间。

将冷数据节点的存储空间升配至 1000 GiB。

{
  "warmNodeConfiguration": {
   "disk": 1000
  }
}

升配存储类型目前仅支持数据节点、弹性数据节点和专有主节点升配存储类型。
- 将专有主节点的存储类型升配为 ESSD 云盘类型。

{
  "masterConfiguration": {
    "diskType": "cloud_essd"
  }
}

当专有主节点的存储类型为 ESSD 云盘类型时，将节点存储性能级别升配为 PL3。指定 performanceLevel 后，diskType 会默认填充为cloud_essd。指定cloud_essd后，performanceLevel 默认为 PL1。

```

{
  "masterConfiguration": {
	"performanceLevel": "PL3"
  }
}
```

升配节点数量目前仅支持数据节点、冷数据节点、弹性数据节点和协调节点升配节点数量。数据节点升配节点数量的方式与其他节点不同，具体参见下文示例。
- 将数据节点的节点数量升至 12 个。

{
  "nodeAmount": 12
}

将其他类型节点（以冷数据节点为例）的节点数量升至 12 个。

{
  "warmNodeConfiguration": {
    "amount": 12
  }
}

升配节点规格将数据节点的规格升至 4 核 32 GB。

{
  "nodeSpec": {
    "spec": "elasticsearch.r5.xlarge"
  }
}

同时升配同一节点的几种配置同时升配同一节点的几种配置，需要您同时写入升配资源 RequestBody。
- 将协调节点的节点数量升至 8，规格升至 4 核 8 GB。

{
  "clientNodeConfiguration": {
    "amount": 8,
    "spec": "elasticsearch.sn1ne.xlarge"
  }
}

将数据节点的节点数量升至 12，存储类型升至 ESSD 云盘。

{
  "nodeAmount": 12,
  "nodeSpec": {
    "diskType": "cloud_essd"
  }
}

启用节点您可以参见 createInstance 接口设置完整的节点资源配置。
- 启用协调节点，同时设置协调节点配置。

{
  "clientNodeConfiguration": {
    "amount": 5,
    "disk": 20,
    "spec": "elasticsearch.sn1ne.xlarge"
  }
}

启用弹性数据节点，同时设置弹性数据节点配置（此配置只适用于中国站）。

{
  "elasticNodeConfiguration": {
    "disk": 200,
    "amount": 5,
    "diskType": "cloud_essd",
    "spec": "elasticsearch.sn1ne.xlarge"
  }
}

启用冷数据节点，同时设置冷数据节点配置。

{
  "warmNodeConfiguration": {
    "disk": 1000,
    "amount": 3,
    "spec": "elasticsearch.sn1ne.xlarge"
  }
}

升配开启 OpenStore（此配置只适用于中国站）已启用冷数据节点的实例以及数据节点存储类型为 ESSD 云盘的实例，目前不支持升配开启 OpenStore。如果实例类型为普通商业版，升配开启 OpenStore 后，实例类型同时由普通商业版升配至开启 Indexing Service 的日志增强版。
- 冷数据节点打开 OpenStore。

{
  "warmNodeConfiguration": {
    "amount": 5,
    "spec": "openstore.i2g.4xlarge"
  }
}

数据节点规格转换为 OpenStore。

{
  "nodeAmount": 6,
  "nodeSpec": {
    "spec": "openstore.i2g.4xlarge",
    "diskType": "cloud_ssd",
    "disk": 100
  }
}

指定变更方式
- 变更方式默认为智能变更，将其指定为蓝绿变更（blue_green）或原地变更（normal）。

{
  "nodeSpec": {
    "spec": "elasticsearch.r5.xlarge"
  },
  "updateType": "blue_green"  ## 原地变更为 normal。
}

开启强制变更。

{
  "nodeSpec": {
    "spec": "elasticsearch.r5.xlarge"
  },
  "force": true
}

使用 dryRun 接口进行升配预校验在 RequestBody 中添加 dryRun 字段。

{
  "nodeSpec": {
    "spec": "elasticsearch.r5.xlarge"
  },
  "dryRun": true
}

降配

说明降配时，不支持升级存储空间数值、存储类型、节点数量、规格的 CPU 核数或内存值。
UpdateInstance 接口无法降低节点数量，如有需求请使用 ShrinkNode 接口。
不支持降配节点存储空间大小，启用的节点不支持关闭。
不支持选择强制变更，不支持指定变更类型，默认使用智能变更。
降配时，orderActionType 参数需要设置为 Downgrade。
您可以同时降配多个资源配置，也可以进行 dryRun 预校验。

降配存储类型降配时，不支持变更冷数据节点（不变更实例类型）、协调节点、Kibana 节点的存储类型。

将专有主节点的存储类型变更为 SSD 云盘。

{
  "masterConfiguration": {
    "diskType": "cloud_ssd"
  }
}

降配规格将数据节点的规格降配至 4 核 32 GB。

{
  "nodeSpec": {
    "spec": "elasticsearch.r5.xlarge"
  }
}

返回参数

字段名称	字段详情
RequestIdstring	请求 ID。示例值:5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****
Resultobject	返回结果。
Codestring
Messagestring

返回示例

变更历史

	变更时间	变更内容概要	操作
	2022-09-27	新增请求参数body 新增请求参数force