創建或者克隆MongoDB分片集群實例。
接口說明
-
請確保在使用該接口前,已充分了解云數據庫 MongoDB 的收費方式和價格。
-
關于云數據庫 MongoDB 實例的規格,請參見實例規格表。
-
如果需要創建單節點實例和副本集實例,您可以通過調用 CreateDBInstance 接口創建。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
dds:CreateShardingDBInstance | create |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域 ID,您可以通過調用 DescribeRegions 接口查詢地域 ID。 | cn-hangzhou |
ZoneId | string | 否 | 可用區 ID,您可以通過調用 DescribeRegions 接口查詢可用區 ID。 | cn-hangzhou-g |
Engine | string | 是 | 數據庫引擎。固定取值:MongoDB。 | MongoDB |
EngineVersion | string | 是 | 枚舉值:
| 4.4 |
DBInstanceDescription | string | 否 | 實例名稱,取值說明:
| test |
SecurityIPList | string | 否 | 實例的 IP 白名單,多個 IP 地址請用英文逗號(,)分隔,不可重復。支持如下三種格式:
說明
| 192.168.xx.xx,192.168.xx.xx |
AccountPassword | string | 否 | root 賬號的密碼,取值說明:
說明
關于特殊字符導致數據庫連接失敗的問題請參見如何解決連接串中賬號密碼包含特殊字符導致連接失敗的問題?。
| 123456Aa |
ChargeType | string | 否 | 實例的付費類型,取值說明:
說明
當該參數的值為 PrePaid 時,您還需要配置 Period 參數。
| PrePaid |
Period | integer | 否 | 實例的購買時長,單位為月。 取值范圍:1~9(整數)、12、24、36、60。 說明
當 ChargeType 參數值為 PrePaid 時,該參數可用且為必填參數。
| 1 |
NetworkType | string | 否 | 實例的網絡類型,取值說明: VPC:專有網絡。 | VPC |
VpcId | string | 是 | 專有網絡(VPC)ID。 | vpc-bp1n3i15v90el48nx**** |
VSwitchId | string | 是 | 虛擬交換機 ID。 | vsw-bp1vj604nj5a9zz74**** |
SrcDBInstanceId | string | 否 | 源實例 ID。 說明
只有調用本接口克隆實例時,您需要配置該參數,同時還需要配置 RestoreTime 參數。
| dds-bp11483712c1**** |
RestoreTime | string | 否 | 選擇要恢復的時間點,您可以配置 7 天內的任意時間點。格式為yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。 說明
只有調用本接口克隆實例時,您需要配置該參數,同時還需要配置 SrcDBInstanceId 參數。
| 2022-03-08T02:30:25Z |
ClientToken | string | 否 | 用于保證請求的冪等性,防止重復提交請求。由客戶端生成該參數值,要保證在不同請求間唯一,最大值不超過 64 個 ASCII 字符,且該參數值中不能包含非 ASCII 字符。 | ETnLKlblzczshOTUbOCz**** |
StorageEngine | string | 否 | 實例的存儲引擎,取值固定為 WiredTiger。 說明
| WiredTiger |
AutoRenew | string | 否 | 實例是否自動續費,取值說明:
說明
當 ChargeType 參數值為 PrePaid 時,該參數可用且為可選參數。
| true |
ProtocolType | string | 否 | 訪問協議的類型,取值說明:
| mongodb |
Mongos | array<object> | 是 | Mongos 節點信息。 | |
object | 是 | Mongos 節點信息。 | ||
Class | string | 是 | Mongos 節點的規格,取值詳情請參見分片集群實例規格表。 說明
| mdb.shard.2x.xlarge.d |
ReplicaSet | array<object> | 是 | Shard 節點的信息。 | |
object | 是 | Shard 節點的信息。 | ||
Class | string | 是 | Shard 節點的規格,取值詳情請參見分片集群實例規格表。 說明
| dds.shard.standard |
Storage | integer | 是 | Shard 節點的存儲空間,單位為 GB。 說明
| 10 |
ReadonlyReplicas | integer | 否 | 設置 Shard 節點的只讀節點個數。 取值范圍:0~5(整數),默認值為 0。 說明
參數名中的 N 代表設置第幾個 Shard 節點中的只讀節點個數。例如,ReplicaSet.2.ReadonlyReplicas表示設置第二個 Shard 節點的只讀節點個數。
| 0 |
ConfigServer | array<object> | 是 | ConfigServer 節點的信息。 | |
object | 是 | ConfigServer 節點的信息。 | ||
Class | string | 是 | ConfigServer 的規格,取值說明:
| mdb.shard.2x.xlarge.d |
Storage | integer | 是 | ConfigServer 的存儲空間,單位為 GB。 說明
具體取值受實例規格約束,取值詳情請參見分片集群實例規格表。
| 20 |
ResourceGroupId | string | 否 | 資源組 ID,資源組詳情請參見查看資源組基本信息。 | rg-acfmyiu4ekp**** |
SecondaryZoneId | string | 否 | 配置備可用區 1,實現多可用區部署。取值說明:
說明
| cn-hangzhou-h |
HiddenZoneId | string | 否 | 配置備可用區 2,實現多可用區部署。取值說明:
說明
| cn-hangzhou-i |
StorageType | string | 否 | 存儲類型,取值說明:
說明
| cloud_essd1 |
GlobalSecurityGroupIds | string | 否 | 實例的全局 IP 白名單模板,多個 IP 白名單模板請用英文逗號(,)分隔,不可重復。 | g-qxieqf40xjst1ngpr3jz |
Tag | array<object> | 否 | 用戶自定義標簽。 | |
object | 否 | |||
Key | string | 否 | 標簽的鍵。 說明
| testdatabase |
Value | string | 否 | 標簽的值。 說明
N 表示傳入第幾個標簽的值。例如:Tag.1.Value表示傳入第一個標簽的值;Tag.2.Value表示傳入第二個標簽的值。
| apitest |
Encrypted | boolean | 否 | 是否開啟云盤加密 | true |
EncryptionKey | string | 否 | 自定義密鑰 ID。 | 2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
ProvisionedIops | long | 否 | 預配置 IOPS | 1960 |
SrcRegion | string | 否 | 源實例所在區域。 說明
| cn-beijing |
BackupId | string | 否 | 集群備份 ID。 說明
| cb-xxx |
RestoreType | string | 否 | 備份恢復實例。
| 1 |
DestRegion | string | 否 | 異地備份所在地域。 | cn-hangzhou |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "D8F1D721-6439-4257-A89C-F1E8E9C9****",
"DBInstanceId": "dds-bp114f14849d****",
"OrderId": "21010996721****"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 |
---|---|---|
400 | SecurityRisk.AuthVerification | we have detected a risk with your default payment method. An email and notification has been sent to you. Please re-submit your order before after verificaiton. |
400 | InvaliadParameter.ShardsCount.LessThanSrc | The specified number of shards is less than that of source instance. |
400 | ORDER.ACCOUNT_INFORMATION_INCOMPLETE | Your information is incomplete. Complete your information before ordering. |
400 | InvalidRegion.Format | Specified Region is not valid. |
400 | Zone.Closed | The specified zone is closed. |
400 | TokenServiceError | The request token is duplicated. |
400 | InvalidParam | Param not valid. |
400 | InvalidEngineVersion.Malformed | Specified engine version is not valid. |
400 | InvalidParameters.Format | Specified parameters is not valid. |
403 | InvalidBackupLogStatus | Current backup log enable status does not support this operation. |
500 | VpcServiceError | Invoke vpc service error. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-03-13 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-03-13 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-08-24 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2023-08-01 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2023-06-05 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2022-10-13 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2021-12-27 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2021-12-27 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |