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

Elasticsearch:DescribeSnapshotSetting

最終更新日:Mar 17, 2025

DescribeSnapshotSetting を呼び出して、クラスターのデータバックアップ構成を取得します。

デバッグ

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

リクエストヘッダー

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

リクエスト構文

GET /openapi/instances/[InstanceId]/snapshot-setting HTTPS|HTTP

リクエストパラメーター

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

インスタンス ID。

レスポンスパラメーター

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

リクエスト ID。

ResultStruct

戻り値。

EnableBooleantrue

自動バックアップを有効にするかどうか。

QuartzRegexString0 0 01 ? * * *

Quartz Cron 式を使用した自動バックアップ時間の構成。

リクエストの例

GET /openapi/instances/es-cn-0pp1jxvcl000z****/snapshot-setting HTTP/1.1
共通リクエストヘッダー

正常なレスポンスの例

JSON 形式

{
    "RequestId": "B2A05BB2-7B66-4D0F-BEDE-5033AFFE****",
    "Result": {
        "Enable": true,
        "QuartzRegex": "0 0 01 ? * * *"
    }
}

エラーコード

HttpCodeエラーコードエラーメッセージ説明
404InstanceNotFound指定されたクラスターが存在しません。 クラスターの状態を確認してから、もう一度お試しください。指定されたインスタンスが見つからないため、返されたエラーメッセージ。 インスタンスの状態を確認してください。

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