CreateShardingDBInstance - 建立或複製分區叢集執行個體 -

建立或者複製 MongoDB 分區叢集執行個體。

介面說明

請確保在使用該介面前，已充分瞭解ApsaraDB for MongoDB 的收費方式和價格。
關於ApsaraDB for MongoDB 執行個體的規格，請參見執行個體規格表。
如果需要建立單節點執行個體和複本集執行個體，您可以通過調用 CreateDBInstance 介面建立。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dds:CreateShardingDBInstance

create

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/*

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	地區 ID，您可以通過調用 DescribeRegions 介面查詢地區 ID。	cn-hangzhou
ZoneId	string	否	可用性區域 ID，您可以通過調用 DescribeRegions 介面查詢可用性區域 ID。	cn-hangzhou-g
Engine	string	是	資料庫引擎。固定取值：MongoDB。	MongoDB
EngineVersion	string	是	資料庫版本號碼，取值： 8.0 7.0 6.0 5.0 4.4 4.2 4.0 說明關於儲存引擎與版本的選擇約束，請參見版本與儲存引擎。調用本介面複製執行個體時，該參數值需和源執行個體保持一致。	4.4
DBInstanceDescription	string	否	執行個體名稱，取值說明：以中文、英文字母開頭。可以包含數字、中文、英文、底線（_）、點（.）和虛線（-）。長度為 2~256 個字元。	test
SecurityIPList	string	否	執行個體的 IP 白名單，多個 IP 位址請用英文逗號（,）分隔，不可重複。支援如下三種格式： 0.0.0.0/0 IP 位址形式，例如：10.23.12.24。 CIDR 形式，例如：10.23.12.0/24（無類域間路由，24 表示了地址中首碼的長度，範圍為 1~32）。說明每個執行個體最多添加 1000 個 IP 或 IP 段，即所有 IP 白名單分組內的 IP 或 IP 段總和不能超過 1000。 0.0.0.0/0 表示任何 IP 位址都可以訪問執行個體的資料庫，屬於高危設定，請謹慎設定。	192.168.xx.xx,192.168.xx.xx
AccountPassword	string	否	root 帳號的密碼，取值說明：由大寫字母、小寫字母、數字、特殊字元中的至少三種組成。 !@#$%^&*()_+-=為特殊字元。長度為 8~32 個字元。說明關於特殊字元導致資料庫連接失敗的問題請參見如何解決串連串中帳號密碼包含特殊字元導致串連失敗的問題？。	123456Aa
ChargeType	string	否	執行個體的付費類型，取值說明： PostPaid：預設值，後付費（隨用隨付）。 PrePaid：預付費（訂用帳戶）。說明當該參數的值為 PrePaid 時，您還需要配置 Period 參數。	PrePaid
Period	integer	否	執行個體的購買時間長度，單位為月。取值範圍：1~9（整數）、12、24、36、60。說明當 ChargeType 參數值為 PrePaid 時，該參數可用且為必填參數。	1
NetworkType	string	否	執行個體的網路類型，取值說明： VPC：專用網路。	VPC
VpcId	string	否	Virtual Private CloudID。	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	否	執行個體是否自動續約，取值說明： true：自動續約。 false：預設值，不自動續約，即手動續約。說明當 ChargeType 參數值為 PrePaid 時，該參數可用且為選擇性參數。	true
ProtocolType	string	否	訪問協議的類型，取值說明： mongodb：MongoDB 協議。 dynamodb：DynamoDB 協議。	mongodb
Mongos	array<object>	是	Mongos 節點資訊。
	object	是	Mongos 節點資訊。
Class	string	是	Mongos 節點的規格，取值詳情請參見分區叢集執行個體規格表。說明參數名中的 N 代表傳入第幾個 Mongos 節點的規格。例如，Mongos.2.Class表示傳入第二個 Mongos 節點的規格。 N 的取值範圍為 2~32。	mdb.shard.2x.xlarge.d
ReplicaSet	array<object>	是	Shard 節點的資訊。
	object	否	Shard 節點的資訊。
Class	string	是	Shard 節點的規格，取值詳情請參見分區叢集執行個體規格表。說明參數名中的 N 代表傳入第幾個 Shard 節點的規格。例如，ReplicaSet.2.Class表示傳入第二個 Shard 節點的規格。 N 的取值範圍為 2~32。	dds.shard.standard
Storage	integer	是	Shard 節點的儲存空間，單位為 GB。說明具體取值受執行個體規格約束，取值詳情請參見分區叢集執行個體規格表。參數名中的 N 代表的是傳入第幾個 Shard 節點的儲存空間，例如：ReplicaSet.2.Storage表示傳入第二個 Shard 節點的儲存空間。	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：4 核 8 GB（獨享型），僅支援 4.4 及以上版本的執行個體。 dds.cs.mid：1 核 2 GB（通用型），僅支援 4.2 及以下版本的執行個體。	mdb.shard.2x.xlarge.d
Storage	integer	是	ConfigServer 的儲存空間，單位為 GB。說明具體取值受執行個體規格約束，取值詳情請參見分區叢集執行個體規格表。	20
ResourceGroupId	string	否	資源群組 ID，資源群組詳情請參見查看資源群組基本資料。	rg-acfmyiu4ekp****
SecondaryZoneId	string	否	配置備可用性區域 1，實現多可用性區域部署。取值說明： cn-hangzhou-g：杭州可用性區域 G。 cn-hangzhou-h：杭州可用性區域 H。 cn-hangzhou-i：杭州可用性區域 I。 cn-hongkong-b：中國香港可用性區域 B。 cn-hongkong-c：中國香港可用性區域 C。 cn-hongkong-d：中國香港可用性區域 D。 cn-wulanchabu-a：烏蘭察布可用性區域 A。 cn-wulanchabu-b：烏蘭察布可用性區域 B。 cn-wulanchabu-c：烏蘭察布可用性區域 C。 ap-southeast-1a：新加坡可用性區域 A。 ap-southeast-1b：新加坡可用性區域 B。 ap-southeast-1c：新加坡可用性區域 C。 ap-southeast-5a：雅加達可用性區域 A。 ap-southeast-5b：雅加達可用性區域 B。 ap-southeast-5c：雅加達可用性區域 C。 eu-central-1a：法蘭克福可用性區域 A。 eu-central-1b：法蘭克福可用性區域 B。 eu-central-1c：法蘭克福可用性區域 C。說明當執行個體為雲端硬碟類型時，該參數可用。該參數值不能與 ZoneId 和 HiddenZoneId 相同。分區叢集執行個體的多可用性區域部署策略，具體請參見建立多可用性區域分區叢集執行個體。	cn-hangzhou-h
HiddenZoneId	string	否	配置備可用性區域 2，實現多可用性區域部署。取值說明： cn-hangzhou-g：杭州可用性區域 G。 cn-hangzhou-h：杭州可用性區域 H。 cn-hangzhou-i：杭州可用性區域 I。 cn-hongkong-b：中國香港可用性區域 B。 cn-hongkong-c：中國香港可用性區域 C。 cn-hongkong-d：中國香港可用性區域 D。 cn-wulanchabu-a：烏蘭察布可用性區域 A。 cn-wulanchabu-b：烏蘭察布可用性區域 B。 cn-wulanchabu-c：烏蘭察布可用性區域 C。 ap-southeast-1a：新加坡可用性區域 A。 ap-southeast-1b：新加坡可用性區域 B。 ap-southeast-1c：新加坡可用性區域 C。 ap-southeast-5a：雅加達可用性區域 A。 ap-southeast-5b：雅加達可用性區域 B。 ap-southeast-5c：雅加達可用性區域 C。 eu-central-1a：法蘭克福可用性區域 A。 eu-central-1b：法蘭克福可用性區域 B。 eu-central-1c：法蘭克福可用性區域 C。說明當執行個體為雲端硬碟類型時，該參數可用。該參數值不能與 ZoneId 和 SecondaryZoneId 相同。分區叢集執行個體的多可用性區域部署策略，具體請參見建立多可用性區域分區叢集執行個體。	cn-hangzhou-i
StorageType	string	否	儲存類型，取值說明： cloud_essd1：ESSD PL1 雲端硬碟。 cloud_essd2：ESSD PL2 雲端硬碟。 cloud_essd3：ESSD PL3 雲端硬碟。 local_ssd：SSD 本地碟。說明 4.4 及以上版本執行個體只支援雲端硬碟，不填寫預設選擇cloud_essd1。 4.2 及以下版本執行個體只支援本地碟，不填寫預設選擇local_ssd。	cloud_essd1
GlobalSecurityGroupIds	string	否	執行個體的全域 IP 白名單模板，多個 IP 白名單模板請用英文逗號（,）分隔，不可重複。	g-qxieqf40xjst1ngpr3jz
Tag	array<object>	否	使用者自訂標籤。
	object	否
Key	string	否	標籤的鍵。說明 N 表示傳入第幾個標籤的鍵。例如：Tag.1.Key表示傳入第一個標籤的鍵；Tag.2.Key表示傳入第二個標籤的鍵。	testdatabase
Value	string	否	標籤的值。說明 N 表示傳入第幾個標籤的值。例如：Tag.1.Value表示傳入第一個標籤的值；Tag.2.Value表示傳入第二個標籤的值。	apitest
Encrypted	boolean	否	是否開啟雲端硬碟加密	true
EncryptionKey	string	否	自訂金鑰識別碼。	2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
ProvisionedIops	integer	否	預配置 IOPS	1960
SrcRegion	string	否	源執行個體所在地區。說明當備份恢複類型為已刪除執行個體重建時，需要且必填當備份恢複類型為異地備份複製時，需要且必填	cn-beijing
BackupId	string	否	叢集備份 ID。說明僅當 RestoreType=2 或 3 時需要且必填。	cb-xxx
RestoreType	string	否	備份恢複執行個體。 1: 恢複執行個體到指定時間點 2: 恢複已釋放執行個體到指定備份組 3: 恢複執行個體到指定的異地備份組	1
DestRegion	string	否	異地備份所在地區。	cn-hangzhou

返回參數

名稱	類型	描述	樣本值
	object	返回資訊。
RequestId	string	請求 ID。	D8F1D721-6439-4257-A89C-F1E8E9C9****
DBInstanceId	string	執行個體 ID。	dds-bp114f14849d****
OrderId	string	訂單 ID。	21010996721****

樣本

正常返回樣本

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.	輸入的參數無效。
400	RestoreTypeNotSupported	The specified restoreType is not supported for the instance, check the input parameters 'RestoreType/BackupID/RestoreTime'.	指明的恢複類型執行個體不支援，檢查 RestoreType/BackupID/RestoreTime 輸入參數。
500	VpcServiceError	Invoke vpc service error.	調用vpc服務錯誤。
403	InvalidBackupLogStatus	Current backup log enable status does not support this operation.
403	ReduceDiskNotSupport	Reduce disk size is not supported in clone/restore.	執行個體複製\恢複不支援縮小磁碟空間大小。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。