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

Elasticsearch:UpdateAdvancedSetting

最終更新日:Mar 17, 2025

UpdateAdvancedSetting を呼び出して、指定されたインスタンスのガベージコレクタ構成を変更します。

デバッグ

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

リクエストヘッダー

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

リクエスト構文

POST|PUT /openapi/instances/[InstanceId]/actions/update-advanced-setting HTTPS|HTTP

リクエストパラメータ

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

インスタンスの ID。

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

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

リクエスト本文

変更されたガベージコレクタ構成を指定するには、リクエスト本文で次のパラメータを指定する必要があります。

パラメータ

タイプ

必須

説明

gcName

String

はい

CMS

ガベージコレクタの新しい名前。 サポートされているタイプ: CMS および G1。

例:

{
    "gcName":"CMS"
}
            

レスポンスパラメータ

パラメータタイプ説明
RequestIdString5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****

リクエストの ID。

Resultブール値true

戻り値:

  • true:ガベージコレクタの構成が正常に変更されました
  • false:ガベージコレクタの構成の変更に失敗しました

リクエストの例

POST /openapi/instances/es-cn-09k1ruw79000u****/actions/update-advanced-setting HTTP/1.1
共通リクエストパラメータ
{
    "gcName":"CMS"
}

成功レスポンスの例

JSON 形式

{
    "Result": true,
    "RequestId": "D7BA7E23-F6B7-4D57-BBE4-67EACAAB****"
}

エラーコード

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

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