Elasticsearch API 操作一覧 - Elasticsearch - Alibaba Cloud ドキュメントセンター

次の表に、Elasticsearch、Kibana、Logstash、および Beats で使用可能な API 操作の一覧を示します。これらの表に記載されていない API 操作を使用する場合は、Alibaba Cloud テクニカルサポートエンジニアに連絡して入手してください。

Elasticsearch

カテゴリ	操作	説明
クラスタ管理	createInstance	Elasticsearch クラスタを作成します。
	ListInstance	Elasticsearch クラスタまたはすべての Elasticsearch クラスタに関する情報を照会します。
	DescribeInstance	Elasticsearch クラスタに関する情報を照会します。
	EstimatedRestartTime	Elasticsearch クラスタを再起動するのにかかる推定時間を照会します。
	RestartInstance	Elasticsearch クラスタを再起動します。
	UpdateInstanceChargeType	Elasticsearch クラスタの課金方式を従量課金からサブスクリプションに切り替えます。
	UpdateDescription	Elasticsearch クラスタの名前を変更します。
	DeleteInstance	従量課金 Elasticsearch クラスタをリリースします。クラスタがリリースされると、クラスタで使用されていた物理リソースは再利用されます。クラスタに保存されているデータは削除され、復元できません。クラスタ内のノードに接続されているディスクと、クラスタ用に作成されたスナップショットはリリースされます。
	CancelDeletion	リリース後にフリーズされた Elasticsearch クラスタを復元します。
	RenewInstance	サブスクリプション Elasticsearch クラスタを更新します。
	ActivateZones	無効になっているゾーン内のノードを復元します。この操作は、マルチゾーン Elasticsearch クラスタに対してのみ使用できます。
	DeactivateZones	マルチゾーン Elasticsearch クラスタが存在する 1 つ以上のゾーンを無効にし、無効になっているゾーン内のノードを他のゾーンにマイグレーションします。
	DescribeRegions	Elasticsearch が利用可能なリージョンを照会します。
	InterruptElasticsearchTask	Elasticsearch クラスタの変更タスクを一時停止します。タスクが一時停止されると、クラスタは一時停止状態になります。この操作は、アクティブ化状態の Elasticsearch クラスタに対してのみ使用できます。
	ResumeElasticsearchTask	Elasticsearch クラスタの変更タスクを再開します。
	ListAllNode	Elasticsearch クラスタ内のすべてのノードに関する情報を照会します。
	DescribeElasticsearchHealth	Elasticsearch クラスタのヘルス状態を照会します。
	ListInstanceIndices	Elasticsearch クラスタ内のインデックスのリストを照会します。説明 `ListInstanceIndices` 操作は、`Indexing Service` が有効になっている Elasticsearch クラスタにのみ適用されます。`Elasticsearch API` を使用してインデックス情報を照会することをお勧めします。詳細については、「cat indices API」をご参照ください。
	MigrateToOtherZone	ゾーン間でノードをマイグレーションします。
	MoveResourceGroup	Elasticsearch クラスタをリソースグループに移動します。
	ModifyInstanceMaintainTime	Elasticsearch クラスタのメンテナンスウィンドウを有効にし、変更します。
	GetRegionConfiguration	現在のリージョンの構成情報を照会します。この操作は、現在のリージョンのすべての構成情報を返します。情報は参照用です。コンソールと購入ページの実際の情報が優先されます。
	ListShardRecoveries	復元中のシャードまたは復元されたシャードのリストを照会します。デフォルトでは、この操作は、この操作を呼び出した後に復元されているシャードに関する情報のみを返します。
	CapacityPlan	ビジネスシナリオ、1 秒あたりのクエリ数、クラスタのログ数に基づいて、Elasticsearch クラスタの容量計画に推奨される構成を照会します。
タグ管理	ListTags	すべての表示可能なユーザタグを照会します。
	ListTagResources	リソースに追加されているタグを照会します。
	TagResources	リソースにタグを追加します。
	UntagResources	リソースからタグを削除します。
