Redis Community エディションクラシックインスタンス、Redis Community エディションクラウドネイティブアーキテクチャインスタンス、または Tair メモリ最適化クラシックインスタンスを作成します。クラウドネイティブアーキテクチャの Tair インスタンスを作成するには、CreateTairInstance 操作を呼び出してください。
操作説明
この操作を呼び出す前に、ApsaraDB for Tair (Redis® OSS-Compatible) の課金方法と料金を十分に理解していることを確認してください。
この操作は、Redis Community エディションインスタンスと Tair メモリ最適化クラシックインスタンスを作成します。Tair クラウドネイティブインスタンスを作成するには、 CreateTairInstance 操作を呼び出してください。
対応するコンソール操作とインスタンス選択の推奨事項については、Redis インスタンスの作成を参照してください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
kvstore:CreateInstance |
create |
*DBInstance。
|
|
なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
必須 |
リージョン ID。 DescribeRegions を呼び出して、利用可能なリージョンをクエリできます。このパラメーターを使用して、インスタンスを作成するリージョンを指定します。 |
cn-hangzhou |
| Token |
string |
任意 |
リクエストのべき等性を確保するために使用されるクライアントトークン。トークン値はクライアントによって生成され、異なるリクエスト間で一意である必要があります。トークンは大文字と小文字が区別され、64 ASCII 文字以内である必要があります。 |
ETnLKlblzczshOTUbOCz**** |
| InstanceName |
string |
任意 |
インスタンスの名前。名前は 2~80 文字で、英字または中国語の文字で始まる必要があります。名前に |
apitest |
| Password |
string |
任意 |
インスタンスのパスワード。パスワードは 8~32 文字で、大文字、小文字、特殊文字、数字のうち少なくとも 3 種類を含む必要があります。次の特殊文字がサポートされています: |
Pass!123456 |
| Capacity |
integer |
任意 |
インスタンスのストレージ容量。単位: MB。 説明
この操作を呼び出す際に、Capacity と InstanceClass パラメーターのうち少なくとも 1 つを指定する必要があります。 |
16384 |
| InstanceClass |
string |
任意 |
インスタンスタイプ。たとえば、redis.master.small.default は Community エディション (クラシック) 標準アーキテクチャデュアルレプリカ 1 GB インスタンスを指定します。詳細については、インスタンスタイプの概要を参照してください。 説明
この操作を呼び出す際に、Capacity と InstanceClass パラメーターのうち少なくとも 1 つを指定する必要があります。 |
redis.master.small.default |
| ZoneId |
string |
任意 |
プライマリゾーン ID。 DescribeRegions を呼び出して、アクティブなゾーンをクエリできます。このパラメーターを使用して、インスタンスを作成するゾーンを指定します。 説明
SecondaryZoneId パラメーターを設定してセカンダリゾーンをセットすることもできます。プライマリノードとセカンダリノードは、指定されたプライマリゾーンとセカンダリゾーンにそれぞれデプロイされ、同一都市内のデュアルセンタープライマリ/セカンダリアーキテクチャを実現します。たとえば、ZoneId を "cn-hangzhou-h" に、SecondaryZoneId を "cn-hangzhou-g" にセットします。 |
cn-hangzhou-h |
| SecondaryZoneId |
string |
任意 |
セカンダリゾーン ID。 DescribeZones を呼び出して、利用可能なゾーンをクエリできます。 説明
このパラメーターの値は ZoneId の値と異なる必要があります。このパラメーターをマルチゾーンの ID にセットすることはできません。 |
cn-hangzhou-g |
| ChargeType |
string |
任意 |
課金方法。有効な値:
|
PostPaid |
| NodeType |
string |
任意 |
ノードタイプ。有効な値:
説明
クラウドネイティブインスタンスの場合、このパラメーターを MASTER_SLAVE または STAND_ALONE に設定します。クラシックインスタンスの場合、このパラメーターを double または single に設定します。 |
STAND_ALONE |
| NetworkType |
string |
任意 |
ネットワークタイプ。有効な値:
|
VPC |
| VpcId |
string |
任意 |
VPC の ID。 |
vpc-bp1nme44gek34slfc**** |
| VSwitchId |
string |
任意 |
vSwitch の ID。 |
vsw-bp1e7clcw529l773d**** |
| Period |
string |
任意 |
サブスクリプション期間。単位: 月。有効な値: 1~9、12、24、36、60。 説明
このパラメーターは、ChargeType が PrePaid に設定されている場合にのみ使用可能で必須です。 |
12 |
| 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 を使用してクラスターバックアップセット ID ("cb-xx" など) をクエリし、ClusterBackupId リクエストパラメーターに指定してクラスターインスタンスをクローンします。これにより、個々のシャードのバックアップセット ID を指定する必要がなくなります。 |
111111111 |
| InstanceType |
string |
任意 |
インスタンスタイプ。有効な値:
|
Redis |
| EngineVersion |
string |
任意 |
Redis クラシックエンジンバージョン。有効な値:
Redis クラウドネイティブエンジンバージョン。有効な値:
説明
デフォルト値: 5.0。 列挙値:
|
5.0 |
| PrivateIpAddress |
string |
任意 |
新しいインスタンスの内部ネットワーク IP アドレス。 説明
内部ネットワーク IP アドレスは、インスタンスが属する vSwitch の CIDR ブロック内である必要があります。 |
172.16.0.*** |
| AutoUseCoupon |
string |
任意 |
クーポンを使用するかどうかを指定します。有効な値:
|
false |
| AutoRenew |
string |
任意 |
自動更新を有効にするかどうかを指定します。有効な値:
|
true |
| AutoRenewPeriod |
string |
任意 |
自動更新エポック。単位: 月。有効な値: 1、2、3、6、12。 説明
このパラメーターは、AutoRenew が true に設定されている場合に必須です。 |
3 |
| ResourceGroupId |
string |
任意 |
リソースグループ ID。 |
rg-resourcegroupid1 |
| RestoreTime |
string |
任意 |
ソースインスタンスでフラッシュバックが有効になっている場合、バックアップ保持期間内のポイントインタイムを指定できます。システムは、指定されたポイントインタイムのソースインスタンスのバックアップデータを使用してインスタンスを作成します。時間は ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ フォーマットで指定します。時間は協定世界時 (UTC) である必要があります。 |
2019-06-19T16:00:00Z |
| DedicatedHostGroupId |
string |
任意 |
専用クラスターの ID。専用クラスターにインスタンスを作成する場合、このパラメーターは必須です。 |
dhg-uv4fnk6r7zff**** |
| ShardCount |
integer |
任意 |
シャード数。このパラメーターはクラウドネイティブインスタンスにのみ適用されます。このパラメーターを使用してシャード数をカスタマイズできます。
|
4 |
| ReplicaCount |
integer |
任意 |
プライマリゾーンのレプリカノード数。このパラメーターはクラウドネイティブクラスターマルチレプリカインスタンスにのみ適用されます。このパラメーターを使用してレプリカノード数をカスタマイズできます。有効な値: 1~4。 説明
マルチゾーンインスタンスを作成する場合、このパラメーターを SlaveReplicaCount パラメーターと一緒に使用して、プライマリゾーンとセカンダリゾーンのレプリカノード数をカスタマイズできます。このパラメーターと SlaveReplicaCount パラメーターの合計は 4 を超えることはできません。 |
2 |
| SlaveReplicaCount |
integer |
任意 |
セカンダリゾーンのレプリカノード数。 |
2 |
| ReadOnlyCount |
integer |
任意 |
プライマリゾーンの読み取り専用ノード数。このパラメーターはクラウドネイティブ読み書き分離インスタンスにのみ適用されます。
説明
マルチゾーンインスタンスを作成する場合、このパラメーターを SlaveReadOnlyCount パラメーターと一緒に使用して、プライマリゾーンとセカンダリゾーンの読み取り専用ノード数をカスタマイズできます。
|
2 |
| SlaveReadOnlyCount |
integer |
任意 |
セカンダリゾーンの読み取り専用ノード数。 |
2 |
| GlobalInstanceId |
string |
任意 |
分散インスタンスのインスタンス ID。このパラメーターは中国サイト (aliyun.com) にのみ適用されます。 |
gr-bp14rkqrhac**** |
| GlobalInstance |
boolean |
任意 |
新しいインスタンスを分散インスタンスの最初のサブインスタンスとして使用するかどうかを指定します。これにより、分散インスタンスを作成できます。有効な値:
説明
|
false |
| Port |
string |
任意 |
インスタンスのサービスポート。有効な値: 1~65535。デフォルト値: 6379。 |
6379 |
| DryRun |
boolean |
任意 |
このインスタンス作成リクエストに対してドライランを実行するかどうかを指定します。有効な値:
|
false |
| GlobalSecurityGroupIds |
string |
任意 |
インスタンスのグローバル IP ホワイトリストテンプレート。複数のテンプレートはカンマ (,) で区切ります。重複は許可されません。 重要 このパラメーターはクラウドネイティブインスタンスにのみ適用されます。クラシックインスタンスはホワイトリストテンプレート特徴をサポートしていません。 |
g-zsldxfiwjmti0kcm**** |
| Appendonly |
string |
任意 |
新しいインスタンスの Append Only File (AOF) 永続化パラメータ設定。有効な値:
説明
このパラメーターはクラシックインスタンスに適用されます。クラウドネイティブインスタンスは AOF パラメーターの指定をサポートしていません。 列挙値:
|
yes |
| ConnectionStringPrefix |
string |
任意 |
エンドポイントのプレフィックス。プレフィックスは小文字と数字で構成され、小文字で始まり、8~40 文字である必要があります。 説明
エンドポイントのフォーマットは |
r-bp1zxszhcgatnx**** |
| ParamGroupId |
string |
任意 |
パラメータテンプレートの ID。ID はグローバルに一意です。 重要 このパラメーターはクラウドネイティブインスタンスにのみ適用されます。 |
rpg-test** |
| Tag |
array<object> |
任意 |
インスタンスのタグ。 |
|
|
object |
任意 |
オブジェクト。 |
||
| Key |
string |
任意 |
タグキー。 説明
|
testkey |
| Value |
string |
任意 |
タグ値。 説明
N はタグのシーケンス番号を指定します。たとえば、Tag.1.Value は最初のタグの値を指定し、Tag.2.Value は 2 番目のタグの値を指定します。 |
testvalue |
| ClusterBackupId |
string |
任意 |
クラスターバックアップセット ID。一部の新しいクラスタアーキテクチャインスタンスでサポートされています。 DescribeClusterBackupList を呼び出して ID を取得できます。
|
cb-hyxdof5x9kqb**** |
| RecoverConfigMode |
string |
任意 |
指定されたバックアップセットからインスタンスを作成する際に、元のバックアップセットからアカウント、カーネルパラメータ (config)、またはホワイトリスト情報を復元するかどうかを指定します。たとえば、アカウント情報を復元するには、このパラメーターを デフォルト値は空で、元のバックアップセットからアカウント、カーネルパラメータ、ホワイトリスト情報を復元しないことを示します。 説明
このパラメーターはクラウドネイティブインスタンスにのみ適用され、元のバックアップセットにアカウント、カーネルパラメータ、またはホワイトリスト情報が含まれている必要があります。 DescribeBackups を呼び出して、指定されたバックアップセットの RecoverConfigMode パラメーターに上記の情報が含まれているかどうかを確認できます。 |
whitelist,config,account |
| InstanceEndpointType |
string |
任意 |
クラウドネイティブデュアルゾーン Deployment 読み書き分離インスタンスを作成する際に使用されるエンドポイントタイプ。このパラメーターが明示的に指定されない場合、デフォルト値は AzIndependentEndpoint です。
重要 このパラメーターはクラウドネイティブデュアルゾーン Deployment 読み書き分離インスタンスにのみ適用されます。その他のインスタンスタイプでは、ゾーン独立エンドポイントのみがサポートされます。UnifiedEndpoint を指定しても効果はありません。 重要 UnifiedEndpoint オプションはホワイトリストのユーザーのみが利用できます。ホワイトリストに登録されていない状態でこのパラメーターを指定すると、呼び出しはエラーを返します。アクセスをリクエストするには、チケットを送信してください。 |
AzIndependentEndpoint |
| MaintainStartTime |
string |
任意 |
メンテナンスウィンドウの開始時刻。協定世界時 (UTC) の HH:mmZ フォーマットで指定します。たとえば、開始時刻を 01:00 (UTC+8) にセットするには、 説明
このパラメーターが指定されない場合、デフォルト値は 02:00 (UTC+8)、つまり協定世界時 (UTC) で 18:00Z です。 |
03:00Z |
| MaintainEndTime |
string |
任意 |
メンテナンスウィンドウの終了時刻。協定世界時 (UTC) の HH:mmZ フォーマットで指定します。たとえば、終了時刻を 02:00 (UTC+8) に設定するには、 説明
開始時刻と終了時刻の間隔は少なくとも 1 時間である必要があります。 説明
このパラメーターが指定されない場合、デフォルト値は 06:00 (UTC+8)、つまり協定世界時 (UTC) で 22:00Z です。 |
07:00Z |
以下の例は、Redis 7.0 クラスターインスタンスを作成するリクエストを示しています。
{
"RegionId": "ap-southeast-1",
"InstanceName": "apitest",
"Password": "D****23",
"ZoneId": "ap-southeast-1a",
"ChargeType": "PrePaid",
"InstanceClass": "redis.shard.with.proxy.small.ce",
"NetworkType": "VPC",
"Period": "1",
"InstanceType": "Redis",
"EngineVersion": "7.0",
"ShardCount": 4,
"SourceIp": "10.10.10.10"
}
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答オブジェクト。 |
||
| VpcId |
string |
VPC の ID。 |
vpc-bp1nme44gek34slfc**** |
| QPS |
integer |
1 秒あたりのクエリ数 (QPS)。この値は、現在のインスタンスタイプの理論上の最大値です。 |
100000 |
| Capacity |
integer |
インスタンスのストレージ容量。単位: MB。 |
16384 |
| ConnectionDomain |
string |
Redis インスタンスの内部ネットワークエンドポイント。 |
r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com |
| ChargeType |
string |
課金方法。有効な値:
|
PostPaid |
| NetworkType |
string |
ネットワークタイプ。有効な値:
|
VPC |
| InstanceId |
string |
グローバルに一意のインスタンス ID。 |
r-bp1zxszhcgatnx**** |
| Port |
integer |
Redis サービスポート。 |
6379 |
| Config |
string |
インスタンスの詳細な構成。 |
{\"EvictionPolicy\":\"volatile-lru\",\"hash-max-ziplist-entries\":512,\"zset-max-ziplist-entries\":128,\"zset-max-ziplist-value\":64,\"set-max-intset-entries\":512,\"hash-max-ziplist-value\":64} |
| RegionId |
string |
インスタンスのリージョン ID。 |
cn-hongkong |
| EndTime |
string |
サブスクリプションインスタンスの有効期限切れの時間。時間は協定世界時 (UTC) の yyyy-MM-ddTHH:mm:ssZ フォーマットです。 |
2019-01-18T16:00:00Z |
| VSwitchId |
string |
vSwitch の ID。 |
vsw-bp1e7clcw529l773d**** |
| RequestId |
string |
リクエスト ID。 |
5DEA3CC9-F81D-4387-8E97-CEA40F09**** |
| NodeType |
string |
ノードタイプ。有効な値:
|
MASTER_SLAVE |
| Connections |
integer |
インスタンスがサポートする接続数の最大値。 |
10000 |
| Bandwidth |
integer |
インスタンスの帯域幅制限。単位: MB/s。 |
32 |
| InstanceName |
string |
インスタンスの名前。 |
apitest |
| ZoneId |
string |
インスタンスのゾーン ID。 |
cn-hangzhou-b |
| InstanceStatus |
string |
インスタンスの現在のステータス。戻り値は Creating に固定されています。 |
Creating |
| PrivateIpAddr |
string |
インスタンスの内部 IP アドレス。 |
172.16.0.10 |
| UserName |
string |
Redis インスタンスへの接続に使用されるアカウント。デフォルトでは、インスタンス ID にちなんだ名前のアカウントが含まれています。 |
r-bp1zxszhcgatnx**** |
| OrderId |
integer |
注文 ID。 |
2084452111111 |
例
成功レスポンス
JSONJSON
{
"VpcId": "vpc-bp1nme44gek34slfc****",
"QPS": 100000,
"Capacity": 16384,
"ConnectionDomain": "r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com",
"ChargeType": "PostPaid",
"NetworkType": "VPC",
"InstanceId": "r-bp1zxszhcgatnx****",
"Port": 6379,
"Config": "{\\\"EvictionPolicy\\\":\\\"volatile-lru\\\",\\\"hash-max-ziplist-entries\\\":512,\\\"zset-max-ziplist-entries\\\":128,\\\"zset-max-ziplist-value\\\":64,\\\"set-max-intset-entries\\\":512,\\\"hash-max-ziplist-value\\\":64}",
"RegionId": "cn-hongkong",
"EndTime": "2019-01-18T16:00:00Z",
"VSwitchId": "vsw-bp1e7clcw529l773d****",
"RequestId": "5DEA3CC9-F81D-4387-8E97-CEA40F09****",
"NodeType": "MASTER_SLAVE",
"Connections": 10000,
"Bandwidth": 32,
"InstanceName": "apitest",
"ZoneId": "cn-hangzhou-b",
"InstanceStatus": "Creating",
"PrivateIpAddr": "172.16.0.10",
"UserName": "r-bp1zxszhcgatnx****",
"OrderId": 2084452111111
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | ZoneIdNotFound | Specify iz not support switch network. | |
| 400 | InvalidShardInfo.Format | Shard total number is out of range. | |
| 400 | InvalidInstancelevel | Specified Instance level dose not match gdc other member instance level. | |
| 400 | InvalidBackupLogStatus | Backup logs are not enabled for the specified source instance. | |
| 400 | InvalidStatus | Specified instance status is Modifying. | |
| 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 | 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. | |
| 400 | DryRunOperation | Request validation has been passed with DryRun flag set. | |
| 400 | ResourceGroupNotExist | The Specified ResourceGroupId does not exist. | |
| 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. | |
| 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. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。