クラウドネイティブな Tair (Enterprise Edition) インスタンスを作成します。
操作説明
インスタンス選定のガイダンスについては、「ApsaraDB Tair (Redis OSS-compatible) インスタンス選定ガイド」をご参照ください。
この API を使用する前に、ApsaraDB Tair (Redis OSS-compatible) の課金方法および料金を十分にご理解ください。
コンソールでこの操作を実行する手順については、「Tair インスタンスの作成」をご参照ください。
オープンソース版やTair メモリ最適化クラシックインスタンスなど、他のタイプのインスタンスを作成する場合は、CreateInstance API を呼び出してください。
今すぐお試しください
テスト
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 操作を呼び出して、セカンダリゾーンの ID を照会できます。 説明
複数のゾーン ID を指定したり、ZoneId パラメーターと同じ値を設定したりすることはできません。 |
cn-hangzhou-g |
| ChargeType |
string |
任意 |
インスタンスの課金方法です。有効値は次のとおりです。
列挙値:
|
PrePaid |
| VpcId |
string |
必須 |
VPC の ID です。DescribeVpcs 操作を呼び出して、VPC ID を照会できます。 |
vpc-bp1nme44gek34slfc**** |
| VSwitchId |
string |
必須 |
VPC に属する vSwitch の ID です。DescribeVpcs 操作を呼び出して、vSwitch ID を照会できます。 |
vsw-bp1e7clcw529l773d**** |
| Period |
integer |
任意 |
サブスクリプション期間です。有効値:1、2、3、4、5、6、7、8、9、12、24、36、および 60。単位:月。 説明
このパラメーターは、ChargeType パラメーターが PrePaid に設定されている場合にのみ必要です。 |
1 |
| BusinessInfo |
string |
任意 |
プロモーションイベントまたはビジネス情報の ID です。 |
000000000 |
| CouponNo |
string |
任意 |
クーポンコードです。 |
youhuiquan_promotion_option_id_for_blank |
| SrcDBInstanceId |
string |
任意 |
既存のインスタンスのバックアップセットに基づいてインスタンスを作成する場合は、このパラメーターにソースインスタンスの ID を設定します。 説明
SrcDBInstanceId パラメーターを指定した後は、BackupId、ClusterBackupId (クラウドネイティブクラスターインスタンスの場合は推奨)、または RestoreTime パラメーターを使用して、インスタンス作成に使用するバックアップセットまたは特定の時点を指定する必要があります。SrcDBInstanceId パラメーターは、上記 3 つのパラメーターのいずれかと組み合わせて使用する必要があります。 |
r-bp1zxszhcgatnx**** |
| BackupId |
string |
任意 |
BackupId パラメーターにソースインスタンスのバックアップセット ID を設定できます。システムはバックアップセットに保存されているデータを使用してインスタンスを作成します。DescribeBackups 操作を呼び出して、バックアップセット ID を照会できます。ソースインスタンスがクラスターインスタンスの場合、BackupId パラメーターにソースインスタンスのすべてのシャードのバックアップセット ID をカンマ (,) で区切って設定します。例:"10**,11**,15**"。 説明
インスタンスがクラウドネイティブクラスターインスタンスの場合、DescribeClusterBackupList を使用してクラスターインスタンスのバックアップセット ID (例:cb-xx) を照会し、ClusterBackupId リクエストパラメーターにバックアップセット ID を設定してクラスターインスタンスをクローンすることを推奨します。これにより、各シャードのバックアップセット ID を個別に指定する必要がなくなります。 |
2158****20 |
| ClusterBackupId |
string |
任意 |
このパラメーターは、特定の新しいクラスターインスタンスでサポートされています。DescribeClusterBackupList 操作を呼び出して、バックアップセット ID を照会できます。
|
cb-hyxdof5x9kqb**** |
| RecoverConfigMode |
string |
任意 |
指定されたバックアップセットからインスタンスを作成する際に、元のバックアップセットからアカウント、カーネルパラメータ、ホワイトリスト情報を復元するかどうかを指定します。たとえば、アカウント情報を復元する場合は、パラメーターを このパラメーターはデフォルトで空であり、これはアカウント、カーネルパラメータ、ホワイトリスト情報が元のバックアップセットから復元されないことを示します。 説明
このパラメーターはクラウドネイティブクラスターインスタンスにのみ適用されます。アカウント、カーネルパラメータ、ホワイトリスト情報は元のバックアップセットに保存されている必要があります。DescribeBackups 操作を呼び出して、指定されたバックアップセットの RecoverConfigMode 構成に上記の情報が含まれているかどうかを確認できます。 |
whitelist,config,account |
| 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 |
任意 |
リクエストのべき等性を保証するために使用されるクライアントトークンです。クライアント側でトークンを生成できますが、異なるリクエスト間でトークンが一意であり、大文字と小文字が区別されることを保証する必要があります。トークンには ASCII 文字のみを含めることができ、長さは 64 文字を超えてはいけません。 |
ETnLKlblzczshOTUbOCz**** |
| StorageType |
string |
任意 |
ストレージタイプです。有効値:essd_pl1、essd_pl2、および essd_pl3。 説明
このパラメーターは、InstanceType パラメーターを tair_essd に設定して ESSD ベースのインスタンスを作成する場合にのみ必要です。 列挙値:
|
essd_pl1 |
| Storage |
integer |
任意 |
ESSD/SSD ベースのインスタンスのストレージ容量です。有効値はインスタンスタイプによって異なります。詳細については、「ESSD/SSD ベースのインスタンス」をご参照ください。 説明
このパラメーターは、InstanceType パラメーターを tair_essd に設定して ESSD ベースのインスタンスを作成する場合にのみ必要です。Tair SSD ベースのインスタンスを作成する場合、Storage パラメーターは固定仕様に基づいて自動的に指定されるため、このパラメーターを指定する必要はありません。 |
60 |
| ShardType |
string |
任意 |
インスタンスのシャードタイプです。有効値は次のとおりです。
|
MASTER_SLAVE |
| ShardCount |
integer |
任意 |
インスタンス内のデータノード数です。有効値は次のとおりです。
説明
InstanceType パラメーターが tair_rdb または tair_scm に設定されている場合、このパラメーターは 2 ~ 32 の範囲に設定できます。DRAM ベースおよび永続メモリインスタンスのみがクラスターアーキテクチャをサポートしています。 |
2 |
| ReplicaCount |
integer |
任意 |
プライマリゾーン内のレプリカノード数です。このパラメーターはクラウドネイティブマルチレプリカクラスターインスタンスにのみ適用されます。有効値:1~4。 説明
|
2 |
| SlaveReplicaCount |
integer |
任意 |
マルチゾーンデプロイのクラウドネイティブマルチレプリカクラスターインスタンスを作成する際のセカンダリゾーン内のレプリカノード数です。このパラメーターと ReplicaCount パラメーターの値の合計は 4 を超えてはいけません。 説明
マルチゾーンデプロイのクラウドネイティブマルチレプリカクラスターインスタンスを作成する際は、SlaveReplicaCount と SecondaryZoneId の両方を指定する必要があります。 |
2 |
| ReadOnlyCount |
integer |
任意 |
プライマリゾーン内の読み取り専用レプリカ数です。このパラメーターはクラウドネイティブ読み書き分離インスタンスにのみ適用されます。有効値:1~9。 説明
このパラメーターと SlaveReadOnlyCount パラメーターの値の合計は 9 を超えてはいけません。 |
5 |
| SlaveReadOnlyCount |
integer |
任意 |
マルチゾーン読み書き分離インスタンスを作成する際のセカンダリゾーン内の読み取り専用レプリカ数です。このパラメーターと ReadOnlyCount パラメーターの値の合計は 9 を超えてはいけません。 説明
マルチゾーン読み書き分離インスタンスを作成する際は、SlaveReadOnlyCount と SecondaryZoneId の両方を指定する必要があります。 |
1 |
| EngineVersion |
string |
任意 |
データベースエンジンバージョンです。デフォルト値:1.0。パラメーター値は Tair インスタンスシリーズによって異なります。
|
1.0 |
| InstanceType |
string |
必須 |
インスタンスシリーズです。有効値は次のとおりです。
|
tair_scm |
| GlobalInstanceId |
string |
任意 |
作成されたインスタンスを分散インスタンスのサブインスタンスとして使用するかどうかを指定します。
説明
作成されたインスタンスを分散インスタンスとして使用する場合は、そのインスタンスは Tair DRAM ベースのインスタンスである必要があります。 |
gr-bp14rkqrhac**** |
| Tag |
array<object> |
任意 |
タグの詳細です。 |
|
|
object |
任意 |
タグの情報です。 |
||
| Key |
string |
任意 |
タグキーです。タグはキーと値のペアです。 説明
一度に指定できるキーと値のペアは最大 5 つです。 |
key1_test |
| Value |
string |
任意 |
タグの値です。 説明
N は N 番目のタグの値を示します。たとえば、Tag.1.Value は最初のタグの値を、Tag.2.Value は 2 番目のタグの値を示します。 |
value1_test |
| DryRun |
boolean |
任意 |
実際のリクエストを実行せずにドライランのみを実行するかどうかを指定します。有効値は次のとおりです。
|
false |
| Port |
integer |
任意 |
インスタンスのサービスポート番号です。有効値:1024~65535。デフォルト値:6379。 |
6379 |
| GlobalSecurityGroupIds |
string |
任意 |
インスタンスのグローバル IP ホワイトリストテンプレートです。複数の IP ホワイトリストテンプレートをカンマ (,) で区切ります。各 IP ホワイトリストテンプレートは一意である必要があります。 |
g-zsldxfiwjmti0kcm**** |
| ParamGroupId |
string |
任意 |
パラメータテンプレートの ID です。インスタンスはパラメータテンプレート内のパラメーターに基づいて作成されます。ID は一意である必要があります。 |
g-50npzjcqb1ua6q6j**** |
| RestoreTime |
string |
任意 |
ソースインスタンスでデータフラッシュバックが有効になっている場合、このパラメーターを使用して、ソースインスタンスのバックアップ保持期間内の時点を指定できます。システムはその時点でのソースインスタンスのバックアップデータを使用してインスタンスを作成します。時刻は ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ 形式で指定し、UTC である必要があります。 |
2021-07-06T07:25:57Z |
| ConnectionStringPrefix |
string |
任意 |
エンドポイントのプレフィックスです。プレフィックスは 8~40 文字で、小文字と数字を含めることができます。先頭は小文字で始まる必要があります。 説明
エンドポイントは <prefix>.redis.rds.aliyuncs.com 形式である必要があります。 |
r-bp1zxszhcgatnx**** |
| InstanceEndpointType |
string |
任意 |
読み書き分離機能を備えたクラウドネイティブデュアルゾーンデプロイインスタンスを作成する際に使用する接続アドレスタイプです。このパラメーターを明示的に指定しない場合、デフォルト値は AzIndependentEndpoint になります。
重要 このパラメーターは、読み書き分離機能を備えたクラウドネイティブデュアルゾーンデプロイインスタンスにのみ適用されます。他のインスタンスタイプでは、ゾーン非依存型接続アドレスのみがサポートされており、UnifiedEndpoint を指定しても効果はありません。 重要 UnifiedEndpoint オプションは、現在ホワイトリストユーザーのみが利用可能です。ホワイトリストに登録されていないユーザーがこのパラメーターを指定すると、呼び出し時にエラーが返されます。アクセスをリクエストするには、チケットを送信してホワイトリストへの追加を申請してください。 |
AzIndependentEndpoint |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスパラメーターです。 |
||
| QPS |
integer |
インスタンスが 1 秒あたりに処理できる読み取りおよび書き込み操作の最大数です。この値は理論値です。 |
100000 |
| ConnectionDomain |
string |
インスタンスの内部エンドポイントです。 |
r-bp13ac3d047b****.tairpena.rds.aliyuncs.com |
| ChargeType |
string |
インスタンスの課金方法です。有効値は次のとおりです。
|
PrePaid |
| InstanceId |
string |
インスタンスの ID です。 |
r-bp13ac3d047b**** |
| Port |
integer |
インスタンスのサービスポート番号です。 |
6379 |
| 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} |
| RegionId |
string |
リージョン ID です。 |
cn-hangzhou |
| RequestId |
string |
リクエスト ID です。 |
12123216-4B00-4378-BE4B-08005BFC**** |
| Bandwidth |
integer |
インスタンスの最大帯域幅です。単位:Mbit/s。 |
96 |
| Connections |
integer |
インスタンスへの最大接続数です。 |
10000 |
| InstanceName |
string |
インスタンス名です。 説明
このパラメーターは、リクエストで InstanceName パラメーターが指定された場合にのみ返されます。 |
redistest |
| ZoneId |
string |
ゾーン ID です。 |
cn-hangzhou-h |
| InstanceStatus |
string |
インスタンスの現在のステータスです。値は Creating です。 |
Creating |
| TaskId |
string |
タスク ID です。 |
10**** |
| OrderId |
integer |
注文 ID です。 |
2084452111111 |
例
成功レスポンス
JSONJSON
{
"QPS": 100000,
"ConnectionDomain": "r-bp13ac3d047b****.tairpena.rds.aliyuncs.com",
"ChargeType": "PrePaid",
"InstanceId": "r-bp13ac3d047b****",
"Port": 6379,
"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}",
"RegionId": "cn-hangzhou",
"RequestId": "12123216-4B00-4378-BE4B-08005BFC****",
"Bandwidth": 96,
"Connections": 10000,
"InstanceName": "redistest",
"ZoneId": "cn-hangzhou-h",
"InstanceStatus": "Creating",
"TaskId": "10****",
"OrderId": 2084452111111
}
エラーコード
|
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. | |
| 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. | |
| 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. | |
| 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. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。