データ移行	GetTransferableNodes	指定されたノードタイプとノード数に基づいて、データを移行できるノードを照会します。
	ValidateTransferableNodes	Elasticsearch クラスタ内の特定のノードのデータを移行できるかどうかを確認します。
	TransferNode	データ移行タスクを実行します。
	ListDataTasks	データ移行タスクのリストを照会します。
	GetClusterDataInformation	Elasticsearch クラスタのデータ情報を照会します。
	DeleteDataTask	データ移行タスクを削除します。
	CancelTask	データ移行タスクをキャンセルします。
クラスタ構成のアップグレードとダウングレード	GetSuggestShrinkableNodes	指定されたノードタイプとノード数に基づいて、Elasticsearch クラスタから削除できるノードを照会します。
	ValidateShrinkNodes	特定のノードを Elasticsearch クラスタから削除できるかどうかを確認します。
	ShrinkNode	Elasticsearch クラスタからノードを削除します。
	UpgradeEngineVersion	Elasticsearch クラスタのバージョンまたはカーネルバージョンをアップグレードします。Elasticsearch クラスタのバージョンは、V6.3 から V6.7 にのみアップグレードできます。
	UpdateInstance	Elasticsearch クラスタの構成をアップグレードまたはダウングレードします。
クラスタ構成	UpdateInstanceSettings	Elasticsearch クラスタの YML ファイルの構成を更新します。
	UpdateHotIkDicts	Elasticsearch クラスタの IK 辞書のローリングアップデートを実行します。
	UpdateSynonymsDicts	Elasticsearch クラスタのシノニム辞書を更新します。
	UpdateDict	IK メイン辞書と IK ストップワードリストを含む、Elasticsearch クラスタの IK 辞書の標準アップデートを実行します。
	UpdateAliwsDict	analysis-aliws プラグインの辞書ファイルを更新します。このプラグインを使用すると、カスタマイズした辞書ファイルをアップロードできます。
	ListDictInformation	オブジェクトを Elasticsearch クラスタにアップロードするときに、オブジェクトストレージサービス (OSS) に保存されている辞書オブジェクトの詳細を照会して検証します。
	UpdateAdvancedSetting	Elasticsearch クラスタのガベージコレクタ (GC) 構成を更新します。
	ListDicts	辞書タイプの詳細と、関連する署名に基づいて生成された辞書をダウンロードするためのリンクを照会します。
プラグイン管理	ListPlugins	Elasticsearch クラスタにインストールされているプラグインのリストを照会します。
	InstallSystemPlugin	組み込みプラグインをインストールします。
	UninstallPlugin	組み込みプラグインをアンインストールします。
	InstallUserPlugins	Elasticsearch コンソールにアップロードされたカスタムプラグインをインストールします。
ログクエリ	ListSearchLog	Elasticsearch クラスタのログを照会します。
セキュリティ構成	TriggerNetwork	Elasticsearch または Kibana のパブリックネットワークアクセスまたはプライベートネットワークアクセス機能を有効または無効にします。
	UpdatePrivateNetworkWhiteIps	Elasticsearch クラスタのプライベート IP アドレスホワイトリストを更新します。
	UpdatePublicWhiteIps	Elasticsearch クラスタのパブリック IP アドレスホワイトリストを更新します。
	UpdatePublicNetwork	Elasticsearch クラスタのパブリックネットワークアクセス機能を有効または無効にします。
	UpdateWhiteIps	Elasticsearch クラスタのプライベート IP アドレスホワイトリストを更新します。
	ModifyWhiteIps	Elasticsearch クラスタの IP アドレスホワイトリストを更新します。
	UpdateAdminPassword	Elasticsearch クラスタの elastic アカウントのパスワードを更新します。
	OpenHttps	HTTPS を有効にします。Elasticsearch クラスタのバージョンが V8.5 または V7.16 でない場合は、この操作を呼び出す前に、クラスタにクライアントノードが含まれていることを確認する必要があります。
	CloseHttps	HTTPS を無効にします。
	AddConnectableCluster	Elasticsearch クラスタを接続します。
	DeleteConnectedCluster	Elasticsearch クラスタを切断します。
	DescribeConnectableClusters	Elasticsearch クラスタに接続できる Elasticsearch クラスタのリストを照会します。Elasticsearch クラスタに接続されている Elasticsearch クラスタは除外されます。
	ListConnectedClusters	Elasticsearch クラスタに接続されている Elasticsearch クラスタのリストを照会します。
	CreateVpcEndpoint	Elasticsearch サービスアカウント内のバーチャルプライベートクラウド (VPC) にエンドポイントを作成します。エンドポイントを使用して、VPC 内のエンドポイントサービスに接続できます。このようにして、2 つの VPC 間にプライベート接続が確立されます。
	DeleteVpcEndpoint	Elasticsearch サービスアカウント内の VPC のエンドポイントを削除します。
	ListVpcEndpoints	Elasticsearch サービスアカウント内の VPC のエンドポイントの状態を照会します。
