使用RenewInstance續約執行個體-即時數倉 Hologres-阿里雲 - Hologres

介面說明

警告該 API 操作涉及費用，請確保在使用該介面前，已充分瞭解即時數倉 Hologres 的收費方式和價格。

Hologres 計費詳情請參見計費概述。
Hologres 續約操作請參見續約管理。
續約操作僅適用預付費（PrePaid）執行個體。

調試

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

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

hologram:RenewInstance

update

*全部資源

*

無

請求文法

POST /api/v1/instances/{instanceId}/renew HTTP/1.1

路徑參數

名稱	類型	必填	描述	樣本值
instanceId	string	是	執行個體 id。	hgprecn-cn-i7m2v08uu00a

請求參數

名稱	類型	必填	描述	樣本值
body	object	否	請求體。
duration	integer	是	續約周期。單位：月。	2
autoRenew	boolean	否	是否開啟按月自動續約，預設不開啟。取值： true：開啟。 false：不開啟說明已開啟自動續約的執行個體，再次開啟會報錯。	true

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	Id of the request	D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70
Data	object	返回結果。
Code	string	錯誤碼。	InvalidChargeType.UnRenewable
Message	string	錯誤詳細資料。	Invalid charge type
OrderId	string	訂單 Id	221625608580893
Success	boolean	續約是否成功。 true：續約成功。 false：續約失敗。	true
ErrorCode	string	錯誤碼	null
ErrorMessage	string	錯誤資訊。	null
HttpStatusCode	string	http 狀態代碼。	200
Success	string	請求結果，表示此次請求是否發生異常，和業務無關	false

說明

參數校正錯誤，仍然會返回正常的 Data，Success 為 false，並包含 Code 和 Message。除非拋出異常，否則成功與否由 Data.Success 來判斷。
使用新版 SDK 包調用本介面時，由於 SDK 內部的用戶端預設逾時時間和服務端的不一致，因此可能返回請求逾時的錯誤，但實際上介面已調用成功。如需避免這個問題，您可以在調用前設定 ReadTimeout 參數為 20000。

樣本

正常返回樣本

JSON格式

{
  "RequestId": "D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70",
  "Data": {
    "Code": "InvalidChargeType.UnRenewable",
    "Message": "Invalid charge type",
    "OrderId": "221625608580893",
    "Success": true
  },
  "ErrorCode": "null",
  "ErrorMessage": "null",
  "HttpStatusCode": "200",
  "Success": "false"
}

錯誤碼

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

變更歷史

更多資訊，參考變更詳情。