CreateInstances - 大量建立執行個體 - Tair (Redis® OSS-Compatible)

大量建立雲資料庫 Tair（相容 Redis）經典版執行個體。

介面說明

請確保在使用該介面前，已充分瞭解雲資料庫 Tair（相容 Redis）產品的收費方式和[價格](~~54532~~)。 > 本介面僅支援建立經典版執行個體。推薦您使用建立單個執行個體的API介面： > - [CreateInstance](~~473757~~)：建立Redis開源版執行個體、Tair記憶體型經典版執行個體。 > - [CreateTairInstance](~~473770~~)：建立Tair雲原生版執行個體（含記憶體型、持久記憶體、磁碟型）。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

kvstore:CreateInstances

create

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/*

kvstore:InstanceClass
kvstore:InstanceType
kvstore:Appendonly

無

請求參數

名稱	類型	必填	描述	樣本值
Instances	string	是	新執行個體的配置資訊，格式為JSON，詳細說明請參見Instances參數補充說明。	[{ "RegionId": "cn-hangzhou", "izNo": "cn-hangzhou-b", "quantity": 1, "instanceType": "Redis", "instanceClass": "redis.logic.sharding.1g.2db.0rodb.4proxy.default", "EngineVersion": "5.0", "ChargeType":"PrePaid", "Period":"1", "networkType": "VPC" , "vpcId": "vpc-2zex6u1nu32k3ux35oxxx", "vSwitchId": "vsw-2zesk464e647104kw3xxx" }]
Token	string	否	用於保證請求的等冪性。由用戶端產生該參數值，要保證在不同請求間唯一，大小寫敏感、不超過64個ASCII字元。	ETnLKlblzczshOTUbOCz****
AutoPay	boolean	否	是否自動付費，取值： * true：自動付費，預設值。 * false：手動付費。您需要在控制台的頂部功能表列，單擊費用 > 續約管理，然後單擊左側導覽列的訂單管理 > 我的訂單，找到目標訂單進行支付。 > Instances參數中，ChargeType取值為PrePaid時，本參數才可用。	true
BusinessInfo	string	否	業務擴充資訊。	000000000
CouponNo	string	否	優惠碼，預設值為：`youhuiquan_promotion_option_id_for_blank`。	youhuiquan_promotion_option_id_for_blank
EngineVersion	string	否	執行個體相容Redis的版本，取值：4.0、5.0。 > 預設值為5.0。	5.0
RebuildInstance	boolean	否	是否需要從資源回收筒中重建恢複源執行個體，取值： * true：需要。 * false：不需要，預設值。 > Instances參數中設定了SrcDBInstanceId參數時，本參數才可用。	false
AutoRenew	string	否	是否開啟自動續約，取值： * true：開啟。 * false：不開啟，預設值。 > Instances參數中，ChargeType取值為PrePaid時，本參數才可用。	false
ResourceGroupId	string	否	資源群組ID。	rg-resourcegroupid1

### Instances參數補充說明

名稱	類型	是否必選	樣本值	描述
RegionId	String	是	cn-hangzhou	地區ID，可調用DescribeRegions查詢，使用此參數指定要建立執行個體的地區。
IzNo	String	是	cn-hangzhou-b	主可用性區域ID，可調用DescribeRegions查詢，使用此參數指定要建立執行個體的可用性區域。
Quantity	Integer	否	1	要建立的執行個體數量，取值範圍：1~300，預設值為1。
InstanceType	String	否	Redis	執行個體類型，取值： Redis（預設）：雲資料庫 Tair（相容 Redis）執行個體。 Memcache：Memcache執行個體。
InstanceClass	String	否	redis.master.small.default	執行個體的規格，例如redis.master.small.default為社區版（經典版）標準架構雙副本1 GB執行個體，詳細資料請參見規格查詢導航。說明本參數和Capacity兩者中必須傳入一項。
Capacity	Long	否	16384	執行個體的儲存容量，單位為MB，詳細資料請參見規格查詢導航。說明本參數和InstanceClass兩者中必須傳入一項。
EngineVersion	String	否	5.0	執行個體相容Redis的版本，取值： 5.0（預設） 4.0
ChargeType	String	否	PrePaid	付費類型，取值： PrePaid：訂用帳戶（預付費）。 PostPaid（預設）：隨用隨付（後付費）。
Period	Long	否	12	付費周期，單位為月，取值：1~9、12、24、36、60。說明當ChargeType參數取值為PrePaid時，本參數才可用且必須傳入。
AutoRenew	String	否	true	是否開啟自動續約，取值： true：開啟。 false（預設）：不開啟。說明當ChargeType參數取值為PrePaid時，本參數才可用。
InstanceName	String	否	apitest	執行個體的名稱，需滿足下述要求：以大小寫字母或中文開頭，長度為2~80個字元。不支援空格和特殊字元：@/:=”<>{[]}
Password	String	否	Pass!123456	執行個體的密碼，需滿足下述要求：長度為8~32位。需包含大寫字母、小寫字母、特殊字元和數字中的至少三種。支援的特殊字元為：!@#$%^&*()_+-=
NetworkType	String	否	VPC	網路類型，取值：VPC（當前僅支援建立 VPC 網路執行個體）：Virtual Private Cloud。
VpcId	String	否	vpc-bp1nme44gek34slfc****	專用網路ID，可調用Virtual Private Cloud的DescribeVpcs擷取。
VSwitchId	String	否	vsw-bp1e7clcw529l773d****	該專用網路下的虛擬交換器ID，可調用Virtual Private Cloud的DescribeVpcs擷取。
NodeType	String	否	MASTER_SLAVE	節點類型，取值： STAND_ALONE：單副本。 MASTER_SLAVE（預設）：高可用（雙副本）。
SrcDBInstanceId	String	否	r-bp1zxszhcgatnx****	源執行個體ID，可調用DescribeInstances擷取。說明當您需要基於該執行個體的備份資料建立新執行個體時，您才需要傳入本參數。
BackupId	String	否	111111111	備份組ID，可通過調用DescribeBackups查詢。說明如需基於某個執行個體的備份資料建立新執行個體，在傳入SrcDBInstanceId參數指定了源執行個體後，您還需要在本參數中指定源執行個體的備份組ID，系統將基於該備份組的資料建立新的執行個體。
RebuildInstance	String	否	false	是否需要從資源回收筒中重建恢複源執行個體，取值： true：需要。 false（預設）：不需要。說明如果傳入了本參數，則必須傳入SrcDBInstanceId參數。

### Instances參數請求樣本

[{
    "RegionId": "cn-hangzhou",
    "izNo": "cn-hangzhou-b",
    "quantity": 1,
    "instanceType": "Redis",
    "instanceClass": "redis.logic.sharding.1g.2db.0rodb.4proxy.default",
    "EngineVersion": "5.0",
    "ChargeType": "PrePaid",
    "Period":"1",
    "networkType": "VPC" , 
    "vpcId": "vpc-2zex6u1nu32k3ux35xxxx", 
    "vSwitchId": "vsw-2zesk464e647104kwxxxx"
}]

返回參數

名稱	類型	描述	樣本值
	object
OrderId	string	訂單ID。	20905403119****
RequestId	string	請求ID。	561AFBF1-BE20-44DB-9BD1-6988B53E****
InstanceIds	object
InstanceId	array	本次建立的執行個體ID的列表。
	string	執行個體ID。	r-bp16e70a4338****

樣本

正常返回樣本

JSON格式

{
  "OrderId": "20905403119****",
  "RequestId": "561AFBF1-BE20-44DB-9BD1-6988B53E****",
  "InstanceIds": {
    "InstanceId": [
      "r-bp16e70a4338****"
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	Zone.Closed	Specified zone is closed.	指定的可用性區域已關閉
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.	指定的Password參數不符合規範要求
400	InvalidInstances.Malformed	The Specified parameter "Instances" is not valid.	傳入的Instances參數是無效的。
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	InvalidVpcIdRegion.NotSupported	The Specified vpcId or vSwitchId not supported.
400	ResourceGroupNotExist	The Specified ResourceGroupId does not exist.
403	RealNameAuthenticationError	Your account has not passed the real-name authentication yet.
404	InvalidCapacity.NotFound	The Capacity provided does not exist in our records.	所指定的儲存規格不存在。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。