ApsaraDB for Redis インスタンスを作成するために使用する API について説明します。

コンソールで実行する操作の詳細については、「インスタンス作成」をご参照ください。

インスタンスタイプの詳細については、「インスタンスタイプ」をご参照ください。

デバッグ

この操作は、OpenAPI Explorer から呼び出すことができます。署名を手作業で計算する必要はありません。 操作の呼び出し後、OpenAPI Explorer は SDK サンプルコードを自動的に生成します。

リクエストパラメーター

パラメーター データ型 必須/任意 説明
Action String 必須 CreateInstance

操作の実行に使用する API (ModifyInstanceSSL) を設定します。

RegionId String 必須 cn-hangzhou

インスタンスを作成するリージョンの ID を設定します。 最新のリージョン一覧は、「DescribeRegions」を呼び出して照会できます。

InstanceClass String 任意 redis.master.small.default

インスタンスタイプを設定します。 詳細については、「インスタンスタイプ」をご参照ください。

CreateInstance を呼び出す際は、Capacity または InstanceClass パラメーターのいずれかを設定する必要があります。
Capacity Long 任意 16384

インスタンスのストレージ容量を示します (単位: MB)。

CreateInstance を呼び出す際は、Capacity または InstanceClass パラメーターのいずれかを設定する必要があります。
AccessKeyId String 任意 Lxxxxxxxxxxxxxxw

サービスへのアクセスに使用する、Alibaba Cloud から提供される AccessKey ID を設定します。

Token String 任意 AAAAAAAAAAAAAAAAAAAAAAAAAA

冪等性を保証するために使用されるトークンです。 このパラメーターの値はクライアントによって生成され、リクエストごとに異なる必要があります。 値の大文字と小文字は区別され、最大 64 文字の ASCII 文字を使用できます。

InstanceName String 任意 apitest

