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

Elasticsearch:RenewInstance

最終更新日:Mar 17, 2025

RenewInstance を呼び出して、サブスクリプションインスタンスを更新します。

デバッグ

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

リクエストヘッダー

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

リクエスト構文

POST /openapi/instances/[InstanceId]/actions/renew HTTPS|HTTP

リクエストパラメーター

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

インスタンス ID。

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

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

リクエスト本文

更新情報を指定するには、リクエスト本文にも次のフィールドが必要です。

フィールド

タイプ

必須

説明

duration

Integer

はい

1

サブスクリプションクラスターの更新期間。 pricingCycle が Year に設定されている場合、期間は 1 ~ 3 です。 pricingCycle が Month に設定されている場合、期間は 1 ~ 9 です。

pricingCycle

String

はい

Year

更新の課金サイクル。 有効な値:Year と Month。

例:


{
    "duration":1,
    "pricingCycle":"Year"
}
            

レスポンスパラメーター

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

リクエスト ID。

ResultBooleantrue

戻り値:

  • true:更新成功
  • false:更新失敗

リクエストの例

POST /openapi/instances/es-cn-n6w1o1x0w001c****/actions/renew HTTP/1.1
共通リクエストパラメーター
{
    "duration":1,
    "pricingCycle":"Year"
}

成功レスポンスの例

JSON 形式

{
    "Result": true,
    "RequestId": "4FF74B95-7D01-44B4-8E0D-6E5AB515****"
}

エラーコード

HttpCodeエラーコードエラーメッセージ説明
400InstanceNotFoundThe instanceId provided does not exist.指定されたインスタンスが見つからないため返されたエラーメッセージ。 インスタンスの状態を確認してください。

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