データバックアップ	CreateSnapshot	Elasticsearch クラスタにスナップショットを作成します。
	DescribeSnapshotSetting	Elasticsearch クラスタのデータバックアップ構成を照会します。
	UpdateSnapshotSetting	Elasticsearch クラスタのデータバックアップ構成を更新します。
	ListSnapshotReposByInstanceId	Elasticsearch クラスタに構成されている共有 OSS リポジトリのリストを照会します。
	ListAlternativeSnapshotRepos	Elasticsearch クラスタに構成できる共有 OSS リポジトリのリストを照会します。
	AddSnapshotRepo	Elasticsearch クラスタの共有 OSS リポジトリを作成します。
	DeleteSnapshotRepo	Elasticsearch クラスタの共有 OSS リポジトリを削除します。
インテリジェント O&M	OpenDiagnosis	Elasticsearch クラスタのインテリジェント O&M 機能を有効にします。
	CloseDiagnosis	Elasticsearch クラスタのインテリジェント O&M 機能を無効にします。
	DiagnoseInstance	Elasticsearch クラスタを診断します。
	ListDiagnoseReport	Elasticsearch クラスタのインテリジェント O&M 履歴レポートを照会します。
	ListDiagnoseReportIds	Elasticsearch クラスタのインテリジェント O&M 履歴レポートの ID を照会します。
	ListDiagnoseIndices	Elasticsearch クラスタで実行されたヘルス診断のインデックスを照会します。
	DescribeDiagnoseReport	インテリジェント O&M 履歴レポートを照会します。
	DescribeDiagnosisSettings	Elasticsearch クラスタのインテリジェント O&M のシナリオ設定を照会します。
	UpdateDiagnosisSettings	Elasticsearch クラスタのインテリジェント O&M のシナリオ設定を更新します。

Kibana

操作	説明
DescribeKibanaSettings	Kibana の構成を照会します。
UpdateKibanaSettings	Kibana の構成を変更します。Kibana の言語設定のみ変更できます。
ListKibanaPlugins	Kibana のプラグインを照会します。
InstallKibanaSystemPlugin	Kibana 用の組み込みプラグインをインストールします。この操作を呼び出す前に、Kibana ノードの仕様が 2 vCPU と 4 GiB 以上のメモリであることを確認してください。
UninstallKibanaPlugin	Kibana 用のプラグインをアンインストールします。
UpdateKibanaWhiteIps	Elasticsearch クラスタの Kibana コンソールへのアクセスを許可する IP アドレスホワイトリストを更新します。

Logstash

カテゴリ	操作	説明
クラスタ管理	CreateLogstash	Logstash クラスタを作成します。
	ListLogstash	Logstash クラスタまたはすべての Logstash クラスタに関する情報を照会します。
	DescribeLogstash	Logstash クラスタに関する情報を照会します。
	UpdateLogstash	Logstash クラスタの構成（名前、クォータ、ディスクサイズ、ノード数など）を変更します。
	RenewLogstash	Logstash クラスタを更新します。
	RestartLogstash	Logstash クラスタを再起動します。クラスタが再起動されると、アクティブ化状態になります。
	UpdateLogstashDescription	Logstash クラスタの名前を変更します。
	UpdateLogstashChargeType	Logstash クラスタの課金方式を従量課金からサブスクリプションに切り替えます。
	EstimatedLogstashRestartTime	Logstash クラスタを再起動するのにかかる推定時間を照会します。
	DeleteLogstash	Logstash クラスタをリリースします。
	CancelLogstashDeletion	リリース後にフリーズされた Logstash クラスタを復元します。
