CreateShardingDBInstance - - Alibaba Cloud ドキュメントセンター

MongoDB シャードクラスターインスタンスを作成またはクローン作成します。

操作説明

この操作を呼び出す前に、ApsaraDB for MongoDB の課金方法と料金について理解していることを確認してください。
ApsaraDB for MongoDB のインスタンスタイプの詳細については、「インスタンスタイプ」をご参照ください。
スタンドアロンインスタンスまたはレプリカセットインスタンスを作成するには、CreateDBInstance 操作を呼び出します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

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 アドレスをコンマ (,) で区切ります。ホワイトリスト内の各 IP アドレスは一意である必要があります。次のフォーマットがサポートされています： 0.0.0.0/0 10.23.12.24 などの IP アドレス。 10.23.12.0/24 などの CIDR ブロック。 /24 の部分は、CIDR ブロックのプレフィックス長を示します。プレフィックス長の範囲は 1～32 です。説明すべての IP アドレスホワイトリストに最大 1,000 個の IP アドレスまたは CIDR ブロックを追加できます。 0.0.0.0/0 エントリは、すべての IP アドレスからのアクセスを許可します。これはリスクの高い設定です。慎重に設定してください。	192.168.xx.xx,192.168.xx.xx
AccountPassword	string	任意	ルートアカウントのパスワード。パスワードは、次の要件を満たす必要があります：大文字、小文字、数字、特殊文字の 4 種類のうち、3 種類以上を含める必要があります。特殊文字には !@#$%^&*()_+-= が含まれます長さは 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。	VPC
VpcId	string	任意	VPC ID。	vpc-bp1n3i15v90el48nx****
VSwitchId	string	任意	vSwitch 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	任意	リクエストのべき等性を保証するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、トークンが異なるリクエスト間で一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。	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 は 2 番目の Mongos ノードのインスタンスタイプを指定します。 N の値の範囲は 2～32 です。	mdb.shard.2x.xlarge.d
ReplicaSet	array<object>	必須	シャードノードの情報。
	object	任意	シャードノードの情報。
Class	string	必須	シャードノードのインスタンスタイプ。詳細については、「シャードクラスターインスタンスのインスタンスタイプ」をご参照ください。説明パラメーター名の N は、シャードノードのシリアル番号を指定します。たとえば、ReplicaSet.2.Class は 2 番目のシャードノードのインスタンスタイプを指定します。 N の値の範囲は 2～32 です。	dds.shard.standard
Storage	integer	必須	シャードノードのストレージ容量。単位：GB。説明このパラメーターの値はインスタンスタイプによって制限されます。詳細については、「シャードクラスターインスタンスのインスタンスタイプ」をご参照ください。パラメーター名の N は、シャードノードのシリアル番号を指定します。たとえば、ReplicaSet.2.Storage は 2 番目のシャードノードのストレージ容量を指定します。	10
ReadonlyReplicas	integer	任意	シャードノード内の読み取り専用ノードの数。有効値：0～5。デフォルト値は 0 です。説明パラメーター名の N は、シャードノードのシリアル番号を指定します。たとえば、ReplicaSet.2.ReadonlyReplicas は 2 番目のシャードノードの読み取り専用ノードの数を指定します。	0
ConfigServer	array<object>	必須	ConfigServer ノードの情報。
	object	任意	ConfigServer ノードの情報。
Class	string	必須	ConfigServer ノードのインスタンスタイプ。有効値： mdb.shard.2x.xlarge.d：4 コア 8 GB (専用)。このインスタンスタイプは、MongoDB 4.4 以降を実行するインスタンスでのみ使用できます。 dds.cs.mid：1 コア 2 GB (汎用)。このインスタンスタイプは、MongoDB 4.2 以前を実行するインスタンスでのみ使用できます。	mdb.shard.2x.xlarge.d
Storage	integer	必須	ConfigServer ノードのストレージ容量。単位：GB。説明このパラメーターの値はインスタンスタイプによって制限されます。詳細については、「シャードクラスターインスタンスのインスタンスタイプ」をご参照ください。	20
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：高性能 SSD (ESSD) PL1。 cloud_essd2：ESSD PL2。 cloud_essd3：ESSD PL3。 local_ssd：ローカル SSD。説明 MongoDB 4.4 以降を実行するインスタンスはディスクのみをサポートします。このパラメーターを指定しない場合、cloud_essd1 が使用されます。 MongoDB 4.2 以前を実行するインスタンスはローカルディスクのみをサポートします。このパラメーターを指定しない場合、local_ssd が使用されます。	cloud_essd1
GlobalSecurityGroupIds	string	任意	インスタンスのグローバル IP アドレスホワイトリストテンプレート。複数のテンプレートをコンマ (,) で区切ります。各テンプレートは一意である必要があります。	g-qxieqf40xjst1ngpr3jz
Tag	array<object>	任意	カスタムタグ。
	object	任意	インスタンスに追加されたカスタムタグ。
Key	string	任意	タグのキー。説明 N はタグのシリアル番号を指定します。たとえば、Tag.1.Key は最初のタグのキーを指定し、Tag.2.Key は 2 番目のタグのキーを指定します。	testdatabase
Value	string	任意	タグの値。説明 N はタグのシリアル番号を指定します。たとえば、Tag.1.Value は最初のタグの値を指定し、Tag.2.Value は 2 番目のタグの値を指定します。	apitest
Encrypted	boolean	任意	ディスク暗号化を有効にするかどうかを指定します。	true
EncryptionKey	string	任意	カスタムキー ID。	2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
ProvisionedIops	integer	任意	プロビジョンド IOPS。	1960
SrcRegion	string	任意	ソースインスタンスのリージョン。説明このパラメーターは、バックアップからリリースされたインスタンスを再作成する場合に必須です。このパラメーターは、geo 冗長バックアップからインスタンスをクローンする場合に必須です。	cn-beijing
BackupId	string	任意	クラスターバックアップ ID。説明このパラメーターは、RestoreType が 2 または 3 に設定されている場合にのみ必須です。	cb-xxx
RestoreType	string	任意	バックアップベースのインスタンス復元方法。 1：インスタンスを特定の時点に復元します。 2：特定のバックアップセットからリリースされたインスタンスを復元します。 3：特定の geo 冗長バックアップセットからインスタンスを復元します。	1
DestRegion	string	任意	geo 冗長バックアップが保存されているリージョン。	cn-hangzhou

レスポンスフィールド

フィールド	型	説明	例
	object	返された情報。
RequestId	string	リクエスト ID。	D8F1D721-6439-4257-A89C-F1E8E9C9****
DBInstanceId	string	インスタンス ID。	dds-bp114f14849d****
OrderId	string	注文 ID。	21010996721****

例

成功レスポンス

JSONJSON

{
  "RequestId": "D8F1D721-6439-4257-A89C-F1E8E9C9****",
  "DBInstanceId": "dds-bp114f14849d****",
  "OrderId": "21010996721****"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
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'.
500	VpcServiceError	Invoke vpc service error.
403	InvalidBackupLogStatus	Current backup log enable status does not support this operation.
403	ReduceDiskNotSupport	Reduce disk size is not supported in clone/restore.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。