この API を呼び出して、ApsaraDB for MongoDB インスタンスを作成および複製できます。

この API を使用する前に、ApsaraDB for MongoDB の課金方法と 価格 を十分にご理解いただく必要があります。

ApsaraDB for MongoDB インスタンスの仕様の詳細は、インスタンスの仕様 をご参照ください。

シャードクラスターインスタンスを作成するには、CreateShardingDBInstance を呼び出すことができます。

デバッグ

OpenAPI Explorer は API の使用を簡素化します。 OpenAPI Explorer を使用して、API の取得、API の呼び出し、SDK サンプルコードの動的生成などのデバッグ操作を実行できます。

リクエストパラメータ

パラメータ データ型 必須 例 説明
Action String はい CreateDBInstance

実行する操作。 値をCreateDBInstance に設定します。

ClientToken String はい ETnLKlblzczshOTUbOCzxxxxxxxxxx

リクエストのべき等性を保証するために使用されるクライアントトークン。 クライアントを使用してこの値を生成できますが、異なるリクエスト間で一意であることを確実にする必要があります。 トークンには ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。

Engine String はい MongoDB

データベースエンジン。 値をMongoDB に設定します。

EngineVersion String はい 4.0

データベースのバージョン番号。 有効値：3.2 、 3.4 または 4.0 。

注 インスタンスを複製するためにこの API を呼び出す場合、この値がソースインスタンスのエンジンバージョン番号と同じであることが必要です。
DBInstanceClass String はい dds.mongo.standard

インスタンスの仕様。 値の詳細は、インスタンス仕様 をご参照ください。

DBInstanceStorage Integer はい 10

インスタンスのストレージスペース。

  • 有効値： 10 から 3000 。 単位 : GB
  • この値は、最小 10 GB/回 で指定できます。
注 このパラメーターに指定できる値は、インスタンスの仕様によって異なります。 詳細は、インスタンスタ仕様 をご参照ください。
RegionId String はい cn-hangzhou

リージョンの ID です。 DescribeRegions を呼び出して、リージョンをクエリできます。

ZoneId String いいえ cn-hangzhou-d

ゾーンの ID。 DescribeRegions を呼び出して、ゾーンをクエリできます。

DBInstanceDescription String いいえ Test database 1

インスタンスの名前。 長さは 2 ～ 256 文字である必要があります。 先頭文字は英字である必要があります。英字、数字、コロン（:)、アンダースコア（_）、およびハイフン（ - ）が使用可能です。

SecurityIPList String いいえ 10.23.12.24/24
  • インスタンスへのアクセスが許可されている IP アドレスを含むホワイトリスト。 複数の IP アドレスはカンマ (,) で区切ります。 各 IP アドレスは一意である必要があります。 最大 1,000 個の IP アドレスを追加できます。
  • サポートされている IP アドレスの形式は、%、0.0.0.0/0、10.23.12.24 などの IP アドレス、または 10.23.12.24/24 などの CIDR ブロック。 /24 は、IP アドレスプレフィックスの長さを示します。 IP アドレスプレフィックスは、1 ~ 32 ビットで構成できます。
注 ％ と 0.0.0.0/0 は、任意の IP アドレスがデータベースにアクセスできることを示します。 ハイリスクであるため、これらの値を設定することをお勧めしません。
AccountPassword String いいえ Alitest! 159

root アカウントのパスワード。

  • パスワードには、大文字、小文字、数字、特殊文字の少なくとも 3 種類の文字が含まれる必要があります。 特殊文字：! #$%^&*()_+-=
  • パスワードの長さは 8~32 文字である必要があります。
ChargeType String いいえ PrePaid

インスタンスの課金方法です。 有効値：

  • PostPaid： 従量課金
  • PrePaid：サブスクリプション

デフォルト値：従量課金。

注 このパラメーターを PrePaid に指定する場合、Period パラメーターも指定する必要があります。
Period Integer いいえ 1

インスタンスのサブスクリプション期間。 単位 : 月 有効値： 1 ~ 9、 12、 24 および 36 。

注 指定した場合、このパラメータにのみ有効です ChargeTypeのへのパラメータプリペイド.
NetworkType String いいえ VPC

インスタンスのネットワークタイプ。 有効値：

  • CLASSIC
  • VPC

デフォルト値 : classic。

注 このパラメーターを VPC に指定する場合、VpcId パラメーターと VSwitchId パラメーターも指定する必要があります。
VpcId String いいえ vpc-bpxxxxxxxx

VPC の ID。

注 このパラメーターは、NetworkType パラメーターを VPC に指定した場合にのみ有効です。
VSwitchId String いいえ vsw-bpxxxxxxxx

VSwitch の ID

注 このパラメーターは、NetworkType パラメーターを VPC に指定した場合にのみ有効です。
SrcDBInstanceId String いいえ dds-bpxxxxxxxx

