批量創建云數據庫 Tair（兼容 Redis）經典版實例。
接口說明
請確保在使用該接口前，已充分了解云數據庫 Tair（兼容 Redis）產品的收費方式和價格。
說明
本接口僅支持創建經典版實例。
推薦您使用創建單個實例的 API 接口：
CreateInstance ：創建 Redis 開源版實例、Tair 內存型經典版實例。
CreateTairInstance ：創建 Tair 云原生版實例（含內存型、持久內存、磁盤型）。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| kvstore:CreateInstances | create | *DBInstance acs:kvstore:{#regionId}:{#accountId}:instance/* |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| 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 | 否 | 是否自動付費，取值：
說明
Instances 參數中，ChargeType 取值為 PrePaid 時，本參數才可用。
| true |
| BusinessInfo | string | 否 | 業務擴展信息。 | 000000000 |
| CouponNo | string | 否 | 優惠碼，默認值為： | youhuiquan_promotion_option_id_for_blank |
| EngineVersion | string | 否 | 實例兼容 Redis 的版本，取值：4.0、5.0。 說明
默認值為5.0。
| 5.0 |
| RebuildInstance | boolean | 否 | 是否需要從回收站中重建恢復源實例，取值：
說明
Instances 參數中設置了 SrcDBInstanceId 參數時，本參數才可用。
| false |
| AutoRenew | string | 否 | 是否開啟自動續費，取值：
說明
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 | 實例類型，取值：
|
| InstanceClass | String | 否 | redis.master.small.default | 實例的規格，例如 redis.master.small.default 為社區版（經典版）標準架構雙副本 1 GB 實例，詳細信息請參見規格查詢導航。 說明 本參數和Capacity兩者中必須傳入一項。 |
| Capacity | Long | 否 | 16384 | 實例的存儲容量，單位為 MB，詳細信息請參見規格查詢導航。 說明 本參數和InstanceClass兩者中必須傳入一項。 |
| EngineVersion | String | 否 | 5.0 | 實例兼容 Redis 的版本，取值：
|
| ChargeType | String | 否 | PrePaid | 付費類型，取值：
|
| Period | Long | 否 | 12 | 付費周期，單位為月，取值：1~9、12、24、36、60。 說明 當ChargeType參數取值為PrePaid時，本參數才可用且必須傳入。 |
| AutoRenew | String | 否 | true | 是否開啟自動續費，取值：
|
| InstanceName | String | 否 | apitest | 實例的名稱，需滿足下述要求：
|
| Password | String | 否 | Pass!123456 | 實例的密碼，需滿足下述要求：
|
| NetworkType | String | 否 | VPC | 網絡類型，取值：VPC（當前僅支持創建 VPC 網絡實例）：專有網絡 VPC。 |
| VpcId | String | 否 | vpc-bp1nme44gek34slfc**** | 專有網絡 ID，可調用專有網絡 VPC 的DescribeVpcs獲取。 |
| VSwitchId | String | 否 | vsw-bp1e7clcw529l773d**** | 該專有網絡下的虛擬交換機 ID，可調用專有網絡 VPC 的DescribeVpcs獲取。 |
| NodeType | String | 否 | MASTER_SLAVE | 節點類型，取值：
|
| SrcDBInstanceId | String | 否 | r-bp1zxszhcgatnx**** | 源實例 ID，可調用DescribeInstances獲取。 說明 當您需要基于該實例的備份數據創建新實例時，您才需要傳入本參數。 |
| BackupId | String | 否 | 111111111 | 備份集 ID，可通過調用DescribeBackups查詢。 說明 如需基于某個實例的備份數據創建新實例，在傳入SrcDBInstanceId參數指定了源實例后，您還需要在本參數中指定源實例的備份集 ID，系統將基于該備份集的數據創建新的實例。 |
| RebuildInstance | String | 否 | false | 是否需要從回收站中重建恢復源實例，取值：
|
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"
}]
返回參數
示例
正常返回示例
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. | Token驗證失敗 |
| 400 | InvalidInstanceName.Malformed | The Specified parameter "InstanceName" is not valid. | InstanceName驗證失敗 |
| 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. | 指定 iz不支持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. | 您的帳戶還沒有通過實名認證。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2022-02-22 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |