創建或克隆云數據庫MongoDB版副本集實例。
接口說明
請確保在使用該接口前,已充分了解云數據庫 MongoDB 產品的收費方式和價格。
關于云數據庫 MongoDB 實例的規格,請參見實例規格表。
如需創建分片集群實例,您可以通過調用 CreateShardingDBInstance 接口進行創建。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
dds:CreateDBInstance | create | *Instance acs:dds:{#regionId}:{#accountId}:dbinstance/* |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域 ID,您可以通過調用 DescribeRegions 接口查詢地域 ID。 說明
調用本接口克隆實例或者回收站恢復實例時,該參數值需和源實例保持一致。
| cn-hangzhou |
ClientToken | string | 否 | 用于保證請求的冪等性,防止重復提交請求。由客戶端生成該參數值,要保證在不同請求間唯一,最大值不超過 64 個 ASCII 字符,且該參數值中不能包含非 ASCII 字符。 | ETnLKlblzczshOTUbOCz**** |
ZoneId | string | 否 | 可用區 ID,您可以通過調用 DescribeRegions 接口查詢可用區 ID。 | cn-hangzhou-g |
EngineVersion | string | 是 | 數據庫版本號,取值:
說明
調用本接口克隆實例或者回收站恢復實例時,該參數值需和源實例保持一致。
警告 3.4 及以下版本已停售。 | 4.4 |
DBInstanceClass | string | 是 | 實例規格,您可以通過調用 DescribeAvailableResource 接口查詢實例規格。 | dds.mongo.standard |
DBInstanceStorage | integer | 是 | 實例存儲空間,單位:GB。 具體取值受實例規格約束,詳情請參見副本集實例規格表。 | 10 |
DBInstanceDescription | string | 否 | 實例名稱,取值說明:
| test |
SecurityIPList | string | 否 | 實例的 IP 白名單,多個 IP 地址請用英文逗號(,)分隔,不可重復。支持如下三種格式:
說明
| 192.168.xx.xx,192.168.xx.xx |
AccountPassword | string | 否 | root 賬號的密碼,取值說明:
說明
關于特殊字符導致數據庫連接失敗的問題請參見如何解決連接串中賬號密碼包含特殊字符導致連接失敗的問題?。
| 123456Aa |
Period | integer | 否 | 實例的購買時長,單位為月。 取值范圍:1~9(整數)、12、24、36、60。 說明
當 ChargeType 參數值為 PrePaid 時,該參數可用且為必填參數。
| 1 |
ChargeType | string | 否 | 實例的付費類型,取值說明:
說明
當該參數的值為 PrePaid 時,您還需要配置 Period 參數。
| PrePaid |
NetworkType | string | 否 | 實例的網絡類型,取值說明: VPC:專有網絡。 | VPC |
VpcId | string | 是 | 專有網絡(VPC)ID。 | vpc-bp175iuvg8nxqraf2**** |
VSwitchId | string | 是 | 虛擬交換機 ID。 | vsw-bp1gzt31twhlo0sa5**** |
SrcDBInstanceId | string | 否 | 源實例 ID。 說明
調用本接口克隆實例時,您需要配置該參數,同時還需要配置 BackupId 或 RestoreTime 參數。調用本接口進行回收站恢復時,只需要傳入該參數,無需配置 BackupId 或 RestoreTime。
| dds-bp1ee12ad351**** |
BackupId | string | 否 | 備份點 ID,您可以通過調用 DescribeBackups 接口查詢備份點 ID。 說明
只有調用本接口按備份點克隆實例時,您需要配置該參數,同時還需要配置 SrcDBInstanceId 參數。
| 32994**** |
RestoreTime | string | 否 | 選擇要恢復的時間點,您可以配置 7 天內的任意時間點。格式為yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。 說明
只有調用本接口按時間點克隆實例時,您需要配置該參數,同時還需要配置 SrcDBInstanceId 參數。
| 2022-03-13T12:11:14Z |
BusinessInfo | string | 否 | 附加參數,業務信息。 | {“ActivityId":"000000000"} |
AutoRenew | string | 否 | 實例是否自動續費,取值說明:
說明
當 ChargeType 參數值為 PrePaid 時,該參數可用且為可選參數。
| true |
DatabaseNames | string | 否 | 數據庫名。 說明
調用本接口克隆實例時,您可以通過配置該參數指定需要克隆的數據庫,如果不配置該參數,則克隆實例的所有數據庫。
| mongodbtest |
CouponNo | string | 否 | 是否使用優惠券,取值說明:
| default |
StorageEngine | string | 否 | 實例的存儲引擎,取值固定為 WiredTiger。 說明
| WiredTiger |
ReplicationFactor | string | 否 | 副本集實例的主備節點數,取值:
| 3 |
ReadonlyReplicas | string | 否 | 副本集實例的只讀節點數,取值范圍:0~5(整數),默認值為 0。 | 0 |
ResourceGroupId | string | 否 | 資源組 ID。 | rg-acfmyiu4ekp**** |
ClusterId | string | 否 | 專屬集群 ID。 | dhg-2x78**** |
Engine | string | 否 | 數據庫引擎,固定取值:MongoDB。 | MongoDB |
StorageType | string | 否 | 存儲類型,取值說明:
說明
| cloud_essd1 |
SecondaryZoneId | string | 否 | 配置從節點(Secondary 節點)所在的可用區,實現多可用區部署。取值說明:
說明
| cn-hangzhou-h |
HiddenZoneId | string | 否 | 配置隱藏節點(Hidden 節點)所在的可用區,實現多可用區部署。取值說明:
說明
| cn-hangzhou-i |
Tag | array<object> | 否 | 用戶自定義標簽。 | |
object | 否 | |||
Key | string | 否 | 標簽的鍵。 說明
| testdatabase |
Value | string | 否 | 標簽的值。 說明
N 表示傳入第幾個標簽的值。例如:Tag.1.Value表示傳入第一個標簽的值;Tag.2.Value表示傳入第二個標簽的值。
| apitest |
GlobalSecurityGroupIds | string | 否 | 實例的全局 IP 白名單模板,多個 IP 白名單模板請用英文逗號(,)分隔,不可重復。(功能灰度中) | g-qxieqf40xjst1ngpr3jz |
Encrypted | boolean | 否 | 是否開啟云盤加密 | true |
EncryptionKey | string | 否 | 自定義密鑰 ID。 | 2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
ProvisionedIops | long | 否 | 預配置性能(IOPS)。取值范圍為 0~50000。 | 1960 |
RestoreType | string | 否 | 備份恢復實例。
| 0 |
SrcRegion | string | 否 | 源實例所在區域。 說明
| 2 |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "D8F1D721-6439-4257-A89C-F1E8E9C9****",
"DBInstanceId": "dds-bp144a7f2db8****",
"OrderId": "21077576248****"
}
錯誤碼
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 | MissingParameter | Period is mandatory for this action. | - |
400 | ORDER.ACCOUNT_INFORMATION_INCOMPLETE | Your information is incomplete. Complete your information before ordering. | - |
400 | InvalidClientToken.Malformed | Specified parameter ClientToken is not valid. | - |
400 | InvalidDBInstanceDescription.Malformed | Specified parameter DBInstanceDescription is not valid. | 節點名稱不合法 |
400 | InvalidSecurityIPListLength.Malformed | The quota of security ip exceeds. | - |
400 | InsufficientBalance | Your account does not have enough balance. | 支付失敗,您可以添加其他支付方式,也可以充值后重試。 |
400 | QuotaExceed.AfterpayInstance | Living afterpay instances quota exceeded. | - |
400 | InvalidCapacity.NotFound | The Capacity provided does not exist in our records. | 實例的存儲容量配置錯誤,請設置為有效范圍內的值,單位為MB。 |
400 | ResourceNotAvailable | Resource you requested is not available for finance user. | - |
400 | IdempotentParameterMismatch | Request uses a client token in a previous request but is not identical to that request. | ClientToken參數值已被使用,請輸入未使用過的ClientToken參數值。ClientToken由客戶端生成,需保證在不同請求間唯一,最大值不超過64個ASCII字符,且該參數值中不能包含非ASCII字符。 |
400 | InvalidSecurityIPList.Malformed | The specified parameter "SecurityIPList" is not valid. | - |
400 | InvalidSecurityIPList.Duplicate | The Security IP address is not in the available range or occupied. | - |
400 | InvalidSecurityIPListLength.Malformed | The quota of security ip exceeds. | - |
400 | InvalidDBInstanceStorage.ValueNotSupported | The specified parameter DBInstanceStorage is not valid. | - |
400 | InvalidAccountPassword.Malformed | Specified parameter AccountPassword is not valid. | - |
400 | TokenServiceError | Duplicate ClientToken request. | - |
400 | Zone.Closed | The specified zone is closed. | - |
400 | PRICE.ORIGIN_PRICE_ERROR | The origin price error. | - |
400 | NO_AVAILABLE_PAYMENT_METHOD | No payment method is specified for your account. We recommend that you add a payment method. | - |
400 | InvalidEcsImage.NotFound | Specified ecs image does not exist. | - |
400 | SaleValidateNoSpecificCodeFailed | Specified Storage or Version or InstanceClass is invalid. | Storage 或 Version 或 InstanceClass 為空。 |
400 | Trade_Not_Support_Async_Pay | Trade not support async pay. | - |
400 | InvalidZoneld | The specified primary zone, secondary zone and hidden zone cannot be the same. | 選擇的主可用區、備可用區1和備可用區2參數不能完全相同。 |
400 | SameZoneId | The specified primary zone, secondary zone require two different zones. | 選擇的主可用區、備可用區參數要求不同。 |
403 | RealNameAuthenticationError | Your account has not passed the real-name authentication yet. | 阿里云賬號未進行實名認證,請進行實名認證后重試。 |
403 | RegionUnauthorized | There is no authority to create instance in the specified region. | - |
403 | OperationDenied | The resource is out of usage. | The resource is out of usage. |
403 | InvalidEngineVersionInRegion.NotAvailable | The EngineVersion in the Region is not available. | - |
403 | InvalidBackupLogStatus | Current backup log enable status does not support this operation. | - |
403 | IncorrectBackupSetState | Current backup set state does not support operations. | 當前最新備份集未就緒,請稍后重試。 |
404 | InvalidBackup.NotFound | The available backup does not exist in recovery time. | - |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-12-17 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-07-15 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-04-18 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-03-13 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-01-12 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-11-03 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-08-24 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2023-08-01 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2023-06-05 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |