變更ApsaraDB for MongoDB單節點執行個體、複本集執行個體和Serverless執行個體(僅中國站支援Serverless執行個體)的規格或儲存空間。
介面說明
請確保在使用該介面前,已充分瞭解 MongoDB 產品的收費方式和和價格。
該介面僅適用於ApsaraDB for MongoDB單節點執行個體和複本集執行個體。如需變更分區叢集執行個體的配置,您可以根據需求通過調用 ModifyNodeSpec 、 CreateNode 、 DeleteNode 或 ModifyNodeSpecBatch 介面來實現。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
dds:ModifyDBInstanceSpec |
update |
*Instance
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| DBInstanceId |
string |
是 |
執行個體 ID。 |
dds-bp1ea17b41ab**** |
| DBInstanceClass |
string |
否 |
執行個體規格。詳情請參見執行個體規格表。您也可以通過調用 DescribeAvailableResource 介面查看執行個體規格。
說明
該參數和 DBInstanceStorage 參數兩者中至少配置一項。 |
dds.sn4.xlarge.1 |
| DBInstanceStorage |
string |
否 |
執行個體的儲存空間。取值範圍為 10~3000 GB,步長為 10 GB。具體取值受執行個體規格約束,詳情請參見執行個體規格表。 說明
|
50 |
| OrderType |
string |
否 |
變更配置類型,取值說明:
說明
當執行個體付費方式為訂用帳戶時,可以配置該參數。 |
UPGRADE |
| AutoPay |
boolean |
否 |
執行個體是否自動付費,取值說明:
|
true |
| BusinessInfo |
string |
否 |
商務資訊。 |
{“ActivityId":"000000000"} |
| ReplicationFactor |
string |
否 |
設定執行個體的節點個數,預設值為 3。
說明
Serverless 執行個體(僅支援中國站)不需要配置該參數。 |
3 |
| ReadonlyReplicas |
string |
否 |
唯讀節點的個數,取值範圍為 0~5。 如果執行個體的網路類型只開通了傳統網路和專用網路,您需要開通公網或釋放傳統網路,才能變更唯讀節點數。 說明
您可以登入ApsaraDB for MongoDB 控制台,在資料庫連接頁面查看已開通的網路類型。 |
1 |
| CouponNo |
string |
否 |
是否使用優惠券,取值說明:
|
default |
| EffectiveTime |
string |
否 |
變更配置的生效時間,取值說明:
|
Immediately |
| ExtraParam |
string |
否 |
附加參數,取值說明:
枚舉值:
|
async |
| TargetZoneId |
string |
否 |
遷移可用性區域同時變更配置時,執行個體遷移的目標可用性區域。 重要 只支援雲端硬碟執行個體。 重要 該參數取值不能與 TargetSecondaryZoneId 和 TargetHiddenZoneId 參數值相同。 說明
|
cn-hangzhou-j |
| TargetSecondaryZoneId |
string |
否 |
遷移可用性區域同時變更配置時,從節點(Secondary 節點)的目標可用性區域。 重要 只支援雲端硬碟執行個體。 重要 該參數取值不能與 TargetZoneId 和 TargetHiddenZoneId 參數值相同。 說明
|
cn-hangzhou-h |
| TargetHiddenZoneId |
string |
否 |
遷移可用性區域同時變更配置時,隱藏節點(Hidden 節點)的目標可用性區域。 重要 只支援雲端硬碟執行個體。 重要 該參數取值不能與 TargetZoneId 和 TargetSecondaryZoneId 參數值相同。 說明
|
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. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。