クラスタ構成	UpdateLogstashSettings	Logstash クラスタの構成を更新します。
	ListExtendfiles	Logstash クラスタのドライバファイルを照会します。
	UpdateExtendfiles	Logstash クラスタのドライバファイルを更新します。
クラスタモニタリング	ListAvailableEsInstanceIds	Logstash クラスタの X-Pack Monitoring 機能を構成する際に、Logstash クラスタに関連付けることができる Elasticsearch クラスタを照会します。
	ValidateConnection	Logstash クラスタの X-Pack Monitoring 機能を構成する際に、Logstash クラスタとそれに関連付けられた Elasticsearch クラスタ間の接続性をテストします。
	UpdateXpackMonitorConfig	Logstash クラスタの X-Pack Monitoring 機能の構成を更新します。
	DescribeXpackMonitorConfig	Logstash クラスタの X-Pack Monitoring 機能の構成を照会します。
プラグイン管理	ListLogstashPlugins	プラグインまたはすべてのプラグインに関する情報を照会します。
	InstallLogstashSystemPlugin	プラグインをインストールします。
	UninstallLogstashPlugin	プラグインをアンインストールします。
ログクエリ	ListLogstashLog	Logstash クラスタのログを照会します。
タスク管理の変更	InterruptLogstashTask	Logstash クラスタの変更タスクを一時停止します。タスクが一時停止されると、Logstash クラスタは一時停止状態になります。
タスク管理の変更	ResumeLogstashTask	Logstash クラスタの変更タスクを再開します。タスクが再開されると、Logstash クラスタはアクティブ化状態になります。
パイプライン管理	CreatePipelines	Logstash クラスタにパイプラインを作成します。
	ListPipeline	Logstash クラスタ内のパイプラインのリストを照会します。
	DescribePipeline	Logstash クラスタ内のパイプラインに関する情報を照会します。
	UpdatePipelines	Logstash クラスタ内のパイプラインに関する情報を更新します。
	RunPipelines	Logstash クラスタ内のパイプラインを実行します。
	StopPipelines	Logstash クラスタ内のパイプラインを停止します。
	UpdatePipelineManagementConfig	Logstash クラスタ内のパイプラインの管理方法を更新します。
	DescribePipelineManagementConfig	Logstash クラスタ内のパイプラインの管理構成を照会します。
	DeletePipelines	Logstash クラスタ内のパイプラインを削除します。
	ListPipelineIds	Logstash クラスタと Elasticsearch クラスタの Kibana コンソール間の接続性をテストし、Elasticsearch クラスタの Kibana コンソールで作成されたパイプラインの ID を照会します。

Beats

操作	説明
CreateCollector	シッパーを作成します。
DescribeCollector	シッパーに関する情報を照会します。
ReinstallCollector	シッパーの作成時にインストールに失敗したシッパーをインストールします。
ListCollectors	シッパーのリストを照会します。
ListDefaultCollectorConfigurations	シッパーのデフォルト構成ファイルを照会します。
UpdateCollectorName	シッパーの名前を変更します。
UpdateCollector	シッパーに関する情報を更新します。
StartCollector	シッパーを起動します。
RestartCollector	シッパーを再起動します。
StopCollector	シッパーを停止します。
DeleteCollector	シッパーを削除します。
ListEcsInstances	Elastic Compute Service (ECS) インスタンスのリストを照会します。
ModifyDeployMachine	シッパーがインストールされている ECS インスタンスを変更します。
ListNodes	シッパーがインストールされている ECS インスタンスの状態を照会します。
ListAckClusters	Container Service for Kubernetes (ACK) クラスタのリストを照会します。
ListAckNamespaces	ACK クラスタのすべての名前空間を照会します。
DescribeAckOperator	ACK クラスタにインストールされている ES オペレータに関する情報を照会します。
InstallAckOperator	ACK クラスタに ES オペレータをインストールします。

アクセス制御

操作	説明
InitializeOperationRole	サービスリンクロールを作成します。
ValidateSlrPermission	サービスリンクロールが作成されているかどうかを確認します。