Elasticsearch API匯總 - Elasticsearch

本文為您提供Elasticsearch、Kibana、Logstash和Beats的API介面及說明。如果您需要使用本文中沒有提到的介面，請聯絡阿里雲支援人員工程師擷取。

Elasticsearch

類別	API	描述
執行個體管理	createInstance	建立Elasticsearch執行個體。
	ListInstance	在列表中展示所有或指定執行個體的詳細資料。
	DescribeInstance	查詢指定執行個體的詳細資料。
	EstimatedRestartTime	擷取重啟執行個體的預估時間。
	RestartInstance	重啟指定執行個體。
	UpdateInstanceChargeType	將隨用隨付執行個體轉換為訂用帳戶執行個體。
	UpdateDescription	更新指定執行個體的名稱。
	DeleteInstance	釋放指定隨用隨付類型的執行個體。釋放後，執行個體所使用的實體資源都被回收，相關資料全部丟失且不可恢複；掛載執行個體節點的雲端硬碟和相應的快照都會被釋放。
	CancelDeletion	恢複釋放後被凍結的執行個體。
	RenewInstance	為訂用帳戶執行個體續約。
	ActivateZones	恢複已下線的可用性區域中的節點。僅對多可用性區域執行個體有效。
	DeactivateZones	在有多個可用性區域的情況下，下線部分可用性區域。並將下線的可用性區域中的節點遷移到其他可用性區域。
	DescribeRegions	擷取Elasticsearch的地區資訊。
	InterruptElasticsearchTask	中斷變更中的執行個體。僅對狀態為生效中的執行個體有效，中斷後，執行個體進入變更中斷（suspended）狀態。
	ResumeElasticsearchTask	恢複中斷變更的執行個體。
	ListAllNode	擷取叢集下的所有節點資訊。
	DescribeElasticsearchHealth	擷取指定執行個體的健康情況。
	ListInstanceIndices	擷取叢集的索引列表。
	MigrateToOtherZone	遷移對應可用性區域下的節點到目標可用性區域。
	MoveResourceGroup	遷移執行個體到指定資源群組。
	ModifyInstanceMaintainTime	更改並開啟執行個體的可維護時間。
	GetRegionConfiguration	擷取當前地區的開放配置資訊。介面傳回值為全量資料供參考，以控制台和售賣頁實際展示值為準。
	ListShardRecoveries	擷取有關進行中和已完成的分區恢複的資料進度列表，預設返回進行中的分區恢複資訊。
	CapacityPlan	用於系統根據業務情境、QPS和日誌產生量等情況為您推薦叢集容量規劃的最佳配置資訊。
標籤管理	ListTags	查詢所有可見的使用者標籤。
	ListTagResources	查詢可見的資源標籤關係。
	TagResources	建立標籤資源關係。
	UntagResources	刪除使用者資源標籤關係。
資料移轉	GetTransferableNodes	指定節點類型和個數，擷取可進行資料移轉的節點。
	ValidateTransferableNodes	校正是否可以遷移指定執行個體中某些節點上的資料。
	TransferNode	執行資料移轉任務。
	ListDataTasks	擷取資料移轉任務資訊。
	GetClusterDataInformation	擷取叢集的資料資訊。
	DeleteDataTask	刪除索引遷移任務。
	CancelTask	取消資料移轉任務。
執行個體升降配	GetSuggestShrinkableNodes	指定節點類型和數量，擷取可縮容的節點。
	ValidateShrinkNodes	校正指定執行個體中的某些節點是否可以縮容。
	ShrinkNode	執行叢集節點縮容操作。
	UpgradeEngineVersion	升級執行個體版本或核心補丁版本。升級執行個體版本功能僅支援將6.3版本的執行個體升級至6.7版本。
	UpdateInstance	變更集群配置（升配或降配）。
叢集配置	UpdateInstanceSettings	更新指定執行個體的YML參數配置。
	UpdateHotIkDicts	更新指定執行個體的IK熱詞詞典。
	UpdateSynonymsDicts	更新指定執行個體的同義字詞典。
	UpdateDict	冷更新Elasticsearch執行個體的IK分詞外掛程式，包括IK主分詞詞庫和IK停用詞詞庫。
	UpdateAliwsDict	更新AliNLP分詞外掛程式（analysis-aliws）的詞典檔案。支援自訂詞庫配置。
	ListDictInformation	在添加使用者OSS儲存的詞典檔案時，擷取和校正使用者OSS詞典檔案的詳情。
	UpdateAdvancedSetting	更改指定執行個體的記憶體回收行程配置。
	ListDicts	擷取指定類型的詞典詳情以及簽名產生的公網可下載連結。