インスタンスの名前を設定します。 長さは 2 文字から 128 文字で、アルファベット文字で始まる必要があります。 なお、アットマーク (@)、スラッシュ (/)、コロン (:)、等号 (=)、二重引用符 (")、山括弧 (<>)、大括弧 ([])、中括弧 ({})、およびスペースは使用できません。

Password String 任意 Acfr5xxx,.xxx

インスタンスのパスワードを設定します。 長さは 8 文字から 32 文字で、大文字、小文字、数字、特殊文字のうち少なくとも 3 種類の文字を含む必要があります。 使用できる特殊文字は、! アットマーク (@)、ナンバー記号 (#)、ドル記号 ($)、パーセント記号 (%)、キャレット (^)、アンパサンド (&)、アスタリスク (*)、括弧 (())、アンダースコア (_)、プラス記号 (+)、ハイフン (-)、および等号 (=) です。

ZoneId String 任意 cn-hangzhou-e

インスタンスを作成するゾーンの ID を設定します。 最新のリージョン一覧は、「DescribeRegions」を呼び出して照会できます。

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}

インスタンスのパラメーター設定を JSON 文字列で設定します。 詳細については、「パラメーター設定」をご参照ください。

ChargeType String 任意 PostPaid

インスタンスの課金方法を設定します。 設定可能な値は次のとおりです。

  • PrePaid: サブスクリプション
  • PostPaid: 従量課金
デフォルト値は、PostPaid です。
NodeType String 任意 MASTER_SLAVE

インスタンスのノードタイプを設定します。 設定可能な値は次のとおりです。

  • STAND_ALONE
  • MASTER_SLAVE
デフォルト値は、MASTER_SLAVE です。
NetworkType String 任意 VPC

インスタンスのネットワークタイプを設定します。 設定可能な値は次のとおりです。

  • CLASSIC
  • VPC
デフォルト値は、CLASSIC です。
VpcId String 任意 vpc-bp1oxxxxxxxxxxgzv26cf

VPC の ID を設定します。

VSwitchId String 任意 vsw-oqscxxxxxxxxxxxxx5e8c

VSwitch の ID を設定します。

Period String 任意 12

サブスクリプション期間を設定します。 ChargeType パラメーターの値が PrePaid の場合はこのパラメーターを 月数で設定します。 設定可能な値は、1、2、3、4、5、6、7、8、9、12、24、36 です。

ChargeType パラメーターの値が PostPaid の場合、このパラメーターは使用できません。
BusinessInfo String 任意 000000000

イベントの ID またはビジネス情報を設定します。

CouponNo String 任意 youhuiquan_promotion_option_id_for_blank

クーポンの番号を設定します。 デフォルト値は、youhuiquan_promotion_option_id_for_blankです。

SrcDBInstanceId String 任意 r-bp1xxxxxxxxxxxxxx

ソースインスタンスの ID を設定します。 特定のインスタンスのバックアップファイルを基にしてインスタンスを作成する場合、このパラメーターを設定する必要があります。

BackupId String 任意 111111111

ソースインスタンスのバックアップファイルの ID を指定します。 特定のインスタンスのバックアップファイルを基にしてインスタンスを作成する場合、このパラメーターを設定する必要があります。 バックアップファイルの ID は、「DescribeBackups」を呼び出して照会できます。

InstanceType String 任意 Redis

インスタンスのエンジンタイプを設定します。 設定可能な値は次のとおりです。

  • Redis
  • Memcache
デフォルト値は、Redis です。
EngineVersion String 任意 4.0

インスタンスのエンジンバージョンを設定します。 設定可能な値は次のとおりです。

  • 2.8
  • 4.0
  • 5.0
デフォルト値は、2.8 です。
PrivateIpAddress String 任意 172.16.0.10

インスタンスの内部 IP アドレスを設定します。

内部 IP アドレスには、インスタンスが属する VSwitch で使用する CIDR ブロック内のアドレスを設定する必要があります。
AutoRenew String 任意 true

自動更新を有効にするかどうかを設定します。 設定可能な値は次のとおりです。

  • true
  • false
デフォルト値は、false です。
AutoRenewPeriod String 任意 3

自動更新の期間を月数で設定します。 設定可能な値は次のとおりです。

  • 1
  • 2
  • 3
  • 6
  • 12
AutoRenew パラメーターの値が true の場合、このパラメーターを設定する必要があります。
AutoUseCoupon String 任意 false

クーポンの利用有無を設定します。 設定可能な値は次のとおりです。

  • true
  • false
デフォルト値は、false です。

レスポンスパラメーター

パラメーター データ型 説明
Bandwidth Long 32

インスタンスの最大帯域幅を示します (単位: MByte/s)。

Capacity Long 16384

インスタンスのストレージ容量を示します (単位: MB)。

ChargeType String PostPaid

インスタンスの課金方法を示します。 想定される値は、PrePaid および PostPaid です。 デフォルト値は、PostPaid です。

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}

インスタンスのパラメーター設定を示します。

ConnectionDomain String r-j6cxxxxxxxxxxxxx.redis.rds.aliyuncs.com

インスタンスの内部エンドポイントを示します。

Connections Long 10000

インスタンスでサポートされる接続数の上限を示します。

EndTime String 2019-01-18T16:00:00Z

サブスクリプションインスタンスの有効期限を示します。 時刻は ISO 8601 標準に従い、 yyyy-MM-ddTHH:mm:ssZ 形式 (UTC) で表示されます。

InstanceId String r-j6cxxxxxxxxxxxxx

インスタンスの GUID (グローバル一意識別子) を示します。

InstanceName String apitest

インスタンスの名前を示します。

InstanceStatus String 作成

インスタンスのステータスを示します。

NetworkType String VPC

インスタンスのネットワークタイプを示します。 想定される値は次のとおりです。

  • CLASSIC
  • VPC
デフォルト値は、CLASSIC です。
NodeType String MASTER_SLAVE

