すべてのプロダクト
Search

このプロダクト

    ApsaraDB for MongoDB:CreateShardingDBInstance

    ドキュメントセンター

    ApsaraDB for MongoDB:CreateShardingDBInstance

    最終更新日:Sep 23, 2026

    ApsaraDB for 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

    *インスタンス。

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

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

    cn-hangzhou
    ZoneId

    string

    任意

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

    cn-hangzhou-g
    Engine

    string

    必須

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

    列挙値:

    • MongoDB :

      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 アドレスは重複できません。次の 3 つのフォーマットがサポートされています。

    • 0.0.0.0/0

    • IP アドレス (例: 10.23.12.24)。

    • CIDR ブロック (例: 10.23.12.0/24。24 は IP アドレスのプレフィックスの長さを示し、値の範囲は 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
    ChargeType

    string

    任意

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

    • PostPaid: 従量課金。デフォルト値です。

    • PrePaid: サブスクリプション。

    説明

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

    列挙値:

    • PostPaid :

      従量課金。

    • PrePaid :

      サブスクリプション。

    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 :

      MongoDB プロトコル。

    • dynamodb :

      DynamoDB プロトコル。

    mongodb
    Mongos

    array<object>

    必須

    Mongos ノードに関する情報。

    object

    必須

    Mongos ノードに関する情報。

    Class

    string

    必須

    Mongos ノードの仕様。詳細については、「シャードクラスターインスタンスの仕様」を参照してください。

    説明

    • パラメーター名の N は、Mongos ノードのシーケンス番号を指定します。たとえば、Mongos.2.Class は 2 番目の Mongos ノードの仕様を指定します。

    • N の有効な値: 2～32。

    mdb.シャード.2x.xlarge.d
    ReplicaSet

    array<object>

    必須

    シャードノードに関する情報。

    object

    任意

    シャードノードに関する情報。

    Class

    string

    必須

    シャードノードの仕様。詳細については、「シャードクラスターインスタンスの仕様」を参照してください。

    説明

    • パラメーター名の N は、シャードノードのシーケンス番号を指定します。たとえば、ReplicaSet.2.Class は 2 番目のシャードノードの仕様を指定します。

    • N の有効な値: 2～32。

    dds.シャード.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 vCPU、8 GB メモリ (専用)。この値は、バージョン 4.4 以降を実行するインスタンスでのみサポートされています。

    • dds.cs.mid: 1 vCPU、2 GB メモリ (汎用)。この値は、バージョン 4.2 以前を実行するインスタンスでのみサポートされています。

    mdb.シャード.2x.xlarge.d
    Storage

    integer

    必須

    ConfigServer ノードのストレージ容量。単位: GB。

    説明

    有効な値はインスタンスの仕様によって異なります。詳細については、「シャードクラスターインスタンスの仕様」を参照してください。

    20
    SecondaryZoneId

    string

    任意

    リソースグループの ID。詳細については、「リソースグループの基本情報の表示」を参照してください。

    rg-acfmyiu4ekp****
    HiddenZoneId

    string

    任意

    マルチゾーン Deployment のセカンダリゾーン 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 の値と同じにすることはできません。

    • シャードクラスターインスタンスのマルチゾーン Deployment 戦略の詳細については、「マルチゾーンシャードクラスターインスタンスの作成」を参照してください。

    cn-hangzhou-h
    StorageType

    string

    任意

    マルチゾーン Deployment のセカンダリゾーン 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 の値と同じにすることはできません。

    • シャードクラスターインスタンスのマルチゾーン Deployment 戦略の詳細については、「マルチゾーンシャードクラスターインスタンスの作成」を参照してください。

    cn-hangzhou-i
    GlobalSecurityGroupIds

    string

    任意

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

    • cloud_essd1: PL1 ESSD。

    • cloud_essd2: PL2 ESSD。

    • cloud_essd3: PL3 ESSD。

    • local_ssd: ローカル SSD。

    説明

    • バージョン 4.4 以降を実行するインスタンスはクラウドディスクのみをサポートしています。このパラメーターを指定しない場合、デフォルトで cloud_essd1 が使用されます。

    • バージョン 4.2 以前を実行するインスタンスはローカルディスクのみをサポートしています。このパラメーターを指定しない場合、デフォルトで local_ssd が使用されます。

    cloud_essd1
    Tag

    array<object>

    任意

    インスタンスのグローバル IP アドレスホワイトリストテンプレート。複数のテンプレートはコンマ (,) で区切ります。テンプレートは重複できません。

    g-qxieqf40xjst1ngpr3jz

    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

    任意

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

    true
    ProvisionedIops

    integer

    任意

    カスタム暗号鍵の ID。

    2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    SrcRegion

    string

    任意

    プロビジョニングされた IOPS。

    1960
    BackupId

    string

    任意

    ソースインスタンスが存在するリージョン。

    説明

    • このパラメーターは、バックアップ回復タイプが削除されたインスタンスの再構築である場合に必須です。

    • このパラメーターは、バックアップ回復タイプが地理的冗長バックアップからのクローン作成である場合に必須です。

    cn-beijing
    RestoreType

    string

    任意

    クラスターバックアップの ID。

    説明

    このパラメーターは、RestoreType が 2 または 3 に設定されている場合にのみ必須です。

    cb-xxx
    DestRegion

    string

    任意

    バックアップ回復タイプ。有効な値:

    • 1: インスタンスを指定されたポイントイン時間に回復します。

    • 2: 指定されたバックアップセットからリリースされたインスタンスを回復します。

    • 3: 指定された地理的冗長バックアップセットからインスタンスを回復します。

    1

    レスポンスフィールド

    フィールド

    型

    説明

    例

    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'. 指定された解凍タイプのインスタンスはサポートされていません。RestoreType、BackupID、および RestoreTime 入力パラメーターを確認してください。
    500 VpcServiceError Invoke vpc service error. VPC サービスの呼び出し時にエラーが発生しました。
    403 InvalidBackupLogStatus Current backup log enable status does not support this operation.
    403 ReduceDiskNotSupport Reduce disk size is not supported in clone/restore. インスタンスクローニングまたは復元では、クラウドディスク領域の縮小はサポートされていません。

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

    変更履歴

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