變更云數據庫MongoDB分片集群實例中一個或多個Mongos節點、Shard節點的配置。
接口說明
請確保在使用該接口前,已充分了解云數據庫 MongoDB 產品的收費方式和價格。
該接口僅適用于云數據庫 MongoDB 分片集群實例。
對多個分片集群實例進行批量升降配操作時,目標規格會受到一定的約束,例如存儲空間擴容,目標容量需大于等于當前容量。當多個分片集群實例規格不一致的時候,會隨機選擇一個分片集群實例的規格去構造約束條件,可能出現無法升降配的情況。 如果遇到無法正常進行批量升降配的情況,建議選擇使用 ModifyNodeSpec 接口對單個分片集群實例進行變配。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
dds:ModifyNodeSpecBatch | update |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 否 | 地域 ID,您可以調用 DescribeRegions 查詢。 | cn-hangzhou |
DBInstanceId | string | 是 | 需要進行變更配置的實例 ID。 | dds-bp1337621e8f**** |
NodesInfo | string | 是 | 需要變配的 Mongos 節點、Shard 節點的規格信息。具體規格請參見實例規格表。 | {"Shards":[{"DBInstanceClass":"dds.shard.mid","DBInstanceName":"d-bp14ae4572fd****","Storage":20},{"DBInstanceClass":"dds.shard.mid","DBInstanceName":"d-bp19f4f92dc5****","Storage":30}]} |
ClientToken | string | 否 | 用于保證請求的冪等性,防止重復提交請求。由客戶端生成該參數值,要保證在不同請求間唯一,最大值不超過 64 個 ASCII 字符,且該參數值中不能包含非 ASCII 字符。 | ETnLKlblzczshOTUbOCz**** |
AutoPay | boolean | 否 | 是否自動付費。取值:
默認值為 true。 | true |
EffectiveTime | string | 否 | 變更配置的生效時間,取值:
說明
默認為 Immediately。 | Immediately |
OrderType | string | 否 | 變配類型,取值:
說明
當實例付費方式為包年包月時,該參數可用。
| UPGRADE |
CouponNo | string | 否 | 是否使用優惠券,取值說明:
| default |
BusinessInfo | string | 否 | 業務信息。 | {“ActivityId":"000000000"} |
返回參數
示例
正常返回示例
JSON
格式
{
"OrderId": "21012719476****",
"RequestId": "0637BC25-6895-5500-871F-1127CA34****"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|
暫無變更歷史