API标准及多语言预置SDK
本产品（elasticsearch/2017-06-13）的OpenAPI采用ROA签名风格。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
自定义签名场景
若您的业务场景有特殊需求，需通过自签名方式对接 API，建议优先咨询我们的技术支持团队（服务钉钉群：147535001692），获取专业指导以确保高效接入。
账号与安全准备
阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露，所有相关资源都将面临未经授权访问的风险。为确保安全，建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey，同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下，才使用阿里云账号。
实例
|
API |
标题 |
API概述 |
| 索引管理 | 索引管理 | |
| CloseManagedIndex | 关闭索引托管 | 关闭Indexing Service集群中某个索引的云端托管功能。此功能不可逆，关闭后无法再开启。 |
| CreateDataStream | 创建数据流 | 创建数据流，管理一批索引。 |
| CreateILMPolicy | 创建索引生命周期策略 | 创建索引生命周期策略，如果创建的策略名已经存在，则替换成该策略并递增版本。 |
| CreateIndexTemplate | 创建索引模版 | 创建集群索引模板，可用于索引模版的组件化设置。 |
| DeleteDataStream | 删除数据流 | 删除指定的集群数据流。 |
| DeleteILMPolicy | 删除索引生命周期策略 | 删除指定的索引生命周期策略。 |
| DeleteIndexTemplate | 删除索引模板 | 删除置顶的索引模版。 |
| DescribeILMPolicy | 查询索引生命周期详情 | 查询指定索引生命周期详情。 |
| DescribeIndexTemplate | 查看索引模版信息 | 返回有关一个索引模板的信息。 |
| ListDataStreams | ES集群数据流列表 | 获取Elasticserch集群中，索引数据流列表。 |
| ListILMPolicies | 查询索引生命周期列表 | 查询集群已经创建的索引生命周期列表。 |
| ListIndexTemplates | 查询索引模板列表 | 查询索引模板列表。 |
| RolloverDataStream | 滚动更新数据 | 为数据流或索引别名创建新索引。 |
| UpdateILMPolicy | 修改索引生命周期策略 | 修改Elasticsearch索引生命周期策略。 |
| UpdateIndexTemplate | 修改实例模版配置 | 修改Elasticsearch实例模版配置。 |
| CreateComponentIndex | 创建一个组件 | 创建Elasticsearch组合模板。 |
| DeleteComponentIndex | 删除组合索引模板 | 删除Elasticsearch的组合索引模板。 |
| DeleteDeprecatedTemplate | 删除历史索引模板 | 删除历史索引模板。 |
| DescribeComponentIndex | 查看组合索引模板详情 | 查看Elasticsearch的组合模板详情。 |
| DescribeDeprecatedTemplate | 查看历史索引模板详情 | 查看历史索引模板详情。 |
| ListComponentIndices | 组合索引列表 | 获取Elasticsearch的组合模板列表。 |
| ListDeprecatedTemplates | 历史索引模板列表 | 查看历史索引模板列表。 |
| UpdateComponentIndex | 更新组合索引模板 | 更新Elasticsearch的组合模板。 |
| DeleteInstance | 释放指定按量付费类型的实例 | 实例所使用的物理资源都被回收，相关数据全部丢失且不可恢复；挂载实例节点的云盘和相应的快照都会被释放。 |
| UpdateInstanceChargeType | 转换付费类型 | Elasticsearch实例更改付费类型，按量付费实例转换为包年包月实例。 |
| UpdateDescription | 更改实例名称 | 更改Elasticsearch实例名称。 |
| UpdateReadWritePolicy | 开启或关闭集群写入高可用特性 | 开启或关闭集群的写入高可用特性。目前仅支持华北2（北京）区域的实例。 |
| ModifyElastictask | 更新集群弹性扩缩容规则 | 调用ModifyElastictask，更新集群弹性扩缩容规则。 |
| ModifyInstanceMaintainTime | 更改并开启实例的可维护时间 | 调用ModifyInstanceMaintainTime，更改并开启实例的可维护时间。 |
| UpdateKibanaWhiteIps | 更新实例Kibana访问白名单 | 更新指定阿里云Elasticsearch实例的Kibana访问白名单。 |
| UpdateWhiteIps | 修改实例的VPC私网访问白名单 | 修改ES实例的VPC私网访问白名单。 |
| ListInstance | ES实例列表信息 | 获取ES实例列表信息。 |
| DescribeInstance | DescribeInstance | 调用DescribeInstance，查询指定实例的详细信息。 |
| DescribeRegions | 获取区域信息 | 获取阿里云Elasticsearch的区域信息。 |
| ListAllNode | ES实例节点信息 | 获取Elasticsearch集群下的所有节点信息。 |
| GetElastictask | 获取集群弹性扩缩容规则 | 获取集群的弹性扩缩容规则。必须在创建实例时购买弹性节点才可。 |
| ListInstanceIndices | ListInstanceIndices | 调用ListInstanceIndices，获取集群的索引列表。 |
| createInstance | 创建ES实例 | 创建Elasticsearch实例。 |
| EstimatedRestartTime | 实例重启预估时间 | 获取实例重启的大致时间。 |
| RestartInstance | 重启Elasticsearch | 重启Elasticsearch集群。 |
| RenewInstance | ES实例续费 | 为包年包月的Elasticseach实例续费。 |
| ActivateZones | 恢复已下线的可用区 | 恢复已下线的可用区。仅对多可用区实例有效。 |
| DeactivateZones | 下线部分可用区 | 在有多个可用区的情况下，下线部分可用区。并将下线的可用区中的节点迁移到其他可用区。 |
| InterruptElasticsearchTask | 中断变更中的实例 | 中断实例变更任务，仅对状态为生效中的实例有效，中断后，实例进入变更中断（suspended）状态。 |
| ResumeElasticsearchTask | 恢复中断变更 | 恢复实例之间啊变更中断的任务。 |
| MigrateToOtherZone | 迁移可用区 | 迁移对应可用区下的节点到目标可用区。 |
| CancelDeletion | 恢复释放后被冻结的实例 | 恢复释放后被冻结的Elasticsearch实例。 |
| DiagnoseInstance | 诊断实例 | 调用DiagnoseInstance，即刻诊断实例。 |
| MoveResourceGroup | 修改实例资源组 | 修改实例所属资源组。 |
| CapacityPlan | 容量规划 | 用于系统根据业务场景、QPS和日志产生量等情况为您推荐集群容量规划的最佳配置信息。 |
| GetOpenStoreUsage | 查看OpenStore实例用量 | 查看OpensStore实例的存储容量和使用情况。 |
| ListDicts | 查看词典列表详情 | 查看指定类型的词典列表详情。 |
| ListShardRecoveries | 分片恢复数据列表 | 查询有关正在进行和已完成的分片恢复的数据进度列表，默认返回正在进行的分片恢复信息。 |
标签
|
API |
标题 |
API概述 |
| ListTags | 标签列表 | 用户在当前区域创建的所有标签。 |
| ListTagResources | 实例可见资源标签关系 | 获取所有实例和标签的关系。 |
| UntagResources | 删除用户资源标签关系 | 删除指定实例的用户资源标签关系。 |
| TagResources | 创建标签资源关系 | 指定实例创建标签资源关系。 |
数据迁移
|
API |
标题 |
API概述 |
| DeleteDataTask | 删除索引迁移任务 | 删除Elasticsearch索引迁移任务。 |
| GetTransferableNodes | GetTransferableNodes | 指定节点类型和个数，获取可进行数据迁移的节点。 |
| ListDataTasks | ES数据迁移任务列表 | 获取不同Elasticsearch集群之间的数据迁移任务的列表。 |
| GetClusterDataInformation | 索引迁移数据信息 | 获取索引迁移数据信息。 |
| ValidateTransferableNodes | 校验是否可以迁移实例中节点 | 校验是否可以迁移指定实例中某些节点上的数据。 |
| TransferNode | 节点数据迁移 | 节点数据迁移，方便进行缩节点操作。 |
| CancelTask | 取消数据迁移任务 | 取消正在运行的数据迁移任务。 |
采集器
|
API |
标题 |
API概述 |
| CreateCollector | 创建收集器 | 创建采集器，采集指定服务上的数据。 |
| DeleteCollector | 删除采集器 | 删除指定的采集器。 |
| ModifyDeployMachine | 更新一个collector安装的机器 | 更新一个collector安装的esc机器。 |
| UpdateCollector | 修改采集器 | 修改采集器配置。 |
| UpdateCollectorName | 修改采集器名称 | 调用UpdateCollectorName，修改采集器名称。 |
| StartCollector | 启动采集器 | 启动采集器，进行数据采集。 |
| StopCollector | 停止运行中的采集器 | 调用StopCollector，停止运行中的采集器。 |
| DescribeCollector | 获取采集器实例信息 | 获取采集器实例的详细信息。 |
| ListDefaultCollectorConfigurations | 获取默认收集器配置列表 | 调用ListDefaultCollectorConfigurations，获取采集器的默认配置文件。 |
| ListCollectors | 采集器列表信息 | 获取采集器列表信息。 |
| ListNodes | 查询搜索采集器下机器状态 | 智能运维的历史报告列表。 |
| RestartCollector | 重启采集器 | 重启采集器，进行数据采集工作。 |
| ReinstallCollector | 重试采集器的安装 | 重试安装在创建时没有安装成功的采集器。 |
实例升降配
|
API |
标题 |
API概述 |
| UpdateInstance | 集群升配 | Elasticsearch集群升配，增加节点数，角色，规格，磁盘配置。 |
| GetSuggestShrinkableNodes | 获取可缩容节点 | 指定节点类型和数量，获取可缩容的节点。 |
| ValidateShrinkNodes | 校验缩节点 | 校验指定实例中的某些节点是否可以缩容。 |
| ShrinkNode | 集群缩节点 | 指定Elasticsearch节点角色进行缩节点操作。 |
| UpgradeEngineVersion | 升级实例版本或内核补丁版本 | 升级Elasticsearch实例版本，支持版本升级和内核版本升级。 |
集群配置
|
API |
标题 |
API概述 |
| UpdateInstanceSettings | 修改实例的YML参数配置 | 修改指定ES实例的YML参数配置。 |
| UpdateHotIkDicts | 更新实例IK热词词典 | 更新阿里云Elasticsearch实例的IK热词词典。 |
| UpdateSynonymsDicts | 更新实例同义词词典 | 更新阿里云Elasticsearch实例的同义词词典。 |
| UpdateDict | 更新实例用户词典 | 更新Elasticsearch实例的用户词典。 |
| UpdateAdvancedSetting | 更改指定实例的垃圾回收器配置 | 更改Elasticsearch指定实例的垃圾回收器配置。 |
| UpdateExtendConfig | 修改场景化配置模板 | 修改Elasticsearch场景化配置模板。 |
| UpdateTemplate | 修改实例场景化模板配置 | 修改集群的场景化模板配置内容。 |
| UpdateAliwsDict | 更新AliNLP分词插件 | 更新AliNLP分词插件（英文名为analysis-aliws）的词典。 |
| UpdateBlackIps | 修改Elasticsearch实例访问黑名单 | 修改ES实例访问黑名单，已废弃 |
| DescribeTemplates | 获取实例的场景模板配置 | 获取实例的场景模板配置，集群settings配置。 |
| ListAckClusters | 获取 ACK 群集列表 | 获取容器服务Kubernetes版ACK（Container Service for Kubernetes）集群列表。 |
| ListDictInformation | 查看词典信息 | 查看对应的词典信息。 |
| ListEcsInstances | 获取 ECS 实例列表 | 获取当前用户vpc和vswitch下的ECS 实例列表。 |
| DescribeAckOperator | 获取ack运算符详情 | 调用DescribeAckOperator，查看指定容器服务Kubernetes版ACK（Container Service for Kubernetes）集群上安装的Elasticsearch Operator信息。 |
| GetRegionConfiguration | 获取区域信息 | 获取当前的区域信息。 |
| ListAckNamespaces | 获取ack命名空间列表 | 查看指定容器服务Kubernetes版ACK（Container Service for Kubernetes）集群的所有命名空间。 |
| InstallAckOperator | 安装 Ack Operator | 在指定容器服务集群上安装 Ack Operator。 |
| InstallUserPlugins | InstallUserPlugins | 调用InstallUserPlugins，安装用户自定义的已经上传至Elasticsearch控制台的插件。 |
| RecommendTemplates | 获取推荐模板列表 | 调用RecommendTemplates，获取推荐的集群配置。 |
| ValidateSlrPermission | 验证SLR权限 | 验证当前账户SLR权限。 |
| InitializeOperationRole | 创建服务关联角色 | 调用InitializeOperationRole，创建服务关联角色。 |
插件管理
|
API |
标题 |
API概述 |
| ListPlugins | 获取实例插件列表 | 获取指定阿里云Elasticsearch实例的插件列表。 |
| InstallSystemPlugin | 安装ES系统插件 | Elasticsearch实例安装系统插件。 |
| UninstallPlugin | UninstallPlugin | Elasticsearch实例卸载系统插件。 |
集群监控
|
API |
标题 |
API概述 |
| GetEmonMonitorData | GetEmonMonitorData | 调用GetEmonMonitorData，查询Elasticsearch实例的Grafana指标监控数据。 |
| DescribeElasticsearchHealth | 查看集群健康状态 | 查看集群运行的健康状态，是否正常运行。 |
| GetEmonGrafanaAlerts | 获取Grafana报警列表 | 调用GetEmonGrafanaAlerts，获取Grafana报警列表。 |
| GetEmonGrafanaDashboards | 获取Grafana大盘列表 | 调用GetEmonGrafanaDashboards，获取Grafana大盘列表。 |
| PostEmonTryAlarmRule | PostEmonTryAlarmRule | 调用PostEmonTryAlarmRule，发送测试的报警消息。 |
日志查询
|
API |
标题 |
API概述 |
| ListSearchLog | 查看实例日志 | 查看ES实例不同类型的日志。 |
安全配置
|
API |
标题 |
API概述 |
| AddConnectableCluster | 配置实例网络互通 | 配置网络互通，完成不同实例的连接。 |
| DeleteConnectedCluster | 移除互通实例 | 删除两个实例之间的网络互通。 |
| UpdatePrivateNetworkWhiteIps | 修改实例的VPC私网访问白名单 | 更新指定实例的VPC私网访问白名单。 |
| UpdatePublicWhiteIps | 更新实例公网地址访问白名单 | 更新指定Elasticsearch实例的公网地址访问白名单。 |
| UpdatePublicNetwork | 开启或关闭实例公网地址 | 开启或关闭指定Elasticsearch实例的公网地址。 |
| UpdateAdminPassword | 更新实例的elastic账号密码 | 更新指定Elasticsearch实例的elastic账号的密码。 |
| ModifyWhiteIps | 更新指定实例的访问白名单 | 调用ModifyWhiteIps，更新指定实例的访问白名单。 |
| DescribeConnectableClusters | 获取网络互通实例列表 | 获取能够与当前实例进行网络互通的实例列表。不包括已经打通的实例。 |
| ListConnectedClusters | 获取与当前实例进行网络互通的实例列表 | 获取已经与当前实例进行了网络互通的实例列表。 |
| TriggerNetwork | 开启或关闭公网或私网访问 | 开启或关闭Elasticsearch或Kibana集群的公网或私网访问。 |
| OpenHttps | 开启HTTPS协议 | 开启HTTPS协议。开启前请确保已购买协调节点。 |
| CloseHttps | 关闭HTTPS协议 | 关闭集群HTTPS协议。 |
| CreateVpcEndpoint | 创建私网链接VPC终端节点 | 创建私网链接VPC终端节点，用于连接用户VPC下创建的终端节点服务。 |
| DeleteVpcEndpoint | 删除服务账号vpc下的终端节点 | 调用DeleteVpcEndpoint，删除服务VPC下的终端节点。 |
| ListVpcEndpoints | ListVpcEndpoints | 调用ListVpcEndpoints，查看服务账号VPC下的终端节点状态。 |
数据备份
|
API |
标题 |
API概述 |
| CreateSnapshot | 集群索引快照备份 | 调用CreateSnapshot，手动对集群进行快照备份。 |
| AddSnapshotRepo | 创建引用仓库 | 在设置跨集群OSS仓库时，创建引用仓库。 |
| DeleteSnapshotRepo | DeleteSnapshotRepo | 删除实例跨集群OSS引用仓库。 |
| UpdateSnapshotSetting | UpdateSnapshotSetting | 更新指定实例的数据备份配置。 |
| DescribeSnapshotSetting | 获取集群的快照备份设置 | 获取集群的快照备份设置，备份周期。 |
| ListSnapshotReposByInstanceId | ES实例的跨集群OSS仓库列表 | 获取当前实例的跨集群OSS仓库设置列表。 |
| ListAlternativeSnapshotRepos | 实例可添加的OSS引用仓库 | 获取当前实例可添加的OSS引用仓库。 |
智能运维
|
API |
标题 |
API概述 |
| ListDiagnosisItems | 智能诊断项列表 | 列举Elasticsearch实例智能诊断项目。 |
| UpdateDiagnosisSettings | 修改智能运维场景设置 | 修改指定Elasticsearch实例的智能运维场景设置。 |
| ListDiagnoseReport | ListDiagnoseReport | 调用ListDiagnoseReport，获取智能运维的历史报告。 |
| ListDiagnoseReportIds | 智能运维历史报告ID列表 | 获取智能运维历史报告所有的ID。 |
| DescribeDiagnoseReport | 查看智能运维的历史报告 | 调用DescribeDiagnoseReport，查看智能运维的历史报告。 |
| DescribeDiagnosisSettings | 获取智能运维的场景设置 | 调用DescribeDiagnosisSettings，获取智能运维的场景设置。 |
| ListDiagnoseIndices | 获取智能运维模块中的诊断索引 | 获取指定实例智能运维模块中健康诊断的诊断索引。 |
| OpenDiagnosis | 开启智能运维 | 打开实例的智能运维功能。 |
| CloseDiagnosis | 关闭实例的智能运维功能 | 关闭实例的智能运维功能。 |
Kibana
|
API |
标题 |
API概述 |
| UpdateKibanaSettings | 修改Kibana配置 | 修改Kibana配置。目前仅支持修改Kibana语言配置。 |
| DescribeKibanaSettings | 获取Kibana配置 | 获取Elasticsearch实例的Kibana节点的配置。 |
| ListKibanaPlugins | Kibana节点插件列表 | 获取Elasticsearch Kibana节点的插件列表。 |
| InstallKibanaSystemPlugin | 安装Kibana预置插件 | 安装Kibana预置插件。要求Kibana的规格为2核4G及以上。 |
| UninstallKibanaPlugin | 卸载Kibana插件 | 卸载Elasticsearch实例Kibana节点插件。 |
Logstash
|
API |
标题 |
API概述 |
| 实例管理 | 实例管理 | |
| DeleteLogstash | 释放Logstash实例 | 主动释放Logstash实例。 |
| UpdateLogstash | 修改实例部分信息 | 修改指定实例的部分信息，例如节点数、配额、名称、硬盘大小等。 |
| UpdateLogstashDescription | 修改Logstash实例名称 | 修改指定Logstash实例名称。 |
| UpdateLogstashChargeType | UpdateLogstashChargeType | 将按量付费的阿里云Logstash实例转换为包年包月实例。 |
| ListLogstash | 获取Logstash实例 | 在列表中展示所有或指定Logstash实例的详细信息。 |
| DescribeLogstash | 查询Logstash实例信息 | 查询Logstash实例详细信息。 |
| RenewLogstash | Logstash实例续费 | 指定Logstash实例续费。 |
| RestartLogstash | 重启实例 | 重启指定实例。重启后，实例会进入生效中（activing）状态。 |
| EstimatedLogstashRestartTime | 获取Logstash实例重启预估时间 | 获取Logstash实例重启的预估时间。 |
| 集群配置 | 集群配置 | |
| UpdateLogstashSettings | 修改Logstash实例配置 | 更新指定Logstash实例的配置。 |
| ListExtendfiles | Logstash扩展文件配置 | 获取Logstash实例的扩展文件配置。 |
| 插件管理 | 插件管理 | |
| ListLogstashPlugins | 获取Logstash插件列表 | 调用ListLogstashPlugins，获取所有或指定插件的详细信息。 |
| InstallLogstashSystemPlugin | 安装Logstash系统插件 | 为指定的Logstash实例安装系统插件。 |
| UninstallLogstashPlugin | 卸载已安装的插件 | Logstash实例卸载已安装的插件。 |
| 日志查询 | 日志查询 | |
| ListLogstashLog | 查看Logstash实例的日志 | 调用ListLogstashLog，查看Logstash实例的日志。 |
| 集群监控 | 集群监控 | |
| UpdateXpackMonitorConfig | 更新X-Pack监控报警配置 | 更新Logstash实例的X-Pack监控报警配置。 |
| ListAvailableEsInstanceIds | 获取可用的实例列表 | 在设置Logstash实例的X-Pack监控时，获取可用的Elasticsearch实例列表。 |
| DescribeXpackMonitorConfig | 获取实例X-Pack监控配置 | 获取Logstash实例的X-Pack监控配置。 |
| ValidateConnection | 验证监控联通性 | 验证提供X-Pack监控的Elasticsearch实例的联通性。 |
| 变更任务管理 | 变更任务管理 | |
| InterruptLogstashTask | 中断实例变更任务 | 中断后，实例会进入中断中（suspended）状态。 |
| ResumeLogstashTask | 恢复实例变更中断任务 | 恢复实例的变更中断任务。恢复后实例会进入生效中（activating）状态。 |
| 管道管理 | 管道管理 | |
| CreatePipelines | 创建Logstash管道 | 创建Logstash管道，采集数据。 |
| DeletePipelines | 删除Logstash管道 | 删除Logstash实例所配置的管道。 |
| UpdatePipelines | 更新Logstash管道信息 | 调用UpdatePipelines，更新Logstash管道信息。 |
| StopPipelines | 停止运行Logstash管道 | 调用StopPipelines，停止运行Logstash管道。 |
| UpdatePipelineManagementConfig | UpdatePipelineManagementConfig | 修改指定Logstash实例的管道管理方式。 |
| ListPipeline | Logstash的管道列表 | 获取Logstash的管道列表。 |
| DescribePipeline | 获取Logstash管道信息 | 获取Logstash实例的管道信息。 |
| DescribePipelineManagementConfig | 获取Logstash管道配置 | 调用DescribePipelineManagementConfig，获取Logstash管道管理配置。 |
| RunPipelines | 部署运行Logstash管道 | 调用RunPipelines，立即部署Logstash管道。 |
| CreateLogstash | 创建Logstash实例 | 调用CreateLogstash，创建一个Logstash实例。 |
| UpdateExtendfiles | 更新扩展文件配置 | 更新Logstash实例的扩展文件配置。 |
| ListPipelineIds | Logstash管道ID列表 | 获取Logstash实例管道ID列表。 |
| CancelLogstashDeletion | 恢复释放后被冻结的实例 | 恢复释放后被冻结的Logstash实例。 |
其他
|
API |
标题 |
API概述 |
| TurnOnZone | 重新打开已下线的可用区 | 多可用区实例， 重新打开一个已经下线的可用区，仅用于容灾演练、请慎重操作！ |
| ListInstanceHistoryEvents | ListInstanceHistoryEvents | 调用ListInstanceHistoryEvents，查看Elasticsearch集群触发的硬件运维事件列表。 |
| UpdateDynamicSettings | 修改集群动态配置 | 修改集群动态配置 |
| DescribeDynamicSettings | 获取集群动态配置 | 获取集群动态指标 |
| ListActionRecords | 查询实例变更记录 | 变更记录 变更详情 |
| DisableKibanaPvlNetwork | 关闭kibana私网 | 关闭kibana私网 |
| UpdateKibanaPvlNetwork | 更新kibana私网 | 更新kibana私网访问 |
| ListKibanaPvlNetwork | ListKibanaPvlNetwork | 调用ListKibanaPvlNetwork，查询Kibana私网访问详细信息。 |
| EnableKibanaPvlNetwork | EnableKibanaPvlNetwork | 调用EnableKibanaPvlNetwork，开启Kibana私网访问。 |
| TurnOffZone | 多可用区实例关闭一个已有的可用区 | 多可用区实例关闭一个已有的可用区 ， 仅用于容灾演练，请慎重操作！ |
| ListUserPlugin | 自定义插件列表 | 用户自定义插件列表 |
| PluginAnalysis | 上传自定义插件到插件库 | 上传自定义插件到插件库，上传后插件为待安装状态 |
| RemovePlugin | 移除未安装的自定义插件 | 已上传未安装的插件可以从插件库中删除 |
| UpgradeInfo | 查询可升级的版本信息 | 查询指定 Elasticsearch 实例是否存在可升级的引擎版本及其版本信息。 |
| GrayPublish | 灰度重启继续发布 | Elasticsearch实例执行灰度重启，灰度发布完成后，继续重启剩余节点 |
| InitModel | 注册AI搜索开放平台模型 | 初始化AI模型 |
| ListEventRecords | 获取事件列表 | 获取事件列表 |
| ListStatsEventRecords | 统计事件记录 | 统计事件记录 |
| UpdateKibanaSso | 修改kibana阿里云账号鉴权配置 | 开启或者关闭kibana阿里云账号鉴权， 开启阿里云账号鉴权后需要先登录阿里云账号才能继续使用kibana相关功能 |
| ModifyScheduleExecuteTime | 修改预约事件执行时间 | 对于事件中心的运维事件，您可以指定重启事件，系统会按照预约时间重启相关实例的指定节点 |
| GetKeystores | 查询集群keystore信息 | 查询指定 Elasticsearch 实例的 keystore 配置 |
| UpdateKeystores | 更新keystore设置 | 新增、更新或删除指定 Elasticsearch 实例的 keystore 配置。 |
| UpdateFalconSeek | 开关FalconSeek云原生内核特性 | 开关FalconSeek云原生内核特性, 适用于8.17版本实例 |
| InvokeEsAgent | 调用 ES Agent | 基于 JSON-RPC 2.0 协议调用阿里云 Elasticsearch Agent 服务，支持创建和管理Agent会话、发送消息并接收SSE流式响应、断点重连、取消执行中的任务以及处理Agent发起的人工干预（HITL）交互。目前仅开放上海区域。 |
| InvokeEsRequest | 代理访问ES | 使用已登记的托管凭证代理访问 ES 原生 API，可访问范围由该凭证在 ES 侧的权限决定。另外，通过子账号以及托管凭证访问此接口时调用方除需具备本接口权限外，还需对所使用的凭证具备 elasticsearch:UseCredential 权限。 |
该文章对您有帮助吗？