この API を呼び出して、ApsaraDB for MongoDB シャードクラスターインスタンスを作成または複製できます。

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

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

レプリカセットインスタンスを作成するには、 CreateDBInstance を呼び出します。

デバッグ

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

リクエストパラメータ

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

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

Engine String はい MongoDB

データベースエンジン。 有効値：MongoDB 。

EngineVersion String はい 4.0

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

注
  • データベースのバージョンとストレージエンジンの制限の詳細は、バージョンとストレージエンジン をご参照ください。
  • この API を呼び出してインスタンスを複製する場合、この値がソースインスタンスのエンジンバージョン番号と同じであることが必要です。
AccountPassword String はい Alitest! 159

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

  • パスワードには、大文字、小文字、数字、特殊文字の少なくとも 3 種類の文字が含まれている必要があります。 特殊文字： #$%^&*()_+-=
  • パスワードの長さは 8~32 文字である必要があります。
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アドレスの形式は、％、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 アドレスがデータベースにアクセスできることを示します。 セキュリティ上の原因で、ホワイトリストにこれらの値を含めることはお勧めしません。
ChargeType String いいえ PrePaid

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

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

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

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

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

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

インスタンスのネットワークタイプ。 インスタンスを作成すると、デフォルトでクラシックネットワークが指定されます。

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

VPC の ID。

注 このパラメーターは、 NetworkType パラメーターを VPC に指定した場合にのみ有効です。
Mongos.N.Class String いいえ dds.mongos.standard

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

N は、仕様が指定されている mongos のシーケンスを示します。 たとえば、

  • Mongos. 1.Class 最初の Mongos の仕様を指定します。
  • Mongos. 2.Class 2 番目の mongos の仕様を指定します。
注 2~32 個の mongos を指定できます。
ReplicaSet.N.Class String いいえ dds.shard.standard

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

N は、仕様が指定されている shard のシーケンスを示します。 たとえば、

  • ReplicaSet. 1.Class最初の shard の仕様を指定します。
  • ReplicaSet. 2.Classは、2 番目の shard の仕様を指定します。
注 2~32個の shard を指定できます。
ReplicaSet.N.Storage Integer いいえ 20

shard N のストレージスペース。

  • 有効値： 10 ~ 2000。 単位 : GB
  • この値は、最小 10 GB/回で指定する必要があります。
注 このパラメーターに指定できる値は、インスタンスの仕様によって異なります。 詳細は、インスタンス仕様 をご参照ください。

N は、ストレージスペースが指定されている shard のシーケンスを示します。 たとえば、

  • ReplicaSet. 1.Storage 最初の shard のストレージスペースを指定します。
  • ReplicaSet. 2.Storage 2 番目の shard のストレージスペースを指定します。
ConfigServer.N.Class String いいえ dds.cs.mid

Configserver N の指定。有効値： dds.cs.mid。

注 Configserver の仕様は、1 コアと 2 GB メモリーに固定されています。 N の値は 1 に固定されています。 たとえば、ConfigServer.1.Class パラメータの値を ddds.cs.mid に設定します。
ConfigServer.N.Storage Integer いいえ 20

ConfigServer N のストレージスペース。有効値： 20。

注 このパラメーターは 20 GB にのみ指定できます。 たとえば、 ConfigServer.1.Storage の値を 20 に設定します。
VSwitchId String いいえ vsw-bpxxxxxxxx

VSwitch の ID。

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

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

RestoreTime String いいえ 2019-03-08T02:30:25Z

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

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

注 過去 7 日間の任意の復元時刻にインスタンスを複製できます。
StorageEngine String いいえ WiredTiger

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

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

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

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

デフォルト値：false

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

Alibaba Cloud から提供された AccessKey ID。
ClientToken String いいえ ETnLKlblzczshOTUbOCzxxxxxxxxxx

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

レスポンスパラメータ

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

インスタンス ID。
OrderId String 2033xxxxxxxxxxxx

注文 ID。
RequestId String D8F1D721-6439-4257-A89C-F1E8E9C9623D

リクエスト ID。

例

リクエストの例


http(s)://mongodb.aliyuncs.com/? Action=CreateShardingDBInstance
&Engine=MongoDB
&EngineVersion=4.0
&AccountPassword=Alitest! 159
&ZoneId=cn-hangzhou-b 
&ClientToken=ETnLKlblzczshOTUbOCzxxxxxxxxxx 
&<Common request parameters>

通常のレスポンスの例

XML 形式 

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

JSON 形式 

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

エラーコード

エラーコードの表示