全部產品
Search
文件中心

Elasticsearch:RenewInstance

更新時間:Jan 15, 2025

調用RenewInstance,為訂用帳戶執行個體續約。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

要求標頭

該介面使用公用要求標頭,無特殊要求標頭。請參見公用請求參數文檔。

請求文法

POST /openapi/instances/[InstanceId]/actions/renew HTTP/1.1

請求參數

名稱 類型 位置 是否必選 樣本值 描述
InstanceId String Path es-cn-n6w1o1x0w001c****

執行個體ID。

clientToken String Query 5A2CFF0E-5718-45B5-9D4D-70B350****

用於保證請求的等冪性。由用戶端產生該參數值,要保證在不同請求間唯一,最大不超過64個ASCII字元。

RequestBody

RequestBody中還要填入以下欄位,用來指定續約資訊。

參數

類型

是否必選

樣本值

描述

duration

Integer

1

續約時間長度。如果pricingCycle為Year,可選時間長度為1~3;如果pricingCycle為Month,可選時間長度為1~9。

pricingCycle

String

Year

續約周期。可選值:Year(按年續約)、Month(按月續約)。

樣本如下。


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

返回資料

名稱 類型 樣本值 描述
RequestId String F99407AB-2FA9-489E-A259-40CF6DCC****

請求ID。

Result Boolean true

返回結果:

  • 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 錯誤碼 錯誤資訊 描述
400 InstanceNotFound The instanceId provided does not exist. 執行個體找不到,請核對執行個體狀態。

訪問錯誤中心查看更多錯誤碼。