Tair (Redis® OSS-Compatible):CreateTairInstance

インスタンスを作成するリージョンの ID です。利用可能なリージョンは、DescribeRegions オペレーションを呼び出して確認できます。

インスタンス名です。インスタンス名は次の要件を満たす必要があります。

• 長さは 2～80 文字である必要があります。

• 先頭文字は大文字、小文字、または漢字である必要があります。スペースおよび次の特殊文字は使用できません：@/:=”<>{[]}。

インスタンスのパスワードです。パスワードは次の要件を満たす必要があります。

• 長さは 8～32 文字である必要があります。

• 大文字、小文字、数字、特殊文字のうち、少なくとも 3 種類を含む必要があります。サポートされる特殊文字は !@#$%^&*()_+-= です。

インスタンスタイプです。詳細については、次のトピックをご参照ください。

• メモリ強化インスタンスタイプ

• 永続メモリ最適化インスタンスタイプ

• ディスクベースインスタンスタイプ

インスタンスを作成するプライマリゾーンの ID です。利用可能なゾーンは、DescribeRegions オペレーションを呼び出して確認できます。

セカンダリゾーンの ID です。利用可能なゾーンは、DescribeRegions オペレーションを呼び出して確認できます。

インスタンスの課金方法です。有効な値は次のとおりです。

• PrePaid (デフォルト)：サブスクリプション課金方法。

• PostPaid：従量課金方法。

インスタンスを作成する Virtual Private Cloud (VPC) の ID です。利用可能な VPC は、DescribeVpcs オペレーションを呼び出して確認できます。

指定された VPC 内の vSwitch の ID です。vSwitch ID は、VPC API オペレーション DescribeVSwitches を呼び出して取得できます。

サブスクリプション期間 (月単位) です。有効な値は 1、2、3、4、5、6、7、8、9、12、24、36、および 60 です。

ビジネス情報です。これはプロモーション ID またはビジネスコンテキストを指定できます。

クーポンコードです。

既存のインスタンスのバックアップセットからインスタンスを作成する場合は、ソースインスタンスの ID を指定します。

ソースインスタンスのバックアップセットの ID です。システムはこのバックアップセットのデータに基づいて新しいインスタンスを作成します。DescribeBackups オペレーションを呼び出してバックアップセット ID を確認できます。ソースインスタンスがクラスターインスタンスの場合、各シャードのバックアップ ID をカンマ区切りで指定する必要があります (例： "10**,11**,15**")。

クラスターバックアップセットの ID です。クラスターアーキテクチャを使用する一部のインスタンスは、クラスターバックアップセットをサポートしています。DescribeClusterBackupList オペレーションを呼び出してクラスターバックアップセット ID を確認できます。

• この機能がサポートされている場合、このパラメーターを指定して BackupId パラメーターを空のままにできます。

• この機能がサポートされていない場合、BackupId パラメーターにソースインスタンスの各シャードのバックアップ ID をカンマ区切りで指定する必要があります (例： "2158****20,2158****22")。

バックアップセットからインスタンスを作成する際に、ソースバックアップセットからアカウント情報 (account)、カーネルパラメータ (config)、ホワイトリスト (whitelist) などの構成を復元するかどうかを指定します。特定の構成を復元するには、そのキーワードを指定します。複数の構成を復元するには、キーワードをカンマで区切ります。

このパラメーターを指定しない場合、ソースバックアップセットから構成は復元されません。

インスタンスのプライベート IP アドレスです。

クーポンを使用するかどうかを指定します。有効な値は次のとおりです。

• true：クーポンを使用します。

• false (デフォルト)：クーポンを使用しません。

インスタンスの自動更新を有効にするかどうかを指定します。有効な値は次のとおりです。

• true：自動更新を有効にします。

• false (デフォルト)：自動更新を無効にします。

自動更新期間 (単位：月) です。有効な値は 1、2、3、6、および 12 です。

インスタンスが属するリソースグループの ID です。

自動支払いを有効にするかどうかを指定します。値を true に設定してください。

リクエストのべき等性を保証するクライアント生成トークンです。トークンは異なるリクエスト間で一意である必要があります。大文字と小文字は区別され、長さは 64 文字以内の ASCII 文字である必要があります。

ストレージタイプです。有効な値は essd_pl1、essd_pl2、および essd_pl3 です。

ディスクベースインスタンスのストレージ容量です。このパラメーターの有効な値はインスタンスタイプによって異なります。詳細については、「ディスクベースインスタンスタイプ」をご参照ください。

インスタンスのアーキテクチャタイプです。有効な値は次のとおりです。

• MASTER_SLAVE (デフォルト)：高可用性を提供するプライマリ/レプリカアーキテクチャ。

• STAND_ALONE：シングルレプリカ。このアーキテクチャはシングルノードを使用します。ノードが障害になるとデータが失われ、システムは自動的に新しい空のインスタンスを作成します。このアーキテクチャはシングルゾーンデプロイメントでのみサポートされ、クラスターまたは読み書き分離アーキテクチャはサポートしません。

