全部產品
Search
文件中心

:ModifyDBInstanceSpec - 變更單節點或複本集執行個體的規格或儲存空間

更新時間:Dec 16, 2025

變更ApsaraDB for MongoDB單節點執行個體、複本集執行個體和Serverless執行個體(僅中國站支援Serverless執行個體)的規格或儲存空間。

介面說明

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

該介面僅適用於ApsaraDB for MongoDB單節點執行個體和複本集執行個體。如需變更分區叢集執行個體的配置,您可以根據需求通過調用 ModifyNodeSpecCreateNodeDeleteNodeModifyNodeSpecBatch 介面來實現。

調試

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

調試

授權資訊

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

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

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

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dds:ModifyDBInstanceSpec

update

*Instance

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

請求參數

名稱

類型

必填

描述

樣本值

DBInstanceId

string

執行個體 ID。

dds-bp1ea17b41ab****

DBInstanceClass

string

執行個體規格。詳情請參見執行個體規格表。您也可以通過調用 DescribeAvailableResource 介面查看執行個體規格。

  • 單節點執行個體和複本集執行個體配置為執行個體的規格,詳情請參見執行個體規格表。您也可以調用 DescribeAvailableResource 介面查看單節點執行個體和複本集執行個體的執行個體規格。

  • Serverless 執行個體配置為執行個體的計算規格,取值範圍為 100~8000。

說明

該參數和 DBInstanceStorage 參數兩者中至少配置一項。

dds.sn4.xlarge.1

DBInstanceStorage

string

執行個體的儲存空間。取值範圍為 10~3000 GB,步長為 10 GB。具體取值受執行個體規格約束,詳情請參見執行個體規格表

說明
  • 該參數和 DBInstanceClass 參數兩者中至少配置一項。

  • 目前不支援降配儲存空間。

50

OrderType

string

變更配置類型,取值說明:

  • UPGRADE:預設值,升級配置。

  • DOWNGRADE:降級配置。

說明

當執行個體付費方式為訂用帳戶時,可以配置該參數。

UPGRADE

AutoPay

boolean

執行個體是否自動付費,取值說明:

  • true:預設值,自動付費,請確保帳號有足夠的餘額。

  • false:控制台手動付費。您可以登入ApsaraDB for MongoDB 控制台,在頁面右上方選擇費用 > 費用與成本,在左側導覽列,單擊訂單管理,在商品訂單頁面找到目標訂單進行支付。

true

BusinessInfo

string

商務資訊。

{“ActivityId":"000000000"}

ReplicationFactor

string

設定執行個體的節點個數,預設值為 3。

  • 複本集執行個體取值為 357

  • 單節點執行個體取值固定為 1

  • 共用儲存版複本集執行個體(僅支援中國站)取值固定為 2

說明

Serverless 執行個體(僅支援中國站)不需要配置該參數。

3

ReadonlyReplicas

string

唯讀節點的個數,取值範圍為 0~5

如果執行個體的網路類型只開通了傳統網路專用網路,您需要開通公網或釋放傳統網路,才能變更唯讀節點數

說明

您可以登入ApsaraDB for MongoDB 控制台,在資料庫連接頁面查看已開通的網路類型。

1

CouponNo

string

是否使用優惠券,取值說明:

  • defaultnull(預設):使用優惠券。

  • youhuiquan_promotion_option_id_for_blank:不使用優惠券。

default

EffectiveTime

string

變更配置的生效時間,取值說明:

  • Immediately:預設值,立即生效。

  • MaintainTime:在執行個體的可營運時間段內生效。

Immediately

ExtraParam

string

附加參數,取值說明:

  • async:變更配置訂單建立後返回結果。

  • sync:變更配置訂單建立後執行個體變更配置下發時返回結果。

枚舉值:

  • async :

    async

  • sync :

    sync

async

TargetZoneId

string

遷移可用性區域同時變更配置時,執行個體遷移的目標可用性區域。

重要 只支援雲端硬碟執行個體。
重要 該參數取值不能與 TargetSecondaryZoneId 和 TargetHiddenZoneId 參數值相同。

說明
  • 只有在遷移可用性區域同時變更配置才需要傳入此參數。

  • 遷移的目標可用性區域和當前執行個體的可用性區域處於同一地區。

  • 您可以通過調用 DescribeRegions 介面查詢可用性區域 ID。

cn-hangzhou-j

TargetSecondaryZoneId

string

遷移可用性區域同時變更配置時,從節點(Secondary 節點)的目標可用性區域。

重要 只支援雲端硬碟執行個體。
重要 該參數取值不能與 TargetZoneId 和 TargetHiddenZoneId 參數值相同。

說明
  • 只有在遷移可用性區域同時變更配置才需要傳入此參數。

  • 本參數僅在多可用性區域遷移時可用。

  • 遷移的目標可用性區域和當前執行個體的可用性區域處於同一地區。

  • 您可以通過調用 DescribeRegions 介面查詢可用性區域 ID。

cn-hangzhou-h

TargetHiddenZoneId

string

遷移可用性區域同時變更配置時,隱藏節點(Hidden 節點)的目標可用性區域。

重要 只支援雲端硬碟執行個體。
重要 該參數取值不能與 TargetZoneId 和 TargetSecondaryZoneId 參數值相同。

說明
  • 只有在遷移可用性區域同時變更配置才需要傳入此參數。

  • 本參數僅在多可用性區域遷移時可用。

  • 遷移的目標可用性區域和當前執行個體的可用性區域處於同一地區。

  • 您可以通過調用 DescribeRegions 介面查詢可用性區域 ID。

cn-hangzhou-i

TargetVswitchId

string

遷移可用性區域同時變更配置的目標虛擬交換器 ID。

重要 只支援雲端硬碟執行個體。

說明
  • 只有在遷移可用性區域同時變更配置才需要傳入此參數。

vsw-bp1buy0h9myt5i9e7****

SearchNodeClass

string

變更配置的 Search-節點規格

mdb.shard.2x.xlarge.d

SearchNodeStorage

integer

變更配置的 Search-節點容量

20

SearchNodeCount

integer

變更配置的 Search-節點數

2

返回參數

名稱

類型

描述

樣本值

object

RequestId

string

請求 ID。

1E9F1104-19E7-59F0-AB7F-F4EBFDEA****

OrderId

string

訂單 ID。

21012408824****

樣本

正常返回樣本

JSON格式

{
  "RequestId": "1E9F1104-19E7-59F0-AB7F-F4EBFDEA****",
  "OrderId": "21012408824****"
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

400 MissingParameter The input parameters DBInstanceClass and DBInstanceStorage all blank or no change.
400 InvalidDBInstanceClass.ValueNotSupported The specified parameter DBInstanceClass is not valid.
400 InvalidDBInstanceStorage.ValueNotSupported The specified parameter DBInstanceStorage is not valid.
400 LX_REQUEST_TOKEN_CONFLICT The request token is conflict.
400 TradeConfirmPayError BIZ_ERROR - degrade refund error
400 PRICE.ORIGIN_PRICE_ERROR Origin lingxiao price request error.
400 ErrorInsufficientResource There is not enough resource for your operation, requestId: %s. 當前操作資源不足,請求id: %s。
403 OperationDenied The resource is out of usage. The resource is out of usage.
403 InvaildDBInstanceClassInRegion.NotAvailable The DBInstanceClass in the Region is not available.
404 InvalidDBInstanceId.NotFound The DBInstanceId provided does not exist in our records.

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

變更歷史

更多資訊,參考變更詳情