本文为您提供阿里云Elasticsearch、Kibana、Logstash和Beats的API接口及说明。如果您需要使用本文中没有提到的接口 ,请联系阿里云技术支持工程师获取。
Elasticsearch
类别 | API | 描述 |
实例管理 | 创建Elasticsearch实例。 | |
在列表中展示所有或指定实例的详细信息。 | ||
查询指定实例的详细信息。 | ||
获取重启实例的预估时间。 | ||
重启指定实例。 | ||
将按量付费实例转换为包年包月实例。 | ||
更新指定实例的名称。 | ||
释放指定按量付费类型的实例。释放后,实例所使用的物理资源都被回收,相关数据全部丢失且不可恢复;挂载实例节点的云盘和相应的快照都会被释放。 | ||
恢复释放后被冻结的实例。 | ||
为包年包月实例续费。 | ||
恢复已下线的可用区中的节点。仅对多可用区实例有效。 | ||
在有多个可用区的情况下,下线部分可用区。并将下线的可用区中的节点迁移到其他可用区。 | ||
获取阿里云Elasticsearch的地域信息。 | ||
开启或关闭集群的写入高可用特性。目前仅支持华北2(北京)地域的实例。 | ||
中断变更中的实例。仅对状态为生效中的实例有效,中断后,实例进入变更中断(suspended)状态。 | ||
恢复中断变更的实例。 | ||
获取集群下的所有节点信息。 | ||
获取指定实例的健康情况。 | ||
获取集群的弹性扩缩容规则。必须在创建实例时购买弹性节点,才可调用此接口。 | ||
更新集群弹性扩缩容规则。 | ||
获取集群的索引列表。 | ||
迁移对应可用区下的节点到目标可用区。 | ||
迁移实例到指定资源组。 | ||
更改并开启实例的可维护时间。 | ||
获取当前地域的开放配置信息。接口返回值为全量数据供参考,以控制台和售卖页实际展示值为准。 | ||
获取有关正在进行和已完成的分片恢复的数据进度列表,默认返回正在进行的分片恢复信息。 | ||
用于系统根据业务场景、QPS和日志产生量等情况为您推荐集群容量规划的最佳配置信息。 | ||
统计OpenStore实例的存储容量和使用情况。 | ||
创建Elasticsearch组合模板。 | ||
获取Elasticsearch的组合模板列表。 | ||
查看Elasticsearch的组合模板详情。 | ||
更新Elasticsearch的组合模板。 | ||
删除Elasticsearch的组合模板。 | ||
查看历史索引模板列表。 | ||
查看历史索引模板详情。 | ||
删除历史索引模板。 | ||
标签管理 | 查询所有可见的用户标签。 | |
查询可见的资源标签关系。 | ||
创建标签资源关系。 | ||
删除用户资源标签关系。 | ||
数据迁移 | 指定节点类型和个数,获取可进行数据迁移的节点。 | |
校验是否可以迁移指定实例中某些节点上的数据。 | ||
执行数据迁移任务。 | ||
获取数据迁移任务信息。 | ||
创建索引迁移任务,将所选集群中的数据迁移到当前集群。 | ||
获取集群的数据信息。 | ||
删除索引迁移任务。 | ||
取消数据迁移任务。 | ||
实例升降配 | 指定节点类型和数量,获取可缩容的节点。 | |
校验指定实例中的某些节点是否可以缩容。 | ||
执行集群节点缩容操作。 | ||
升级Elasticsearch的实例版本或内核补丁版本。升级实例版本功能目前只支持5.5.3版本升级到5.6.16版本、5.6.16版本升级到6.3.2版本、6.3.2版本升级到6.7.0版本,暂不支持其他版本间的升级。详情请参见升级版本。 | ||
变更集群配置(升配或降配)。 | ||
集群配置 | 更新指定实例的YML参数配置。 | |
更新指定实例的IK热词词典。 | ||
更新指定实例的同义词词典。 | ||
更新指定实例的用户词典。 | ||
更新指定实例AliNLP分词插件(analysis-aliws)的词典文件。支持自定义词库配置。 | ||
在添加用户OSS存储的词典文件时,获取和校验用户OSS词典文件的详情。 | ||
更改指定实例的垃圾回收器配置。 | ||
获取指定实例的场景模板配置。 | ||
修改集群的场景化配置模板。 | ||
修改集群的场景化模板配置内容。 | ||
获取推荐的集群配置。 | ||
获取指定类型的词典详情以及签名生成的公网可下载链接。 | ||
插件管理 | 获取指定实例的插件列表。 | |
安装系统预置插件。 | ||
卸载已安装的预置插件。 | ||
安装用户自定义的已经上传至Elasticsearch控制台的插件。 | ||
集群监控 | 查询实例的Grafana指标监控数据。 | |
获取Grafana大盘列表。 | ||
获取Grafana报警列表。 | ||
发送测试的报警消息。 | ||
日志查询 | 查看实例日志。 | |
安全配置 | 开启或关闭Elasticsearch、Kibana的公网或私网访问。 | |
更新指定实例的VPC私网访问白名单。 | ||
更新指定实例的公网地址访问白名单。 | ||
开启或关闭指定实例的公网地址。 | ||
更新指定实例的VPC私网访问白名单。 | ||
更新指定实例的访问白名单。 | ||
更新指定实例的elastic账号的密码。 | ||
开启HTTPS协议。除8.5版本、7.16版本和部分地域的7.10版本外,开启前请确保您已购买协调节点。 | ||
关闭HTTPS协议。 | ||
配置实例网络互通。 | ||
移除互通实例。 | ||
获取能够与当前实例进行网络互通的实例列表。不包括已经打通的实例。 | ||
获取已经与当前实例进行了网络互通的实例列表。 | ||
创建服务账号VPC下的终端节点,用于连接用户VPC下的终端节点服务,以单向打通网络。 | ||
删除服务VPC下的终端节点。 | ||
查看服务VPC下的终端节点状态。 | ||
数据备份 | 手动对集群进行快照备份。 | |
获取集群的数据备份配置。 | ||
更新指定实例的数据备份配置。 | ||
获取当前实例的跨集群OSS仓库设置列表。 | ||
获取当前实例可添加的OSS引用仓库。 | ||
在设置跨集群OSS仓库时,创建引用仓库。 | ||
删除一个跨集群OSS引用仓库。 | ||
智能运维 | 打开实例的智能运维功能。 | |
关闭实例的智能运维功能。 | ||
即刻诊断实例。 | ||
获取智能运维的历史报告。 | ||
获取智能运维历史报告的ID。 | ||
获取指定实例智能运维模块中,健康诊断的诊断索引。 | ||
查看智能运维的历史报告。 | ||
获取智能运维的场景设置。 | ||
更新实例的智能运维场景设置。 | ||
索引管理 | 创建集群索引模板,可用于索引模板的组件化设置。 | |
删除索引模板。 | ||
更新索引模板的组件化设置。 | ||
查看组件索引模板详情,包括索引生命周期。 | ||
查询索引模板列表。 | ||
查询指定索引生命周期详情。 | ||
查询已有的索引生命周期策略列表。 | ||
创建索引生命周期策略。 | ||
删除指定的生命周期策略定义。 | ||
修改索引生命周期策略。 | ||
创建数据流。 | ||
删除数据流。 | ||
手动滚动更新数据流下的匹配索引。进行此操作后,将为当前数据流创建一个新的索引,该索引将成为数据流的新写索引。 | ||
查看数据流列表。 | ||
关闭Indexing Service集群中某个索引的云端托管功能。此功能不可逆,关闭后无法再开启。 |
Kibana
API | 描述 |
获取Kibana配置。 | |
修改Kibana配置。目前仅支持修改Kibana语言配置。 | |
获取Kibana插件列表。 | |
安装Kibana预置插件。要求Kibana的规格为2核4 GB及以上。 | |
卸载Kibana插件。 | |
更新指定实例的Kibana访问白名单。 |
Logstash
类别 | API | 描述 |
实例管理 | 创建Logstash实例。 | |
在列表中展示所有或指定Logstash实例的详细信息。 | ||
查询指定实例的详细信息。 | ||
修改指定实例的部分信息,例如节点数、配额、名称、硬盘大小等。 | ||
为实例续费。 | ||
重启指定实例。重启后,实例会进入生效中(activating)状态。 | ||
修改指定实例的名称。 | ||
将按量付费的阿里云Logstash实例转换为包年包月实例。 | ||
获取Logstash实例重启的预估时间。 | ||
释放指定实例。 | ||
恢复释放后被冻结的Logstash实例。 | ||
集群配置 | 更新指定Logstash实例的配置。 | |
获取Logstash实例的扩展文件配置。 | ||
更新Logstash实例的扩展文件配置。 | ||
集群监控 | 在设置Logstash实例的X-Pack监控时,获取可用的Elasticsearch实例列表(具备X-Pack监控能力)。 | |
在Logstash实例的监控报警配置中,验证提供X-Pack监控的Elasticsearch实例的联通性。 | ||
更新Logstash实例的X-Pack监控报警配置。 | ||
获取Logstash实例的X-Pack监控配置。 | ||
插件管理 | 获取所有或指定插件的详细信息。 | |
安装插件。 | ||
卸载已安装的插件。 | ||
日志查询 | 查看Logstash实例的日志。 | |
变更任务管理 | 中断实例变更任务。中断后,实例会进入中断中(suspended)状态。 | |
恢复实例的变更中断任务。恢复后实例会进入生效中(activating)状态。 | ||
管道管理 | 创建Logstash管道。 | |
获取Logstash实例的管道列表。 | ||
获取Logstash实例的管道信息。 | ||
更新Logstash管道信息。 | ||
立即部署Logstash管道。 | ||
停止运行Logstash管道。 | ||
更新Logstash管道管理方式。 | ||
获取Logstash管道管理配置。 | ||
删除指定的Logstash管道。 | ||
设置Kibana管道管理时,测试Logstash与Kibana连通性,并获取目标Kibana上创建的管道ID列表。 |
Beats
API | 描述 |
创建采集器。 | |
获取采集器实例的详细信息。 | |
重试安装在创建时没有安装成功的采集器。 | |
获取采集器列表信息。 | |
获取采集器的默认配置文件。 | |
修改采集器名称。 | |
更新采集器实例信息。 | |
启动采集器。 | |
重启采集器。 | |
停止运行中的采集器。 | |
删除采集器。 | |
获取ECS机器列表。 | |
更新采集器安装的ECS机器。 | |
查看安装采集器的ECS机器的状态。 | |
获取容器服务Kubernetes版ACK(Container Service for Kubernetes)集群列表。 | |
查看指定容器服务Kubernetes版ACK集群的所有命名空间。 | |
查看指定容器服务Kubernetes版ACK集群上安装的Elasticsearch Operator信息。 | |
在指定容器服务Kubernetes版ACK集群上安装Elasticsearch Operator。 |
高级监控报警
API | 描述 |
查看Elasticsearch集群触发的硬件运维事件列表。 | |
重启阿里云Elasticsearch中的ECS节点。 |
APM
API | 描述 |
调用StartApm,启动APM Server实例。 | |
调用StopApm,停止APM Server实例。 | |
调用RemoveApm,删除APM Server实例。 | |
调用UpdateApm,修改APM Server实例配置信息。 | |
调用ListApm,查询所有APM Server实例详情。 | |
调用DescribeApm,获取指定APM Server实例详情。 |
访问控制
API | 描述 |
创建服务关联角色。 | |
验证是否已经创建服务关联角色。 |