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 クラスタに保存されているインデックスをクエリします。
	MigrateToOtherZone	ゾーン間でノードを移行します。
	MoveResourceGroup	Elasticsearch クラスタをリソースグループに移行します。
	ModifyInstanceMaintainTime	Elasticsearch クラスタのメンテナンスウィンドウを有効にし、変更します。
	GetRegionConfiguration	現在のリージョンの構成情報をクエリします。この操作は、現在のリージョンのすべての構成情報を返します。情報は参照用です。コンソールおよび購入ページの実際の情報が優先されます。
	ListShardRecoveries	復元中のシャードまたは復元されたシャードの情報をクエリします。デフォルトでは、この操作は、この操作を呼び出した後に復元中のシャードの情報のみを返します。
	CapacityPlan	ビジネスシナリオ、1 秒あたりのクエリ数、およびクラスタのログ数に基づいて、Elasticsearch クラスタの容量計画のためにシステムによって推奨される構成をクエリします。
タグ管理	ListTags	すべての表示可能なユーザタグをクエリします。
	ListTagResources	1 つ以上のリソースに追加されたタグをクエリします。
	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-operator の情報をクエリします。
InstallAckOperator	ACK クラスタに ES-operator をインストールします。

アクセス制御

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