變更云數據庫MongoDB單節點實例、副本集實例和Serverless實例(僅中國站支持Serverless實例)的規格或存儲空間。
接口說明
請確保在使用該接口前,已充分了解 MongoDB 產品的收費方式和和價格。
該接口僅適用于云數據庫 MongoDB
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
dds:ModifyDBInstanceSpec | update |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBInstanceId | string | 是 | 實例 ID。 | dds-bp1ea17b41ab**** |
DBInstanceClass | string | 否 | 實例規格。
說明
該參數和 DBInstanceStorage 參數兩者中至少配置一項。
| dds.sn4.xlarge.1 |
DBInstanceStorage | string | 否 | 實例的存儲空間。
說明
| 50 |
OrderType | string | 否 | 變配類型,取值說明:
說明
當實例付費方式為包年包月時,可以配置該參數。
| UPGRADE |
AutoPay | boolean | 否 | 實例是否自動付費,取值說明:
| true |
BusinessInfo | string | 否 | 業務信息。 | {“ActivityId":"000000000"} |
ReplicationFactor | string | 否 | 設置實例的節點個數。
說明
Serverless 實例(僅支持中國站)不需要配置該參數。
| 3 |
ReadonlyReplicas | string | 否 | 只讀節點的個數,取值范圍為 0~5。 如果實例的網絡類型只開通了經典網絡和專有網絡,您需要開通公網或釋放經典網絡,才能變更只讀節點數。 說明
您可以登錄云數據庫 MongoDB 控制臺,在數據庫連接頁面查看已開通的網絡類型。
| 1 |
CouponNo | string | 否 | 是否使用優惠券,取值說明:
| default |
EffectiveTime | string | 否 | 變更配置的生效時間,取值說明:
| Immediately |
ExtraParam | string | 否 | 附加參數,取值說明:
| async |
返回參數
示例
正常返回示例
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. |
403 | OperationDenied | 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. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-01-12 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |