本文為您提供阿里云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 | 描述 |
創建服務關聯角色。 | |
驗證是否已經創建服務關聯角色。 |