ソースインスタンスの ID。 このパラメーターは、この API が呼び出してインスタンスを複製する場合にのみ指定できます。 BackupId パラメータまたは RestoreTime パラメータも指定する必要があります。

BackupId String いいえ 32994xxxx

特定のバックアップセットの ID。 このパラメーターは、この API が呼び出してインスタンスを複製する場合にのみ指定できます。 SrcDBInstanceId パラメータも指定する必要があります。

注 DescribeBackups API を呼び出して、バックアップセットの ID をクエリできます。
RestoreTime String いいえ 2019-03-13T12:11:14Z

複製されたインスタンスを復元する時刻。 形式：yyyy-MM-ddTHH:mm:ssZ。

注
  • このパラメーターは、この API が呼び出してインスタンスを複製する場合にのみ指定できます。 SrcDBInstanceId パラメータまたは BackupId パラメータも指定する必要があります。
  • 過去 7 日間の任意の復元時刻にインスタンスを複製できます。
BusinessInfo String いいえ {“ActivityId":"000000000"}

ビジネス情報。 追加パラメーター。

DatabaseNames String いいえ mongodbtest

データベースの名前。

注 この API を呼び出してインスタンスを複製する場合、このパラメータを使用して複製するデータベースを指定できます。 指定しない場合、インスタンス配下のすべてのデータベースが複製されます。
AutoRenew String いいえ true

インスタンスの自動更新が有効になっているかどうかを示します。 有効値：

  • true： 自動更新が有効になっています。
  • false : 自動更新は有効になっていません。 インスタンスを手動で更新する必要があります。

デフォルト値：false

注 このパラメーターは、ChargeType パラメーターを PrePaid に指定した場合にのみ有効です。
CouponNo String いいえ youhuiquan_promotion_option_id_for_blank

クーポンコード。 デフォルト値：youhuiquan_promotion_option_id_for_blank。

StorageEngine String いいえ WiredTiger

インスタンスが使用するストレージエンジン。 有効値： WiredTiger、 RocksDB 、 TerarkDB 。 デフォルト値：WiredTiger。 データベースバージョンとストレージエンジンの制限の詳細は、バージョンとストレージエンジン をご参照ください。

注 この API を呼び出してインスタンスを複製する場合、この値がソースインスタンスのエンジンバージョン番号と同じである必要があります。
ReplicationFactor String いいえ 3

レプリカセットインスタンス内のノード数。 有効値： 3、5、7。 デフォルト値： 3。

ResourceGroupId String いいえ rg-axxxxxxxx

リソースグループの ID。

AccessKeyId String いいえ LTAIgbTGpxxxxxx

Alibaba Cloud より提供される AccessKey ID。

レスポンスパラメータ

パラメータ タイプ 例 説明
DBInstanceId String dds-bpxxxxxxxx

インスタンスの ID

OrderId String 2033xxxxxxxxxxxx

注文 ID。

RequestId String D8F1D721-6439-4257-A89C-F1E8E9C9624D

リクエスト ID。

例

リクエストの例


http(s)://mongodb.aliyuncs.com/? Action=CreateDBInstance
&ClientToken=ETnLKlblzczshOTUbOCzxxxxxxxxxx 
&Engine=MongoDB
&EngineVersion=4.0
&DBInstanceClass=dds.mongo.standard
&DBInstanceStorage=10
&<Common request parameters>

通常のレスポンスの例

XML 形式 

<CreateDBInstanceResponse>
  <DBInstanceId>dds-bpxxxxxxxx</DBInstanceId>
  <OrderId>2033xxxxxxxxxxxx</OrderId>
  <RequestId>D8F1D721-6439-4257-A89C-F1E8E9C9624D</RequestId>
</CreateDBInstanceResponse>

JSON 形式 

{
	"RequestId":"D8F1D721-6439-4257-A89C-F1E8E9C9624D",
	"OrderId":"2033xxxxxxxxxxxx",
	"DBInstanceId":"dds-bpxxxxxxxx"
}

エラーコード

HTTP ステータスコード エラーコード エラーメッセージ 説明
400 InsufficientBalance Your account does not have enough balance. アカウントの残高が不十分な場合に返されるエラーメッセージ。 残高を追加して再試行してください。
403 RealNameAuthenticationError Your account has not passed the real-name authentication yet. 指定されたユーザーが実名認証を実行していない場合に返されるエラーメッセージ。 実名認証を実行して、再試行してください。
400 InvalidCapacity.NotFound The Capacity provided does not exist in our records. 設定された容量が無効な場合に返されるエラーメッセージ。 指定されたパラメータをご確認ください。
400 IdempotentParameterMismatch Request uses a client token in a previous request but is not identical to that request. リクエストは以前のリクエストで使用した ClientToken を使用し、そのリクエスト内容も異なる場合に返されるエラーメッセージ。

エラーコードの表示