全部產品
Search
文件中心

ApsaraDB for MongoDB:ModifyInstanceAutoRenewalAttribute - 開啟或者關閉執行個體的到期前自動續約功能

更新時間:Dec 18, 2025

設定MongoDB執行個體的自動續約功能。

介面說明

請確保在使用該介面前,已充分瞭解ApsaraDB for MongoDB 產品的收費方式和價格

本介面僅適用於付費類型為訂用帳戶的執行個體。

說明

自動續約將於服務到期前 9 天開始扣款,請保證您的賬戶資金充足。

調試

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

調試

授權資訊

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

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dds:ModifyInstanceAutoRenewalAttribute

update

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

請求參數

名稱

類型

必填

描述

樣本值

RegionId

string

執行個體所屬的地區 ID。您可以通過調用 DescribeDBInstanceAttribute 進行查詢地區 ID。

cn-hangzhou

DBInstanceId

string

執行個體 ID。

dds-bp15da1923e3****

Duration

string

自動續約時間長度,單位:月。

取值範圍:1~12(整數)。

說明

AutoRenew 參數傳入的值為 true 時,本參數才可用,且必須傳入。

1

AutoRenew

string

是否開啟自動續約,取值說明:

  • true:開啟自動續約。

  • false:不開啟自動續約。

說明

當本參數取值為 true 時,您還需要傳入 Duration 參數。

true

返回參數

名稱

類型

描述

樣本值

object

請求資訊。

RequestId

string

請求 ID。

EFD65226-08CC-4C4D-B6A4-CB3C382F67B0

樣本

正常返回樣本

JSON格式

{
  "RequestId": "EFD65226-08CC-4C4D-B6A4-CB3C382F67B0"
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

400 InvalidDbInstanceId.NotFound Specified instance does not exist. 執行個體ID不存在。
400 InvalidDbInstanceIdInvalid Instance dbInstanceId is invalid. 傳入的執行個體ID無效。
400 InstanceAutoRenewInvalid Instance auto renewal is invalid.
400 InstanceChargeTypeInvalid Instance charge type is invalid. 執行個體收費類型無效。
400 InvalidDuration.Invalid Instance duration is invalid. 續約時間長度無效
403 ClassicNetworkNotSupport Classic network has not been supported, try to use VPC. 當前操作不支援傳統網路執行個體,請使用VPC網路。

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

變更歷史

更多資訊,參考變更詳情