すべてのプロダクト
Search

このプロダクト

    :CreateDBInstance

    ドキュメントセンター

    :CreateDBInstance

    最終更新日:May 14, 2025

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

    この操作を呼び出す前に、課金方法と 料金 を十分に理解していることを確認してください。

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

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

    デバッグ

    OpenAPI Explorer は署名値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。 OpenAPI Explorer は、さまざまな SDK の操作のサンプルコードを動的に生成します。

    リクエストパラメータ

    パラメータ

    タイプ

    必須

    例

    説明

    Action

    String

    はい

    CreateDBInstance

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

    RegionId

    String

    はい

    cn-hangzhou

    インスタンスのリージョン ID。DescribeRegions 操作を呼び出して、最新のリージョンリストをクエリできます。

    ClientToken

    String

    いいえ

    ETnLKlblzczshOTUbOCz****

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

    ZoneId

    String

    いいえ

    cn-hangzhou-g

    インスタンスのゾーン ID。DescribeRegions 操作を呼び出して、最新のゾーンリストをクエリできます。

    Engine

    String

    はい

    MongoDB

    インスタンスのエンジン。値は MongoDB に設定されます。

    EngineVersion

    String

    はい

    4.4

    インスタンスのエンジンバージョン。有効な値：

    • 6.0

    • 5.0

    • 4.4

    • 4.2

    • 4.0

    説明

    インスタンスをクローンするためにこの操作を呼び出す場合は、ソースインスタンスのエンジンに値を設定します。

    DBInstanceClass

    String

    はい

    dds.mongo.standard

    インスタンスタイプ。DescribeAvailableResource 操作を呼び出して、インスタンスタイプを表示することもできます。

    DBInstanceStorage

    Integer

    はい

    10

    インスタンスのストレージ容量。単位：GB。

    このパラメータに指定できる値は、インスタンスタイプによって異なります。詳細については、「レプリカセットインスタンスタイプ」をご参照ください。

    DBInstanceDescription

    String

    いいえ

    test

    インスタンスの名前。有効な値：

    • 名前は文字で始まる必要があります。

    • 名前には、数字、文字、アンダースコア（_）、およびハイフン（-）を含めることができます。

    • 名前の長さは 2 ～ 256 文字である必要があります。

    SecurityIPList

    String

    いいえ

    192.168.xx.xx,192.168.xx.xx

    IP アドレスホワイトリスト内の IP アドレス。複数の IP アドレスはコンマ（,）で区切ります。 IP アドレスホワイトリスト内の各 IP アドレスは一意である必要があります。次のタイプの IP アドレスがサポートされています。

    • 0.0.0.0/0

    • 10.23.12.24 などの IP アドレス。

    • 10.23.12.0/24 などのクラスレスドメイン間ルーティング（CIDR）ブロック。この場合、/24 は各 IP アドレスのプレフィックスの長さが 24 ビットであることを示します。 24 は 1 ～ 32 の範囲内の値に置き換えることができます。

      説明

      • インスタンスごとに最大 1,000 の IP アドレスと CIDR ブロックを構成できます。

      • 0.0.0.0/0 と入力すると、すべての IP アドレスがインスタンスにアクセスできます。これにより、インスタンスにセキュリティリスクが生じる可能性があります。

    AccountPassword

    String

    いいえ

    123456Aa

    ルートアカウントのパスワード。パスワードは次の要件を満たしている必要があります。

    • パスワードには、大文字、小文字、数字、特殊文字の少なくとも 3 つの文字タイプが含まれている必要があります。

    • これらの特殊文字には、! # $ % ^ & * ( ) _ + - = が含まれます。

    • パスワードの長さは 8 ～ 32 文字である必要があります。

    ChargeType

    String

    いいえ

    PrePaid

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

    • PostPaid：従量課金

    • PrePaid：サブスクリプション

    説明

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

    Period

    Integer

    いいえ

    1

    インスタンスのサブスクリプション期間。単位：月。

    有効な値：1 ～ 9、12、24、36、60。

    説明

    ChargeType プロパティを PrePaid に設定する場合は、このプロパティを構成する必要があります。

    NetworkType

    String

    いいえ

    VPC

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

    VPC

    VpcId

    String

    はい

    vpc-bp175iuvg8nxqraf2****

    インスタンスの VPC ID。

    VSwitchId

    String

    はい

    vsw-bp1gzt31twhlo0sa5****

    インスタンスの vSwitch ID。

    SrcDBInstanceId

    String

    いいえ

    dds-bp1ee12ad351****

    ソースインスタンスの ID。

    説明

    このパラメータは、インスタンスをクローンするためにこの操作が呼び出された場合にのみ指定できます。BackupId パラメータまたは RestoreTime パラメータも指定する必要があります。

    BackupId

    String

    いいえ

    32994****

    バックアップセットの ID。DescribeBackups 操作を呼び出して、バックアップセット ID をクエリできます。

    説明

    このパラメータは、インスタンスをクローンするためにこの操作を呼び出す場合にのみ必須です。このパラメータを指定する場合は、SrcDBInstanceId パラメータも指定する必要があります。

    RestoreTime

    String

    いいえ

    2022-03-13T12:11:14Z

    インスタンスのクローン作成日時。7 日以内である必要があります。yyyy-MM-ddTHH:mm:ssZ 形式で時間を指定します。時間は UTC である必要があります。

    説明

    このパラメータは、インスタンスをクローンするためにこの操作を呼び出す場合にのみ必須です。このパラメータを指定する場合は、SrcDBInstanceId パラメータも指定する必要があります。

    BusinessInfo

    String

    いいえ

    {“ActivityId":"000000000"}

    ビジネス情報。これは追加パラメータです。

    AutoRenew

    String

    いいえ

    true

    インスタンスの自動更新を有効にするかどうかを指定します。デフォルト値：false。有効な値：

    • true

    • false

    説明

    ChargeType パラメータを PrePaid に設定する場合は、このオプションパラメータを構成する必要があります。

    DatabaseNames

    String

    いいえ

    mongodbtest

    データベースの名前。

    説明

    インスタンスをクローンするためにこの操作を呼び出すと、クローン作成用にこのパラメータで指定されたデータベースを設定できます。そうでない場合、インスタンスのすべてのデータベースがクローンされます。

    CouponNo

    String

    いいえ

    youhuiquan_promotion_option_id_for_blank

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

    StorageEngine

    String

    いいえ

    WiredTiger

    インスタンスのストレージエンジン。デフォルト値：WiredTiger。

    説明

    • インスタンスをクローンするためにこの操作を呼び出す場合は、ソースインスタンスのエンジンに値を設定します。

    • データベースバージョンとストレージエンジンの制限の詳細については、「MongoDB のバージョンとストレージエンジン」をご参照ください。

    ReplicationFactor

    String

    いいえ

    3

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

    • 3

    • 5

    • 7

    ReadonlyReplicas

    String

    いいえ

    0

    レプリカセットインスタンスの 読み取り専用ノード 数。デフォルト値：0。有効な値：0 ～ 5。

    StorageType

    String

    いいえ

    cloud_essd

    インスタンスのストレージタイプ。有効な値：

    • cloud_essd：拡張 SSD（ESSD）

    • local_ssd：ローカル SSD

    レスポンスパラメータ

    パラメータ

    タイプ

    例

    説明

    RequestId

    String

    D8F1D721-6439-4257-A89C-F1E8E9C9****

    リクエストの ID。

    DBInstanceId

    String

    dds-bp144a7f2db8****

    インスタンス ID。

    OrderId

    String

    21077576248****

    注文の ID。

    例

    リクエストの例

    http(s)://mongodb.aliyuncs.com/?Action=CreateDBInstance
&RegionId=cn-hangzhou
&ClientToken=ETnLKlblzczshOTUbOCz****
&ZoneId=cn-hangzhou-g
&Engine=MongoDB
&EngineVersion=4.4
&DBInstanceClass=dds.mongo.standard
&DBInstanceStorage=10
&DBInstanceDescription=test
&SecurityIPList=192.168.xx.xx,192.168.xx.xx
&AccountPassword=123456Aa
&ChargeType=PrePaid
&Period=1
&NetworkType=VPC
&VpcId=vpc-bp175iuvg8nxqraf2****
&VSwitchId=vsw-bp1gzt31twhlo0sa5****
&BusinessInfo={“ActivityId":"000000000"}
&AutoRenew=true
&CouponNo=youhuiquan_promotion_option_id_for_blank
&StorageEngine=WiredTiger
&ReplicationFactor=3
&ReadonlyReplicas=0
&StorageType=cloud_essd
&SecondaryZoneId=cn-hangzhou-h
&HiddenZoneId=cn-hangzhou-i
&共通リクエストパラメータ

    成功レスポンスの例

    XML 形式

    HTTP/1.1 200 OK
Content-Type:application/xml

<CreateDBInstanceResponse>
    <RequestId>D8F1D721-6439-4257-A89C-F1E8E9C9****</RequestId>
    <DBInstanceId>dds-bp144a7f2db8****</DBInstanceId>
    <OrderId>21077576248****</OrderId>
</CreateDBInstanceResponse>

    JSON 形式

    HTTP/1.1 200 OK
Content-Type:application/json

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

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明

    400

    InvalidDBInstanceDescription.Malformed

    Specified parameter DBInstanceDescription is not valid.

    ノード名が不正なため返されたエラーメッセージ。

    400

    InsufficientBalance

    Your account does not have enough balance.

    支払いが失敗したため返されたエラーメッセージ。別の支払い方法を追加するか、アカウントに資金を追加してから、もう一度お試しください。

    400

    InvalidCapacity.NotFound

    The Capacity provided does not exist in our records.

    インスタンスに指定されたストレージ容量が無効なため返されたエラーメッセージ。有効な値の範囲内の値を指定してください。単位：MB。

    400

    IdempotentParameterMismatch

    Request uses a client token in a previous request but is not identical to that request.

    指定された ClientToken パラメータがすでに使用されているため返されたエラーメッセージ。使用されていない値を指定してください。クライアントを使用して値を生成できますが、異なるリクエスト間で一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。

    403

    RealNameAuthenticationError

    Your account has not passed the real-name authentication yet.

    Alibaba Cloud アカウントの実名認証が完了していないため返されたエラーメッセージ。実名認証を完了してから、もう一度お試しください。

    403

    IncorrectBackupSetState

    Current backup set state does not support operations.

    最新のバックアップセットの準備ができていないため返されたエラーメッセージ。後でもう一度お試しください。

    エラーコードのリストについては、「API エラーセンター」をご参照ください。