クラウドネイティブ Tair (Enhanced エディション) インスタンスを作成します。
操作説明
インスタンスの選択については、「ApsaraDB for Tair (Redis® OSS-Compatible) 選択ガイド」をご参照ください。
この操作の呼び出し前に、ApsaraDB for Tair (Redis® OSS-Compatible) の課金方法と料金を十分に理解していることをご確認ください。
コンソールでこの操作を実行する方法については、「Tair インスタンスの作成」をご参照ください。
オープンソースや Tair メモリ最適化 クラシックインスタンスなど、他のタイプのインスタンスを作成するには、 CreateInstance 操作を呼び出します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
kvstore:CreateTairInstance |
create |
*DBInstance
|
|
なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
必須 |
リージョン ID。 DescribeRegions を呼び出して、利用可能なリージョンを照会できます。このパラメーターを使用して、インスタンスを作成するリージョンを指定します。 |
cn-hangzhou |
| InstanceName |
string |
任意 |
インスタンス名。名前は以下の要件を満たす必要があります。
|
apitest |
| Password |
string |
任意 |
インスタンスのパスワード。パスワードは以下の要件を満たす必要があります。
|
Pass!123456 |
| InstanceClass |
string |
必須 |
インスタンスタイプ。詳細については、以下をご参照ください。 |
tair.scm.standard.4m.32d |
| ZoneId |
string |
任意 |
プライマリゾーンの ID。 DescribeRegions を呼び出して、利用可能なゾーンを照会できます。このパラメーターを使用して、インスタンスを作成するゾーンを指定します。 説明
SecondaryZoneId パラメーターを指定して、セカンダリゾーンを設定することもできます。プライマリノードとセカンダリノードは、指定されたプライマリゾーンとセカンダリゾーンにデプロイされ、同一都市内のデュアルセンタープライマリ/セカンダリアーキテクチャを実装します。たとえば、ZoneId を cn-hangzhou-h に設定し、SecondaryZoneId を cn-hangzhou-g に設定します。 |
cn-hangzhou-h |
| SecondaryZoneId |
string |
任意 |
セカンダリゾーンの ID。 DescribeRegions を呼び出して、利用可能なゾーンを照会できます。 説明
このパラメーターの値は、ZoneId の値と異なる必要があります。このパラメーターをマルチゾーンの ID に設定することはできません。 |
cn-hangzhou-g |
| ChargeType |
string |
任意 |
課金方法。有効な値:
列挙値:
|
PrePaid |
| VpcId |
string |
必須 |
VPC の ID。VPC の DescribeVpcs 操作を呼び出して、VPC ID を照会できます。 |
vpc-bp1nme44gek34slfc**** |
| VSwitchId |
string |
必須 |
指定された VPC 内の vSwitch ID。VPC の DescribeVpcs 操作を呼び出して、vSwitch ID を照会できます。 |
vsw-bp1e7clcw529l773d**** |
| Period |
integer |
任意 |
サブスクリプション期間。単位: 月。有効な値: 1~9、12、24、36、60。 説明
このパラメーターは、ChargeType が PrePaid に設定されている場合に必須です。 |
1 |
| BusinessInfo |
string |
任意 |
アクティビティ ID およびビジネス情報。 |
000000000 |
| CouponNo |
string |
任意 |
クーポンコード。 |
youhuiquan_promotion_option_id_for_blank |
| SrcDBInstanceId |
string |
任意 |
既存のインスタンスのバックアップセットからインスタンスを作成するには、このパラメーターにソースインスタンス ID を指定します。 説明
次に、BackupId、ClusterBackupId (クラウドネイティブクラスターインスタンスに推奨)、または RestoreTime パラメーターを使用して、バックアップセットまたは時間を指定します。このパラメーターは、前述の 3 つのパラメーターのいずれかと一緒に使用する必要があります。 |
r-bp1zxszhcgatnx**** |
| BackupId |
string |
任意 |
ソースインスタンスのバックアップセット ID。システムは、バックアップセットに保存されているデータを使用してインスタンスを作成します。 DescribeBackups を呼び出して、BackupId を照会できます。ソースインスタンスがクラスターインスタンスの場合、ソースインスタンスのすべてのシャードのバックアップセット ID をカンマ (,) で区切って指定します。例: "10**,11**,15**"。 説明
インスタンスがクラウドネイティブアーキテクチャのクラスターインスタンスである場合、 DescribeClusterBackupList を呼び出して "cb-xx" などのクラスターバックアップセット ID を取得し、ClusterBackupId リクエストパラメーターを指定してクラスターインスタンスをクローンすることをお勧めします。これにより、個々のシャードのバックアップセット ID を指定する必要がなくなります。 |
2158****20 |
| ClusterBackupId |
string |
任意 |
クラスターバックアップセット ID。一部の新しいクラスターアーキテクチャでは、クラスターバックアップセット ID がサポートされています。 DescribeClusterBackupList 操作を呼び出して ID を取得できます。
|
cb-hyxdof5x9kqb**** |
| RecoverConfigMode |
string |
任意 |
指定されたバックアップセットからインスタンスを作成するときに、元のバックアップセットからアカウント、カーネルパラメータ (config)、またはホワイトリスト情報を解凍するかどうかを指定します。たとえば、アカウント情報を解凍するには、このパラメーターを account に設定します。 デフォルト値は空で、アカウント、カーネルパラメータ、およびホワイトリスト情報が元のバックアップセットから解凍されないことを示します。 説明
このパラメーターは、クラウドネイティブインスタンスにのみ適用されます。元のバックアップセットには、アカウント、カーネルパラメータ、またはホワイトリスト情報が含まれている必要があります。 DescribeBackups 操作を呼び出して、指定されたバックアップセットの RecoverConfigMode パラメーターに前述の情報が含まれているかどうかを確認できます。 |
ホワイトリスト,config,アカウント |
| PrivateIpAddress |
string |
任意 |
インスタンスの非公開 IP アドレス。 説明
IP アドレスは、インスタンスが属する vSwitch の CIDR ブロック内である必要があります。VPC の DescribeVSwitches 操作を呼び出して、CIDR ブロック情報を照会できます。 |
172.16.88.*** |
| AutoUseCoupon |
string |
任意 |
クーポンを使用するかどうかを指定します。有効な値:
|
true |
| AutoRenew |
string |
任意 |
自動更新を有効にするかどうかを指定します。有効な値:
|
true |
| AutoRenewPeriod |
string |
任意 |
自動更新期間。単位: 月。有効な値: 1、2、3、6、12。 説明
このパラメーターは、AutoRenew が true に設定されている場合に必須です。 |
3 |
| ResourceGroupId |
string |
任意 |
インスタンスが属するリソースグループの ID。 説明
|
rg-acfmyiu4ekp**** |
| AutoPay |
boolean |
任意 |
自動支払いを有効にするかどうかを指定します。値は true に固定されています。 |
true |
| ClientToken |
string |
任意 |
リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用して値を生成できます。トークンが異なるリクエスト間で一意であることを確認してください。トークンは大文字と小文字が区別され、最大 64 文字の ASCII 文字を含めることができます。 |
ETnLKlblzczshOTUbOCz**** |
| StorageType |
string |
任意 |
ストレージタイプ。有効な値: essd_pl1、essd_pl2、essd_pl3。 説明
このパラメーターは、InstanceType が tair_essd に設定されており、ESSD ベースのインスタンスを作成している場合にのみ必須です。 |
essd_pl1 |
| Storage |
integer |
任意 |
ディスクベースインスタンスのストレージ容量。有効な値はインスタンスタイプによって異なります。詳細については、「ディスクベースインスタンスタイプ」をご参照ください。 説明
このパラメーターは、InstanceType が tair_essd に設定されており、ESSD ベースのインスタンスを作成している場合にのみ必須です。Tair ディスクベース SSD インスタンスの場合、ストレージ容量はインスタンスタイプによって決定される固定値です。このパラメーターを指定する必要はありません。 |
60 |
| ShardType |
string |
任意 |
インスタンスタイプ。有効な値:
|
MASTER_SLAVE |
| ShardCount |
integer |
任意 |
インスタンス内のデータノードの数。有効な値:
説明
このパラメーターを 2~32 の値に設定できるのは、InstanceType が tair_rdb または tair_scm に設定されている場合のみです。クラスターアーキテクチャをサポートするのは、メモリ最適化インスタンスと永続メモリ最適化インスタンスのみです。 |
2 |
| ReplicaCount |
integer |
任意 |
プライマリゾーン内のレプリカノードの数。このパラメーターは、クラウドネイティブクラスターマルチレプリカインスタンスにのみ適用されます。このパラメーターを使用して、レプリカノードの数をカスタマイズできます。有効な値: 1~4。 説明
マルチゾーンインスタンスを作成する場合、このパラメーターを SlaveReplicaCount パラメーターと一緒に使用して、プライマリゾーンとセカンダリゾーンのレプリカノードの数をカスタマイズできます。このパラメーターと SlaveReplicaCount パラメーターの合計は 4 を超えることはできません。 |
2 |
| SlaveReplicaCount |
integer |
任意 |
セカンダリゾーン内のレプリカノードの数。 |
2 |
| ReadOnlyCount |
integer |
任意 |
プライマリゾーン内の読み取り専用ノードの数。このパラメーターは、クラウドネイティブ読み取り/書き込み分離インスタンスにのみ適用されます。
説明
マルチゾーンインスタンスを作成する場合、このパラメーターを SlaveReadOnlyCount パラメーターと一緒に使用して、プライマリゾーンとセカンダリゾーンの読み取り専用ノードの数をカスタマイズできます。
|
5 |
| SlaveReadOnlyCount |
integer |
任意 |
セカンダリゾーン内の読み取り専用ノードの数。 |
1 |
| EngineVersion |
string |
任意 |
データベースエンジンのバージョン。デフォルト値: 1.0。有効な値は Tair プロダクトタイプによって異なります。
|
1.0 |
| InstanceType |
string |
必須 |
記憶媒体。有効な値:
|
tair_scm |
| GlobalInstanceId |
string |
任意 |
新しいインスタンスを分散インスタンスのサブインスタンスとして追加するかどうかを指定します。
説明
分散インスタンスを作成するには、新しいインスタンスは Tair メモリ最適化インスタンスである必要があります。 |
gr-bp14rkqrhac**** |
| Tag |
array<object> |
任意 |
インスタンスのタグ。 |
|
|
object |
任意 |
タグ情報。 |
||
| Key |
string |
任意 |
タグのキー。キーと値が一緒になってタグのキーと値のペアを形成します。 説明
一度に最大 5 つのタグのキーと値のペアを指定できます。 |
key1_test |
| Value |
string |
任意 |
タグの値。 説明
N はタグ値のシーケンス番号を示します。たとえば、Tag.1.Value は最初のタグの値を示し、Tag.2.Value は 2 番目のタグの値を示します。 |
value1_test |
| DryRun |
boolean |
任意 |
このリクエストのドライランを実行するかどうかを指定します。有効な値:
|
false |
| Port |
integer |
任意 |
インスタンスのサービスポート。有効な値: 1~65535。デフォルト値: 6379。 |
6379 |
| GlobalSecurityGroupIds |
string |
任意 |
インスタンスのグローバル IP ホワイトリストテンプレート。複数のテンプレートはカンマ (,) で区切ります。重複する値は許可されていません。 |
g-zsldxfiwjmti0kcm**** |
| ParamGroupId |
string |
任意 |
パラメータテンプレート ID。インスタンスは、指定されたパラメータテンプレート内のパラメーターに基づいて作成されます。重複する値は許可されていません。 |
g-50npzjcqb1ua6q6j**** |
| RestoreTime |
string |
任意 |
ソースインスタンスでデータフラッシュバックが有効になっている場合、ソースインスタンスのバックアップ保持期間内の時間を指定できます。システムは、指定された時間のソースインスタンスのバックアップデータを使用してインスタンスを作成します。時間は yyyy-MM-ddTHH:mm:ssZ フォーマット (協定世界時 (UTC)) で指定します。 |
2021-07-06T07:25:57Z |
| ConnectionStringPrefix |
string |
任意 |
エンドポイントのプレフィックス。プレフィックスは小文字と数字で構成され、小文字で始まり、長さが 8~40 文字である必要があります。 説明
エンドポイントのフォーマットは次のとおりです: <プレフィックス-インスタンス ID>.redis.rds.aliyuncs.com。 |
r-bp1zxszhcgatnx**** |
| InstanceEndpointType |
string |
任意 |
クラウドネイティブデュアルゾーン Deployment 読み取り/書き込み分離インスタンスを作成するときに使用されるエンドポイントのタイプ。このパラメーターが明示的に指定されていない場合、デフォルト値は AzIndependentEndpoint です。
重要 このパラメーターは、クラウドネイティブデュアルゾーン Deployment 読み取り/書き込み分離インスタンスにのみ適用されます。他のインスタンスタイプでは、ゾーン非依存エンドポイントのみがサポートされています。UnifiedEndpoint をコミットしても、設定は効果がありません。 重要 UnifiedEndpoint 値は、ホワイトリスト内のユーザーのみが利用できます。ホワイトリストに登録されていない状態でこの値を呼び出すと、呼び出しは失敗します。アクセスをリクエストするには、チケットを起票してください。 |
AzIndependentEndpoint |
| MaintainStartTime |
string |
任意 |
メンテナンスウィンドウの開始時刻。時間を HH:mmZ フォーマット (協定世界時 (UTC)) で指定します。たとえば、開始時刻を 01:00 (UTC+8) にセットするには、 説明
このパラメーターが指定されていない場合、デフォルト値は 18:00Z (UTC) で、02:00 (UTC+8) になります。 |
|
| MaintainEndTime |
string |
任意 |
メンテナンスウィンドウの終了時刻。時間を HH:mmZ フォーマット (協定世界時 (UTC)) で指定します。たとえば、終了時刻を 02:00 (UTC+8) にセットするには、 説明
開始時刻と終了時刻の間隔は 1 時間以上である必要があります。 説明
このパラメーターが指定されていない場合、デフォルト値は 22:00Z (UTC) で、06:00 (UTC+8) になります。 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答オブジェクト。 |
||
| Bandwidth |
integer |
インスタンスの帯域幅の最大値。単位: MB/s。 |
96 |
| ChargeType |
string |
インスタンスの課金方法。有効な値:
|
PrePaid |
| Config |
string |
インスタンスの詳細設定。値は JSON 文字列です。パラメーターの詳細については、「パラメータ設定」をご参照ください。 |
{"EvictionPolicy":"volatile-lru","hash-max-ziplist-entries":512,"zset-max-ziplist-entries":128,"list-max-ziplist-entries":512,"list-max-ziplist-value":64,"zset-max-ziplist-value":64,"set-max-intset-entries":512,"hash-max-ziplist-value":64} |
| ConnectionDomain |
string |
インスタンスの内部ネットワークエンドポイント。 |
r-bp13ac3d047b****.tairpena.rds.aliyuncs.com |
| Connections |
integer |
インスタンスの接続数の最大値。 |
10000 |
| InstanceId |
string |
インスタンス ID。 |
r-bp13ac3d047b**** |
| InstanceName |
string |
インスタンス名。 説明
このパラメーターは、InstanceName リクエストパラメーターが指定されている場合にのみ返されます。 |
redistest |
| InstanceStatus |
string |
インスタンスの現在のステータス。戻り値は Creating に固定されています。 |
Creating |
| OrderId |
integer |
注文 ID。 |
2084452111111 |
| Port |
integer |
インスタンスのポート番号。 |
6379 |
| QPS |
integer |
1 秒あたりの読み取りおよび書き込み操作の最大値。単位: 操作/秒。これは、現在のインスタンスタイプの理論値です。 |
100000 |
| RegionId |
string |
リージョン ID。 |
cn-hangzhou |
| RequestId |
string |
リクエスト ID。 |
12123216-4B00-4378-BE4B-08005BFC**** |
| TaskId |
string |
タスク ID。 |
10**** |
| ZoneId |
string |
ゾーン ID。 |
cn-hangzhou-h |
例
成功レスポンス
JSONJSON
{
"Bandwidth": 96,
"ChargeType": "PrePaid",
"Config": "{\\\"EvictionPolicy\\\":\\\"volatile-lru\\\",\\\"hash-max-ziplist-entries\\\":512,\\\"zset-max-ziplist-entries\\\":128,\\\"list-max-ziplist-entries\\\":512,\\\"list-max-ziplist-value\\\":64,\\\"zset-max-ziplist-value\\\":64,\\\"set-max-intset-entries\\\":512,\\\"hash-max-ziplist-value\\\":64}",
"ConnectionDomain": "r-bp13ac3d047b****.tairpena.rds.aliyuncs.com",
"Connections": 10000,
"InstanceId": "r-bp13ac3d047b****",
"InstanceName": "redistest",
"InstanceStatus": "Creating",
"OrderId": 2084452111111,
"Port": 6379,
"QPS": 100000,
"RegionId": "cn-hangzhou",
"RequestId": "12123216-4B00-4378-BE4B-08005BFC****",
"TaskId": "10****",
"ZoneId": "cn-hangzhou-h"
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | MissingParameter | Period is mandatory for this action. | |
| 400 | InvalidToken.Malformed | The Specified parameter Token is not valid. | |
| 400 | InvalidInstanceName.Malformed | The Specified parameter InstanceName is not valid. | |
| 400 | InvalidPassword.Malformed | The Specified parameter Password is not valid. | |
| 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 | PaymentMethodNotFound | No payment method has been registered on the account. | |
| 400 | IdempotentParameterMismatch | Request uses a client token in a previous request but is not identical to that request. | 冪等性チェックに失敗しました。 |
| 400 | QuotaNotEnough | Quota not enough in this zone. | |
| 400 | QuotaExceed | Living afterpay instances quota exceed. | |
| 400 | VpcServiceError | Invoke vpc service failed. | |
| 400 | IzNotSupportVpcError | Specify iz not support vpc. | |
| 400 | InvalidvSwitchId | The vpc does not cover the vswitch. | |
| 400 | InvalidIzNo.NotSupported | The Specified vpc zone not supported. | |
| 400 | InvalidAccountPassword.Format | Specified account password is not valid. | |
| 400 | InstanceClass.NotMatch | Current instance class and instance type is not match. | |
| 400 | InvalidVPCId.NotFound | Specified virtual vpc is not found. | VPC が見つかりませんでした。VPC ID が正しいかどうかを確認してください。 |
| 400 | AccountMoneyValidateError | Account money validate error. | |
| 400 | RequestTokenConflict | Specified request token conflict. | |
| 400 | InvalidIPNotInSubnet | Error ip not in subnet. | |
| 400 | InvalidEngineVersion.Malformed | Specified engine version is not valid. | DPI エンジンバージョンが無効です。 |
| 400 | Zone.Closed | The specified zone is closed. | |
| 400 | VSwithNotBelongToNotVpcFault | The vSwitch does not belong to current vpc. | |
| 400 | PayIllegalAgreement | Pay mayi with holding agreement illegal. | |
| 400 | IllegalParamError | validateSaleConditionWithSubArticle failed. | |
| 400 | CASH_BOOK_INSUFFICIENT | No payment method is specified for your account. We recommend that you add a payment method or maitain a minimum prepayment balance of INR 1000. | |
| 400 | InvalidRegion.Format | Specified Region is not valid. | 指定された Region が無効です。 |
| 403 | RealNameAuthenticationError | Your account has not passed the real-name authentication yet. | |
| 403 | AuthorizationFailure | The request processing has failed due to authorization failure. | |
| 403 | TokenServiceError | The specified token is duplicated, please change it. | |
| 403 | UserCannotBuyNotInnerCommodity | The user can not buy this commodity without alibaba group tag. | |
| 404 | InvalidCapacity.NotFound | The Capacity provided does not exist in our records. | 指定されたストレージスペックが存在しません。 |
| 404 | InvalidvSwitchId | The Specified vSwitchId zone not supported. | |
| 404 | InvalidVpcIdOrVswitchId.NotSupported | The Specified vpcId or vSwitchId not supported. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。