本文为您提供阿里云Elasticsearch、Kibana的API接口及说明。如果您需要使用本文中没有提到的接口 ,请联系阿里云技术支持工程师获取。

Elasticsearch

类别 API 描述
实例管理 createInstance 调用createInstance,创建Elasticsearch实例。
ListInstance 调用ListInstance,在列表中展示所有或指定实例的详细信息。
DescribeInstance 调用DescribeInstance,查询指定实例的详细信息。
RestartInstance 调用RestartInstance,重启指定的阿里云Elasticsearch实例。
UpdateInstance 调用UpdateInstance,修改实例的部分信息,包括节点数、配额、名称、硬盘等。
UpdateInstanceChargeType 调用UpdateInstanceChargeType,将按量付费实例转换为包年包月实例。
UpdateDescription 调用UpdateDescription,更新指定实例的名称。
DeleteInstance 调用DeleteInstance,释放指定按量付费类型的阿里云Elasticsearch实例。释放后,实例所使用的物理资源都被回收,相关数据全部丢失且不可恢复;挂载实例节点的云盘和相应的快照都会被释放。
RenewInstance 调用RenewInstance,为包年包月实例续费。
ActivateZones 调用ActivateZones,恢复已下线的可用区中的节点。仅对多可用区实例有效。
DeactivateZones 调用DeactivateZones,在有多个可用区的情况下,下线部分可用区。并将下线的可用区中的节点迁移到其他可用区。
InterruptElasticsearchTask 调用InterruptElasticsearchTask,中断变更中的阿里云Elasticsearch实例。仅对状态为生效中的实例有效,中断后,实例进入变更中断(suspended)状态。
标签管理 ListTagResources 调用ListTagResources,查询可见的资源标签关系。
TagResources 调用TagResources,创建标签资源关系。
UntagResources 调用UntagResources,删除用户资源标签关系。
数据迁移 GetTransferableNodes 调用GetTransferableNodes,指定节点类型和个数,获取可进行数据迁移的节点。
ValidateTransferableNodes 调用ValidateTransferableNodes,校验是否可以迁移指定实例中某些节点上的数据。
TransferNode 调用TransferNode,执行数据迁移任务。
CancelTask 调用CancelTask,取消数据迁移任务。
实例升降配 GetSuggestShrinkableNodes 调用GetSuggestShrinkableNodes,指定节点类型和数量,获取可缩容的节点。
ValidateShrinkNodes 调用ValidateShrinkNodes,校验指定实例中的某些节点是否可以缩容。
ShrinkNode 调用ShrinkNode,执行集群节点缩容操作。
UpgradeEngineVersion 调用UpgradeEngineVersion,升级Elasticsearch的实例版本或内核补丁版本。升级实例版本功能仅支持将6.3版本的实例升级至6.7版本。
集群配置 UpdateInstanceSettings 调用UpdateInstanceSettings,更新指定实例的YML参数配置。
UpdateHotIkDicts 调用UpdateHotIkDicts,更新阿里云Elasticsearch实例的IK热词词典。
UpdateSynonymsDicts 调用UpdateSynonymsDicts,更新阿里云Elasticsearch实例的同义词词典。
UpdateAdvancedSetting 调用UpdateAdvancedSetting,更改指定实例的垃圾回收器配置。
插件管理 ListPlugins 调用ListPlugins,获取指定阿里云Elasticsearch实例的插件列表。
InstallSystemPlugin 调用InstallSystemPlugin,安装系统预置插件。
UninstallPlugin 调用UninstallPlugin,卸载已安装的预置插件。
日志查询 ListSearchLog 调用ListSearchLog,查看实例日志。
安全配置 TriggerNetwork 调用TriggerNetwork,开启或关闭Elasticsearch、Kibana的公网或私网访问。
UpdatePrivateNetworkWhiteIps 调用UpdatePrivateNetworkWhiteIps,更新指定实例的VPC私网访问白名单。
UpdatePublicWhiteIps 调用UpdatePublicWhiteIps,更新指定实例的公网地址访问白名单。
UpdatePublicNetwork 调用UpdatePublicNetwork,开启或关闭指定实例的公网地址。
UpdateAdminPassword 调用UpdateAdminPassword,更新指定实例的elastic账号的密码。
OpenHttps 调用OpenHttps,开启HTTPS协议。开启前请确保您已购买协调节点。
CloseHttps 调用CloseHttps,关闭HTTPS协议。
AddConnectableCluster 调用AddConnectableCluster,配置实例网络互通。
DeleteConnectedCluster 调用DeleteConnectedCluster,移除互通实例。
数据备份 DescribeSnapshotSetting 调用DescribeSnapshotSetting,获取集群的数据备份配置。
UpdateSnapshotSetting 调用UpdateSnapshotSetting,更新指定实例的数据备份配置。
ListSnapshotReposByInstanceId 调用ListSnapshotReposByInstanceId,获取当前实例的跨集群OSS仓库设置列表。
ListAlternativeSnapshotRepos 调用ListAlternativeSnapshotRepos,获取当前实例可添加的OSS引用仓库。

Kibana

API 描述
DescribeKibanaSettings 调用DescribeKibanaSettings,获取Kibana配置。
UpdateKibanaSettings 调用UpdateKibanaSettings,修改Kibana配置。目前仅支持修改Kibana语言配置。
ListKibanaPlugins 调用ListKibanaPlugins,获取Kibana插件列表。
InstallKibanaSystemPlugin 调用InstallKibanaSystemPlugin,安装Kibana预置插件。要求Kibana的规格为2核4G及以上。
UninstallKibanaPlugin 调用UninstallKibanaPlugin,卸载Kibana插件。