すべてのプロダクト
Search
ドキュメントセンター

Elasticsearch:InstallSystemPlugin

最終更新日:Mar 17, 2025

InstallSystemPlugin を呼び出して、システムプリセット プラグインをインストールします。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。 OpenAPI Explorer は、さまざまな SDK の操作のサンプルコードを動的に生成します。

リクエストヘッダー

この操作では、共通のリクエスト パラメーターのみを使用します。 詳細については、「共通パラメーター」をご参照ください。

リクエスト構文

POST /openapi/instances/[InstanceId]/plugins/system/actions/install HTTPS|HTTP

リクエスト パラメーター

パラメータータイプ必須説明
InstanceIdStringはいes-cn-n6w1o1x0w001c****

インスタンスの ID。

clientTokenStringいいえ5A2CFF0E-5718-45B5-9D4D-70B3FF****

リクエストの冪等性を保証するためにクライアントによって生成された一意のトークン。 クライアントを使用して値を生成できますが、異なるリクエスト間で一意であることを確認する必要があります。 トークンには ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。

リクエスト本文

インストールするプラグインの名前をリクエスト本文に入力します。形式は ["plugin_name1","plugin_name2",...,"plugin_namen"] です。例: ["aliyun-sql","codec-compression"]

レスポンス パラメーター

パラメータータイプ説明
RequestIdStringF99407AB-2FA9-489E-A259-40CF6DCC****

リクエストの ID。

ResultList["aliyun-sql"]

インストールされるプラグインのリスト。

リクエストの例

POST /openapi/instances/es-cn-n6w1o1x0w001c****/plugins/system/actions/install HTTP/1.1
共通リクエスト パラメーター
["aliyun-sql","codec-compression"]

正常なレスポンスの例

JSON 形式

{
    "Result": ["aliyun-sql"],
    "RequestId": "5A5D8E74-565C-43DC-B031-29289FA*****"
}

エラーコード

HttpCodeエラーコードエラーメッセージ説明
400InstanceNotFound指定された instanceId が存在しません。指定されたインスタンスが見つからないために返されるエラーメッセージ。 インスタンスの状態を確認してください。

エラーコードのリストについては、API エラーセンターをご覧ください。