インスタンスのシャード数です。有効な値は次のとおりです。

• 1 (デフォルト)：シャードが 1 つの標準アーキテクチャインスタンスを作成します。

• 2 ～ 32：指定されたシャード数を持つクラスターアーキテクチャインスタンスを作成します。

プライマリゾーン内のレプリカノード数です。このパラメーターはクラウドネイティブのマルチレプリカクラスターインスタンスにのみ適用されます。このパラメーターを使用してレプリカノード数をカスタマイズできます。有効な値は 1～4 です。

セカンダリゾーン内のレプリカノード数です。

プライマリゾーン内の読み取り専用ノード数です。このパラメーターは読み書き分離アーキテクチャを使用するクラウドネイティブインスタンスにのみ適用されます。

• インスタンスが標準アーキテクチャを使用する場合、有効な値は 1～9 です。

• インスタンスがクラスターアーキテクチャを使用する場合、シャードごとの読み取り専用ノード数を指定します。有効な値は 1～4 です。

セカンダリゾーン内の読み取り専用ノード数です。

データベースバージョンです。デフォルト値は 1.0 です。有効な値は Tair インスタンスシリーズによって異なります。

• tair_rdb：Tair メモリ強化インスタンスは Redis 5.0、Redis 6.0、および Redis 7.0 と互換性があります。値を 5.0、6.0、または 7.0 に設定します。

• tair_scm：Tair 永続メモリ最適化インスタンスは Redis 6.0 と互換性があります。値を 1.0 に設定します。

• tair_essd：Tair ディスクベースインスタンス (ESSD/SSD) は Redis 6.0 と互換性があります。ESSD ベースのインスタンスを作成する場合は値を 1.0 に、SSD ベースのインスタンスを作成する場合は値を 2.0 に設定します。

Tair インスタンスシリーズで、記憶媒体を決定します。有効な値は次のとおりです。

• tair_rdb：メモリ強化

• tair_scm：永続メモリ最適化

• tair_essd：ディスクベース

分散インスタンスのサブインスタンスとしてインスタンスを作成するかどうかを指定します。このパラメーターを使用して分散インスタンスを作成できます。

• 最初のサブインスタンスを作成する場合、このパラメーターを true に設定します。

• 2 番目または 3 番目のサブインスタンスを作成する場合、分散インスタンスの ID (例： gr-bp14rkqrhac****) を指定します。

• 分散インスタンスを作成しない場合、このパラメーターを指定しないでください。

このリクエストに対して事前チェックを実行するかどうかを指定します。有効な値は次のとおりです。

• true：事前チェックを実行し、インスタンスは作成しません。システムはリクエストパラメーター、リクエストフォーマット、サービス制限、および在庫をチェックします。リクエストが事前チェックに失敗した場合、エラーメッセージが返されます。リクエストが事前チェックに合格した場合、DryRunOperation エラーコードが返されます。

• false (デフォルト)：通常のリクエストを送信し、事前チェックに合格した後にインスタンスを作成します。

インスタンスのサービスポートです。有効な値は 1～65535 です。デフォルト値は 6379 です。

インスタンスのグローバル IP ホワイトリストテンプレートの ID です。複数のテンプレート ID を指定する場合は、カンマで区切ります。ID を重複させることはできません。

パラメータテンプレートの ID です。インスタンスはこのテンプレートで定義されたパラメーターを使用して作成されます。

ソースインスタンスでポイントインタイムリカバリ (PITR) が有効になっている場合、バックアップ保持期間内の任意の時点を指定できます。システムはその時点のソースインスタンスのバックアップデータを使用して新しいインスタンスを作成します。時刻は yyyy-MM-ddTHH:mm:ssZ 形式 (UTC) で指定します。

接続文字列のプレフィックスです。先頭は小文字で始まり、小文字と数字で構成され、長さは 8～40 文字である必要があります。

読み書き分離アーキテクチャを使用するクラウドネイティブのデュアルゾーンインスタンスを作成する際に使用する接続文字列のタイプです。このパラメーターを指定しない場合、デフォルト値 AzIndependentEndpoint が使用されます。

• AzIndependentEndpoint (デフォルト)：ゾーン固有の接続文字列。プライマリゾーンとセカンダリゾーンそれぞれに独立した接続文字列が提供され、クライアントは最も近いゾーンに接続できます。

• UnifiedEndpoint：統一接続文字列。プライマリゾーンとセカンダリゾーンの両方のノードにアクセスできる単一の接続文字列が提供されますが、ゾーン間アクセスが発生する可能性があります。

メンテナンスウィンドウの開始時刻です。時刻は HH:mmZ 形式 (UTC) で指定します。たとえば、01:00 (UTC + 08:00) にメンテナンスを開始する場合、このパラメーターを 17:00Z に設定します。

メンテナンスウィンドウの終了時刻です。時刻は HH:mmZ 形式 (UTC) で指定します。たとえば、02:00 (UTC + 08:00) にメンテナンスを終了する場合、このパラメーターを 18:00Z に設定します。