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

ApsaraDB for MongoDB のレプリカセットインスタンスを作成またはクローンします。

操作説明

この操作を呼び出す前に、ApsaraDB for MongoDB の課金方法と料金をご理解ください。

ApsaraDB for MongoDB のインスタンスタイプの詳細については、「インスタンスタイプ」をご参照ください。

シャードクラスターインスタンスを作成するには、CreateShardingDBInstance 操作を呼び出します。

今すぐお試しください

この 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:CreateDBInstance

create

*Instance

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リージョン ID。リージョン ID を照会するには、DescribeRegions 操作を呼び出します。説明インスタンスをクローンするか、ゴミ箱からインスタンスを復元する場合、このパラメーターはソースインスタンスのリージョン ID と同じである必要があります。	cn-hangzhou
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークン。クライアントを使用してトークンを生成できます。トークンが異なるリクエスト間で一意であることを確認してください。トークンには ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。	ETnLKlblzczshOTUbOCz****
ZoneId	string	任意	ゾーン ID。ゾーン ID を照会するには、DescribeRegions 操作を呼び出します。	cn-hangzhou-g
EngineVersion	string	必須	データベースエンジンのバージョン。有効な値： 8.0 7.0 6.0 5.0 4.4 4.2 4.0 説明インスタンスをクローンするか、ゴミ箱からインスタンスを復元する場合、このパラメーターはソースインスタンスのエンジンバージョンと同じである必要があります。警告バージョン 3.4 以前は廃止されました。	4.4
DBInstanceClass	string	必須	インスタンスタイプ。インスタンスタイプを照会するには、DescribeAvailableResource 操作を呼び出します。	dds.mongo.standard
DBInstanceStorage	integer	必須	インスタンスのストレージ容量 (GB)。このパラメーターの値はインスタンスタイプによって異なります。詳細については、「レプリカセットインスタンスタイプ」をご参照ください。	10
DBInstanceDescription	string	任意	インスタンス名。名前は次の要件を満たす必要があります：文字または漢字で始まる必要があります。文字、漢字、数字、アンダースコア (_)、ピリオド (.)、ハイフン (-) を含めることができます。長さは 2〜256 文字である必要があります。	test
SecurityIPList	string	任意	インスタンスの IP アドレスホワイトリスト。複数の IP アドレスをコンマ (,) で区切ります。ホワイトリスト内の各 IP アドレスは一意である必要があります。ホワイトリストは次のいずれかの形式にすることができます： 0.0.0.0/0 IP アドレス (例: 10.23.12.24)。 CIDR ブロック (例: 10.23.12.0/24)。/24 は、CIDR ブロックのプレフィックス長が 24 ビットであることを示します。プレフィックスは 1 から 32 までの値に設定できます。説明すべての IP アドレスホワイトリストに最大 1,000 個の IP アドレスまたは CIDR ブロックを追加できます。ホワイトリストを 0.0.0.0/0 に設定すると、すべての IP アドレスがインスタンスにアクセスできるようになります。これはリスクの高い設定ですので、注意して使用してください。	192.168.xx.xx,192.168.xx.xx
AccountPassword	string	任意	ルートアカウントのパスワード。パスワードは次の要件を満たす必要があります：大文字、小文字、数字、特殊文字のうち、3 種類以上の文字を含める必要があります。特殊文字は !@#$%^&*()_+-= です。長さは 8〜32 文字である必要があります。説明パスワードの特殊文字による接続失敗の詳細については、「パスワードの特殊文字による接続失敗を修正するにはどうすればよいですか？」をご参照ください。	123456Aa
Period	integer	任意	インスタンスのサブスクリプション期間 (月単位)。有効な値：1〜9 (整数)、12、24、36、60。説明このパラメーターは必須であり、ChargeType パラメーターを PrePaid に設定した場合にのみ有効になります。	1
ChargeType	string	任意	インスタンスの課金方法。有効な値： PostPaid: デフォルト値。従量課金。 PrePaid: サブスクリプション。説明このパラメーターを PrePaid に設定する場合は、Period パラメーターも指定する必要があります。	PrePaid
NetworkType	string	任意	インスタンスのネットワークタイプ。有効な値： VPC: Virtual Private Cloud (VPC)。	VPC
VpcId	string	任意	VPC ID。	vpc-bp175iuvg8nxqraf2****
VSwitchId	string	任意	vSwitch ID。	vsw-bp1gzt31twhlo0sa5****
SrcDBInstanceId	string	任意	ソースインスタンス ID。説明インスタンスをクローンする場合、このパラメーターと BackupId または RestoreTime パラメーターを指定する必要があります。ゴミ箱からインスタンスを復元する場合、このパラメーターのみを指定する必要があります。BackupId または RestoreTime パラメーターを指定する必要はありません。	dds-bp1ee12ad351****
BackupId	string	任意	バックアップポイント ID。バックアップポイント ID を照会するには、DescribeBackups 操作を呼び出します。説明このパラメーターと SrcDBInstanceId パラメーターは、バックアップポイントに基づいてインスタンスをクローンする場合にのみ指定する必要があります。	32994****
RestoreTime	string	任意	インスタンスを復元したいポイントインタイム。過去 7 日以内の任意のポイントインタイムを指定できます。時間は yyyy-MM-ddTHH:mm:ssZ 形式で、UTC である必要があります。説明このパラメーターと SrcDBInstanceId パラメーターは、ポイントインタイムに基づいてインスタンスをクローンする場合にのみ指定する必要があります。	2022-03-13T12:11:14Z
BusinessInfo	string	任意	ビジネス情報。これはオプションのパラメーターです。	{“ActivityId":"000000000"}
AutoRenew	string	任意	インスタンスの自動更新を有効にするかどうかを指定します。有効な値： true: 自動更新を有効にします。 false: デフォルト値。自動更新を無効にします。インスタンスを手動で更新する必要があります。説明このパラメーターはオプションであり、ChargeType パラメーターを PrePaid に設定した場合にのみ有効になります。	true
DatabaseNames	string	任意	データベース名。説明インスタンスをクローンする場合、このパラメーターを指定して特定のデータベースをクローンできます。このパラメーターを指定しない場合、インスタンスのすべてのデータベースがクローンされます。	mongodbtest
CouponNo	string	任意	クーポンを使用するかどうかを指定します。有効な値： default または null (デフォルト): クーポンを使用します。 youhuiquan_promotion_option_id_for_blank: クーポンを使用しません。	default
StorageEngine	string	任意	インスタンスのストレージエンジン。値は WiredTiger に固定されています。説明インスタンスをクローンするか、ゴミ箱からインスタンスを復元する場合、このパラメーターはソースインスタンスのストレージエンジンと同じである必要があります。ストレージエンジンとデータベースバージョンの制約の詳細については、「バージョンとストレージエンジン」をご参照ください。	WiredTiger
ReplicationFactor	string	任意	レプリカセットインスタンス内のプライマリノードとセカンダリノードの数。有効な値： 3 (デフォルト) 5 7 重要スタンドアロンインスタンスの場合、このパラメーターを指定する必要はありません。	3
ReadonlyReplicas	string	任意	レプリカセットインスタンス内の読み取り専用ノードの数。有効な値は 0 から 5 までの整数です。デフォルト値は 0 です。	0
Engine	string	任意	データベースエンジン。値は MongoDB に固定されています。	MongoDB
StorageType	string	任意	ストレージクラス。有効な値： cloud_essd1: ESSD PL1 ディスク。 cloud_essd2: ESSD PL2 ディスク。 cloud_essd3: ESSD PL3 ディスク。 cloud_auto: ESSD AutoPL ディスク。 local_ssd: ローカル SSD。説明スタンドアロンインスタンスの場合、cloud_essd1 の値を渡すと、ESSD ディスクが使用されます。 ESSD AutoPL ディスクは、中国サイト (aliyun.com) でのみ利用可能です。バージョン 4.4 以降のインスタンスの場合、デフォルト値は cloud_essd1 です。バージョン 4.2 以前のインスタンスの場合、デフォルト値は local_ssd です。	cloud_essd1
SecondaryZoneId	string	任意	セカンダリノードがデプロイされるゾーン。このパラメーターはマルチゾーンデプロイメントに使用されます。有効な値： 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	任意	非表示ノードがデプロイされるゾーン。このパラメーターはマルチゾーンデプロイメントに使用されます。有効な値： 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
Tag	array<object>	任意	カスタムタグ。
	object	任意	インスタンスに追加されたカスタムタグ。
Key	string	任意	タグキー。説明 N は N 番目のタグを指定します。たとえば、Tag.1.Key は最初のタグのキーを指定し、Tag.2.Key は 2 番目のタグのキーを指定します。	testdatabase
Value	string	任意	タグ値。説明 N は N 番目のタグを指定します。たとえば、Tag.1.Value は最初のタグの値を指定し、Tag.2.Value は 2 番目のタグの値を指定します。	apitest
GlobalSecurityGroupIds	string	任意	インスタンスのグローバル IP アドレスホワイトリストテンプレート。複数のテンプレートをコンマ (,) で区切ります。テンプレートは繰り返すことはできません。この機能はカナリアリリースです。	g-qxieqf40xjst1ngpr3jz
Encrypted	boolean	任意	ディスク暗号化を有効にするかどうかを指定します。	true
EncryptionKey	string	任意	カスタムキー ID。	2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
ProvisionedIops	integer	任意	プロビジョニング済み IOPS (1 秒あたりの入出力操作)。有効な値：0〜50000。	1960
RestoreType	string	任意	バックアップからインスタンスを復元するメソッド。 0: インスタンスを指定されたバックアップセットに復元します。 1: インスタンスを指定されたポイントインタイムに復元します。 2: 解放されたインスタンスを指定されたバックアップセットに復元します。 3: インスタンスを指定された geo 冗長バックアップセットに復元します。	0
SrcRegion	string	任意	ソースインスタンスが配置されているリージョン。説明このパラメーターは、RestoreType が 2 または 3 に設定されている場合に必須です。	2

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	D8F1D721-6439-4257-A89C-F1E8E9C9****
DBInstanceId	string	インスタンス ID。	dds-bp144a7f2db8****
OrderId	string	注文 ID。	21077576248****

例

成功レスポンス

JSONJSON

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

エラーコード

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	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.
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.
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	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.
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.
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.
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.

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

変更履歴

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