為云數據庫MongoDB分片集群實例添加Shard節點或Mongos節點。
接口說明
請確保在使用該接口前,已充分了解 MongoDB 產品的收費方式和價格。
該接口僅適用于分片集群實例。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
dds:CreateNode | create |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBInstanceId | string | 是 | 分片集群實例 ID。 | dds-bp11501cd7b5**** |
NodeClass | string | 是 | Shard 節點或 Mongos 節點的規格,規格詳情請參見實例規格表。 | dds.shard.mid |
NodeStorage | integer | 否 | Node 的磁盤空間,單位:GB。 取值范圍:10~2000,步長為 10 GB。 說明
當節點類型為 Shard 時,需要配置該參數。
| 10 |
NodeType | string | 是 | 節點類型,取值說明:
| shard |
ClientToken | string | 否 | 用于保證請求的冪等性。由客戶端生成該參數值,要保證在不同請求間唯一,最大值不超過 64 個 ASCII 字符,且該參數值中不能包含非 ASCII 字符。 | ETnLKlblzczshOTUbOCz**** |
AutoPay | boolean | 否 | 是否自動付費,取值說明:
說明
當付費類型為包年包月時,需要配置該參數。
| true |
ReadonlyReplicas | integer | 否 | 設置 Shard 節點中只讀節點的個數。 取值范圍:0~5(整數),默認值為 0。 說明
當前僅中國站支持本參數。
| 5 |
BusinessInfo | string | 否 | 附加參數,業務信息。 | {“ActivityId":"000000000"} |
CouponNo | string | 否 | 是否使用優惠券,取值說明:
| default |
ShardDirect | boolean | 否 | 是否申請 Shard 節點直連地址,取值說明:
| false |
AccountName | string | 否 | 賬號名,取值說明:
說明
| ceshi |
AccountPassword | string | 否 | 賬號密碼,取值說明:
說明
云數據庫 MongoDB 不支持重置 Shard 節點的賬號密碼。
| 123+abc |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "7D48FB19-20CA-4725-A870-3D8F5CE6****",
"NodeId": "d-bp1b234bf7a4****",
"OrderId": "20951063702****"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | SSLNotSupportAddNode | Instance with SSL certificate can't add node, please contact us to solve this problem. | SSL加密實例不允許添加節點,如您需要,請聯系我們解決該問題。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-07-08 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更 | 查看變更詳情 |