外掛程式管理	ListPlugins	擷取指定執行個體的外掛程式列表。
	InstallSystemPlugin	安裝系統預置外掛程式。
	UninstallPlugin	卸載已安裝的預置外掛程式。
	InstallUserPlugins	安裝使用者自訂的已經上傳至Elasticsearch控制台的外掛程式。
日誌查詢	ListSearchLog	查看執行個體日誌。
安全配置	TriggerNetwork	開啟或關閉Elasticsearch、Kibana的公網或私網訪問。
	UpdatePrivateNetworkWhiteIps	更新指定執行個體的VPC私網訪問白名單。
	UpdatePublicWhiteIps	更新指定執行個體的公網地址訪問白名單。
	UpdatePublicNetwork	開啟或關閉指定執行個體的公網地址。
	UpdateWhiteIps	更新指定執行個體的VPC私網訪問白名單。
	ModifyWhiteIps	更新指定執行個體的訪問白名單。
	UpdateAdminPassword	更新指定執行個體的elastic帳號的密碼。
	OpenHttps	開啟HTTPS協議。除8.5版本、7.16版本外，開啟前請確保您已購買協調節點。
	CloseHttps	關閉HTTPS協議。
	AddConnectableCluster	配置執行個體網路互連。
	DeleteConnectedCluster	移除互連執行個體。
	DescribeConnectableClusters	擷取能夠與當前執行個體進行網路互連的執行個體列表。不包括已經打通的執行個體。
	ListConnectedClusters	擷取已經與當前執行個體進行了網路互連的執行個體列表。
	CreateVpcEndpoint	建立服務帳號VPC下的終端節點，用於串連使用者VPC下的終端節點服務，以單向打通網路。
	DeleteVpcEndpoint	刪除服務VPC下的終端節點。
	ListVpcEndpoints	查看服務VPC下的終端節點狀態。
資料備份	CreateSnapshot	手動對叢集進行快照備份。
	DescribeSnapshotSetting	擷取叢集的資料備份配置。
	UpdateSnapshotSetting	更新指定執行個體的資料備份配置。
	ListSnapshotReposByInstanceId	擷取當前執行個體的跨叢集OSS倉庫設定列表。
	ListAlternativeSnapshotRepos	擷取當前執行個體可添加的OSS引用倉庫。
	AddSnapshotRepo	在設定跨叢集OSS倉庫時，建立引用倉庫。
	DeleteSnapshotRepo	刪除一個跨叢集OSS引用倉庫。
智能營運	OpenDiagnosis	開啟執行個體的智能營運功能。
	CloseDiagnosis	關閉執行個體的智能營運功能。
	DiagnoseInstance	即刻診斷執行個體。
	ListDiagnoseReport	擷取智能營運的歷史報告。
	ListDiagnoseReportIds	擷取智能營運歷史報告的ID。
	ListDiagnoseIndices	擷取指定執行個體智能營運模組中，健康診斷的診斷索引。
	DescribeDiagnoseReport	查看智能營運的歷史報告。
	DescribeDiagnosisSettings	擷取智能營運的情境設定。
	UpdateDiagnosisSettings	更新執行個體的智能營運情境設定。

Kibana

API	描述
DescribeKibanaSettings	擷取Kibana配置。
UpdateKibanaSettings	修改Kibana配置。目前僅支援修改Kibana語言配置。
ListKibanaPlugins	擷取Kibana外掛程式列表。
InstallKibanaSystemPlugin	安裝Kibana預置外掛程式。要求Kibana的規格為2核4 GB及以上。
UninstallKibanaPlugin	卸載Kibana外掛程式。
UpdateKibanaWhiteIps	更新指定執行個體的Kibana訪問白名單。

Logstash

