すべてのプロダクト
Search

このプロダクト

    ApsaraDB for MongoDB:CreateDBInstance

    ドキュメントセンター

    ApsaraDB for MongoDB:CreateDBInstance

    最終更新日:Oct 08, 2026

    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

    *インスタンス。

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    リージョン ID。 DescribeRegions 操作を呼び出してリージョン ID を照会できます。

    説明

    この操作を呼び出してインスタンスのクローンを作成する場合、またはゴミ箱からクローンインスタンスを復元する場合は、このパラメーターをソースインスタンスと同じ値に設定します。

    cn-hangzhou
    ClientToken

    string

    任意

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

    ETnLKlblzczshOTUbOCz****
    ZoneId

    string

    任意

    ゾーン ID。 DescribeRegions 操作を呼び出してゾーン ID を取得できます。

    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

    • 10.23.12.24 などの IP アドレス形式。

    • 10.23.12.0/24 などの CIDR ブロック形式。この例では、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 パラメーターも設定する必要があります。

    列挙値:

    • PostPaid :

      従量課金。

    • PrePaid :

      サブスクリプション。

    PrePaid
    NetworkType

    string

    任意

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

    VPC: Virtual Private Cloud。

    列挙値:

    • VPC :

      Virtual Private Cloud。

    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。 DescribeBackups 操作を呼び出してバックアップ ID を照会できます。

    説明

    このパラメーターは、バックアップポイントからクローンインスタンスをクローンするためにこの操作を呼び出す場合にのみ必須です。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 :

      WiredTiger ストレージエンジン。

    WiredTiger
    ReplicationFactor

    string

    任意

    レプリカセットインスタンス内のプライマリノードとセカンダリノードの数。有効な値:

    • 3 (デフォルト)

    • 5

    • 7

    重要 このパラメーターはシングルノードインスタンスには必須ではありません。

    3
    ReadonlyReplicas

    string

    任意

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

    0
    Engine

    string

    任意

    リソースグループ ID。

    列挙値:

    • MongoDB :

      MongoDB データベースエンジン。

    rg-acfmyiu4ekp****
    StorageType

    string

    任意

    専用クラスターの ID。

    dhg-2x78****
    SecondaryZoneId

    string

    任意

    データベースエンジン。値は MongoDB に固定されています。

    MongoDB
    HiddenZoneId

    string

    任意

    ストレージタイプ。有効な値:

    • cloud_essd1: PL1 ESSD。

    • cloud_essd2: PL2 ESSD。

    • cloud_essd3: PL3 ESSD。

    • cloud_auto: ESSD AutoPL ディスク。

    • local_ssd: ローカル SSD。

    説明

    • シングルノードインスタンスの場合、cloud_essd1 を指定すると、インスタンスは cloud_essd ディスクを使用します。

    • ESSD AutoPL ディスクは、現在中国サイトでのみ利用可能です。

    • バージョン 4.4 以降を実行中のインスタンスの場合、デフォルト値は cloud_essd1 です。

    • バージョン 4.2 以前を実行中のインスタンスの場合、デフォルト値は local_ssd です。

    cloud_essd1
    Tag

    array<object>

    任意

    マルチゾーン Deployment を実装するためにセカンダリノードがデプロイされるゾーン。有効な値:

    • 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

    object

    任意

    Key

    string

    任意

    タグのキー。

    説明

    N はタグの番号を指定します。たとえば、Tag.1.Key は 1 番目のタグのキーを指定し、Tag.2.Key は 2 番目のタグのキーを指定します。

    testデータベース
    Value

    string

    任意

    タグの値。

    説明

    N はタグの番号を指定します。たとえば、Tag.1.Value は 1 番目のタグの値を指定し、Tag.2.Value は 2 番目のタグの値を指定します。

    apitest
    GlobalSecurityGroupIds

    string

    任意

    マルチゾーン Deployment を実装するために非表示ノードがデプロイされるゾーン。有効な値:

    • 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
    Encrypted

    boolean

    任意

    ユーザー定義タグ。

    true
    EncryptionKey

    string

    任意

    インスタンスのグローバル IP ホワイトリストテンプレート。複数のテンプレートはコンマ (,) で区切ります。重複するテンプレートは使用できません。(この特徴はカナリアリリース中です。)

    g-qxieqf40xjst1ngpr3jz

    ProvisionedIops

    integer

    任意

    ディスク暗号化を有効にするかどうかを指定します。

    true
    RestoreType

    string

    任意

    カスタムキー ID。

    2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    SrcRegion

    string

    任意

    プロビジョンドパフォーマンス (IOPS)。有効な値: 0～50000。

    1960

    レスポンスフィールド

    フィールド

    型

    説明

    例

    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. Storage、Version、または InstanceClass パラメーターが空です。
    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. プライマリゾーン、セカンダリゾーン 1、およびセカンダリゾーン 2 のパラメーターをすべて同じにすることはできません。
    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.

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

    変更履歴

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