インスタンスのノードタイプを示します。 想定される値は次のとおりです。

  • STAND_ALONE
  • MASTER_SLAVE
デフォルト値は、MASTER_SLAVE です。
Port Integer 6379

インスタンスのサービスポートを示します。

PrivateIpAddr String 172.16.0.10

インスタンスの内部 IP アドレスを示します。

QPS Long 100000

理論上の毎秒あたりの最大クエリ数 (QPS) を示します。

RegionId String cn-hongkong

インスタンスが配置されているリージョンを示します。

RequestId String 5DEA3CC9-F81D-4387-8E97-CEA40F09244D

リクエストの ID を示します。

UserName String r-j6cxxxxxxxxxxxxx

インスタンスに接続するためのユーザー名を示します。

VSwitchId String vsw-oqscxxxxxxxxxxxxxxxxx

VSwitch の ID を示します。

VpcId String vpc-bp1xxxxxxxxxxxxxxxxxx

VPC の ID を示します。

ZoneId String cn-hongkong-b

インスタンスが配置されているリージョンの ID を示します。

リクエストの例


https://r-kvstore.aliyuncs.com/
? Action=CreateInstance
&RegionId=cn-hongkong
&InstanceClass=redis.master.2xlarge.default
&InstanceName=apitest
&<Common request parameters>

操作が正常に完了した場合のレスポンス例

XML 形式

<CreateInstanceResponse>
	  <ChargeType>PostPaid</ChargeType>
	  <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}</Config>
	  <InstanceId>r-j6cxxxxxxxxxxxxx</InstanceId>
	  <UserName>r-j6cxxxxxxxxxxxxx</UserName>
	  <ZoneId>cn-hongkong-b</ZoneId>
	  <InstanceStatus>Creating</InstanceStatus>
	  <Port>6379</Port>
	  <QPS>100000</QPS>
	  <RequestId>96132219-F1E6-40AB-8853-C32055B84BE1</RequestId>
	  <RegionId>cn-hongkong</RegionId>
	  <Capacity>16384</Capacity>
	  <ConnectionDomain>r-j6cxxxxxxxxxxxxx.redis.rds.aliyuncs.com</ConnectionDomain>
	  <InstanceName>apitest</InstanceName>
	  <Bandwidth>32</Bandwidth>
	  <Connections>10000</Connections>
</CreateInstanceResponse>

JSON format

{
	"ChargeType":"PostPaid",
	"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}",
	"InstanceId":"r-j6cxxxxxxxxxxxxx",
	"UserName":"r-j6cxxxxxxxxxxxxx",
	"ZoneId":"cn-hongkong-b",
	"InstanceStatus":"Creating",
	"Port":6379,
	"QPS":100000,
	"RequestId":"96132219-F1E6-40AB-8853-C32055B84BE1",
	"RegionId":"cn-hongkong",
	"Capacity":16384,
	"ConnectionDomain":"r-j6cxxxxxxxxxxxxx.redis.rds.aliyuncs.com",
	"InstanceName":"apitest",
	"Connections":10000,
	"Bandwidth":32
}

エラーコード

HTTP ステータスコード エラーコード エラーメッセージ 説明
400 MissingParameter Period is mandatory for this action. インスタンス ID が必要な場合に返されるエラーメッセージです。
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. アカウントに十分な残高がない場合に返されるエラーメッセージです。 アカウントの残高を回復後、再試行します。
403 RealNameAuthenticationError Your account has not passed the real-name authentication yet. アカウントの実名認証に合格しなかった場合に返されるエラーメッセージです。
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. VPCサービスの呼び出しに失敗した場合に返されるエラーメッセージです。
400 IzNotSupportVpcError Specify iz not support vpc. 設定しようとした iz が VPC をサポートしていない場合に返されるエラーメッセージです。

詳細については、「エラーコード」をご参照ください。