類別	API	描述
執行個體管理	CreateLogstash	建立Logstash執行個體。
	ListLogstash	在列表中展示所有或指定Logstash執行個體的詳細資料。
	DescribeLogstash	查詢指定執行個體的詳細資料。
	UpdateLogstash	修改指定執行個體的部分資訊，例如節點數、配額、名稱、硬碟大小等。
	RenewLogstash	為執行個體續約。
	RestartLogstash	重啟指定執行個體。重啟後，執行個體會進入生效中（activating）狀態。
	UpdateLogstashDescription	修改指定執行個體的名稱。
	UpdateLogstashChargeType	將隨用隨付的阿里雲Logstash執行個體轉換為訂用帳戶執行個體。
	EstimatedLogstashRestartTime	擷取Logstash執行個體重啟的預估時間。
	DeleteLogstash	釋放指定執行個體。
	CancelLogstashDeletion	恢複釋放後被凍結的Logstash執行個體。
叢集配置	UpdateLogstashSettings	更新指定Logstash執行個體的配置。
	ListExtendfiles	擷取Logstash執行個體的擴充檔案配置。
	UpdateExtendfiles	更新Logstash執行個體的擴充檔案配置。
叢集監控	ListAvailableEsInstanceIds	在設定Logstash執行個體的X-Pack監控時，擷取可用的Elasticsearch執行個體列表（具備X-Pack監控能力）。
	ValidateConnection	在Logstash執行個體的監控警示配置中，驗證提供X-Pack監控的Elasticsearch執行個體的聯通性。
	UpdateXpackMonitorConfig	更新Logstash執行個體的X-Pack監控警示配置。
	DescribeXpackMonitorConfig	擷取Logstash執行個體的X-Pack監控配置。
外掛程式管理	ListLogstashPlugins	擷取所有或指定外掛程式的詳細資料。
	InstallLogstashSystemPlugin	安裝外掛程式。
	UninstallLogstashPlugin	卸載已安裝的外掛程式。
日誌查詢	ListLogstashLog	查看Logstash執行個體的日誌。
變更任務管理	InterruptLogstashTask	中斷執行個體變更任務。中斷後，執行個體會進入中斷中（suspended）狀態。
變更任務管理	ResumeLogstashTask	恢複執行個體的變更中斷任務。恢複後執行個體會進入生效中（activating）狀態。
管道管理	CreatePipelines	建立Logstash管道。
	ListPipeline	擷取Logstash執行個體的管道列表。
	DescribePipeline	擷取Logstash執行個體的管道資訊。
	UpdatePipelines	更新Logstash管道資訊。
	RunPipelines	立即部署Logstash管道。
	StopPipelines	停止運行Logstash管道。
	UpdatePipelineManagementConfig	更新Logstash管道管理方式。
	DescribePipelineManagementConfig	擷取Logstash管道管理配置。
	DeletePipelines	刪除指定的Logstash管道。
	ListPipelineIds	設定Kibana管道管理時，測試Logstash與Kibana連通性，並擷取目標Kibana上建立的管道ID列表。

Beats

API	描述
CreateCollector	建立採集器。
DescribeCollector	擷取採集器執行個體的詳細資料。
ReinstallCollector	重試安裝在建立時沒有安裝成功的採集器。
ListCollectors	擷取採集器列表資訊。
ListDefaultCollectorConfigurations	擷取採集器的預設設定檔。
UpdateCollectorName	修改採集器名稱。
UpdateCollector	更新採集器執行個體資訊。
StartCollector	啟動採集器。
RestartCollector	重啟採集器。
StopCollector	停止運行中的採集器。
DeleteCollector	刪除採集器。
ListEcsInstances	擷取ECS機器列表。
ModifyDeployMachine	更新採集器安裝的ECS機器。
ListNodes	查看安裝採集器的ECS機器的狀態。
ListAckClusters	擷取Container ServiceKubernetes版ACK（Container Service for Kubernetes）叢集列表。
ListAckNamespaces	查看指定Container ServiceKubernetes版ACK叢集的所有命名空間。
DescribeAckOperator	查看指定Container ServiceKubernetes版ACK叢集上安裝的Elasticsearch Operator資訊。
InstallAckOperator	在指定Container ServiceKubernetes版ACK叢集上安裝Elasticsearch Operator。

存取控制

API	描述
InitializeOperationRole	建立服務關聯角色。
ValidateSlrPermission	驗證是否已經建立服務關聯角色。