CreateTairInstance - 建立Tair（企業版）執行個體 - Tair (Redis® OSS-Compatible)

建立雲原生版的Tair（企業版）執行個體。

介面說明

選型參考資料，請參見雲資料庫 Tair（相容 Redis）選型必讀。

請確保在使用該介面前，已充分瞭解雲資料庫 Tair（相容 Redis）產品的收費方式和價格。

說明

關於控制台的操作方法，請參見建立 Tair 執行個體。
如需建立其他類型的執行個體，例如開源版或 Tair 記憶體型經典版執行個體，您可以調用 CreateInstance 介面。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

kvstore:CreateTairInstance

create

*DBInstance

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

kvstore:InstanceClass
kvstore:InstanceType

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	地區 ID，可調用 DescribeRegions 查詢，使用此參數指定要建立執行個體的地區。	cn-hangzhou
InstanceName	string	否	執行個體名稱，需滿足下述要求：長度為 2~80 個字元。以大小寫英文字母或中文開頭，不支援空格和特殊字元：`@/:=”<>{[]}`。	apitest
Password	string	否	執行個體密碼，需滿足下述要求：長度為 8~32 位。需包含大寫字母、小寫字母、特殊字元和數字中的至少三種，支援的特殊字元為`!@#$%^&*()_+-=`。	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 查詢。說明本參數和 ZoneId 參數傳入的值不能相同，且不可傳入多可用性區域對應的 ID。	cn-hangzhou-g
ChargeType	string	否	付費類型，取值： PrePaid（預設）：預付費，即訂用帳戶。 PostPaid：隨用隨付。枚舉值： PostPaid : PostPaid PrePaid : PrePaid	PrePaid
VpcId	string	是	專用網路 ID，可調用Virtual Private Cloud 的 DescribeVpcs 擷取。	vpc-bp1nme44gek34slfc****
VSwitchId	string	是	該專用網路下的虛擬交換器 ID，可調用Virtual Private Cloud 的 DescribeVpcs 擷取。	vsw-bp1e7clcw529l773d****
Period	integer	否	付費周期，單位為月，取值：1~9、12、24、36、60 。說明當 ChargeType 取值為 PrePaid 時，本參數必須傳入。	1
BusinessInfo	string	否	活動 ID、商務資訊。	000000000
CouponNo	string	否	優惠碼。	youhuiquan_promotion_option_id_for_blank
SrcDBInstanceId	string	否	如需基於某個執行個體的備份組建立新執行個體，請先在此參數中指定源執行個體 ID。說明然後通過 BackupId、ClusterBackupId（雲原生叢集架構建議使用 ClusterBackupId）或 RestoreTime 參數指定需要使用的備份組或指定時間點，本參數需要與上述 3 個中的任意一個參數組合使用。	r-bp1zxszhcgatnx****
BackupId	string	否	您可在此參數中指定源執行個體的備份組 ID，系統將使用該備份組中儲存的資料建立新執行個體。通過調用 DescribeBackups 可查詢 BackupId。如果源執行個體是叢集執行個體，則此處需要填寫源執行個體各個分區的備份組 id，並且通過逗號隔開，例如"10,11,15**"。說明若您的執行個體是雲原生架構執行個體，並且是叢集執行個體，則建議您使用 DescribeClusterBackupList 查詢出叢集備份組 id，例如"cb-xx"，然後填入 ClusterBackupId 請求參數來達到複製叢集執行個體的目的，免去您輸入各個分區備份組 id 的煩惱。	2158****20
ClusterBackupId	string	否	部分新叢集架構支援叢集備份組 ID，您可以通過 DescribeClusterBackupList 介面擷取。若支援，可輸入指定的叢集備份組 ID 即可，無需再填寫 BackupId 參數。若不支援，請在 BackupId 參數中填寫為原執行個體各個分區下的備份組 ID，通過逗號隔開，例如"2158**20,2158**22"等。	cb-hyxdof5x9kqb****
RecoverConfigMode	string	否	使用指定備份組建立執行個體時，是否從原備份組中恢複帳號（account）、核心參數（config）、白名單（whitelist）資訊。例如需恢複帳號資訊，則取值為 account。預設為空白，表示不從原備份組中恢複帳號、核心參數、白名單資訊。說明本參數僅適用於雲原生版執行個體，且需要原備份組中已儲存了帳號、核心參數、白名單資訊。您可以通過 DescribeBackups 介面查詢指定備份組中的 RecoverConfigMode 參數是否包含上述資訊。	whitelist,config,account
PrivateIpAddress	string	否	指定執行個體的內網 IP 位址。說明該地址需在執行個體所屬交換器的網段內，您可以調用Virtual Private Cloud 的 DescribeVSwitches 擷取網段資訊。	172.16.88.***
AutoUseCoupon	string	否	是否使用代金券，取值： true：使用代金券。 false（預設）：不使用代金券。	true
AutoRenew	string	否	是否開啟自動續約，取值： true：開啟。 false（預設）：不開啟。	true
AutoRenewPeriod	string	否	自動續約周期，單位為月，取值：1、2、3、6、12。說明當 AutoRenew 取值為 true 時，本參數必須傳入。	3
ResourceGroupId	string	否	目標資源群組 ID。說明您可以通過調用 ListResourceGroups 介面或通過控制台擷取資源群組 ID 列表。相關操作，請參見查看資源群組基本資料。修改執行個體所屬的資源群組之前，您可以調用 ListResources 介面查看執行個體現在所屬的資源群組。	rg-acfmyiu4ekp****
AutoPay	boolean	否	自動支付，取值固定為 true。	true
ClientToken	string	否	用於保證請求的等冪性。由用戶端產生該參數值，要保證在不同請求間唯一，大小寫敏感、不超過 64 個 ASCII 字元。	ETnLKlblzczshOTUbOCz****
StorageType	string	否	儲存類型，取值為essd_pl1、essd_pl2、essd_pl3。說明當 InstanceType 取值為tair_essd時，且建立 ESSD 型時，才需要輸入本參數。	essd_pl1
Storage	integer	否	磁碟型執行個體的儲存空間，不同的規格取值範圍有所區別，詳情請參見磁碟型規格。說明當 InstanceType 取值為tair_essd時，且建立 ESSD 型時，才需要輸入本參數。對於建立 Tair 磁碟 SSD 型執行個體，容量欄位按不同的規格定義為不同的固定值，無需指定該欄位。	60
ShardType	string	否	執行個體類型，取值： MASTER_SLAVE（預設）：高可用，採用主備架構，可保障可用性。 STAND_ALONE：單副本，採用單節點架構。在節點故障後，資料會丟失，系統會自動拉起新的空執行個體。僅在單可用性區域時支援，且不支援建立叢集與讀寫分離架構。	MASTER_SLAVE
ShardCount	integer	否	執行個體中的資料節點個數，取值： 1：預設值，即表示建立的執行個體為標準架構，僅擁有 1 個資料節點。 2~32：傳入該範圍的值，即表示建立的執行個體為叢集架構，擁有指定數量的資料節點。說明當 InstanceType 取值為tair_rdb或tair_scm時，本參數才可以傳入 2~32，即只有記憶體型和持久記憶體型支援叢集架構。	2
ReplicaCount	integer	否	主可用性區域的備節點數，本參數僅適用於建立雲原生版叢集多副本執行個體，您可以通過該參數實現自訂備節點數量，取值：1~4。說明若建立多可用性區域執行個體，您可以通過該參數與 SlaveReplicaCount 參數自訂主、備可用性區域的備節點數量。同時，該參數與 SlaveReplicaCount 參數的總和不能超過 4。	2
SlaveReplicaCount	integer	否	備可用性區域的備節點數量。	2
ReadOnlyCount	integer	否	主可用性區域的唯讀節點數，本參數僅適用於建立雲原生讀寫分離執行個體。若執行個體為標準架構，取值為 1~9。若執行個體為叢集架構，取值為 1-4，表示每資料分區的唯讀節點數。說明若建立多可用性區域執行個體，您可以通過該參數和 SlaveReadOnlyCount 參數自訂主備可用性區域的唯讀節點數量。若執行個體為標準架構，該參數與 SlaveReadOnlyCount 的總和不能大於 9。若執行個體為叢集架構，該參數與 SlaveReadOnlyCount 的總和不能大於 4。	5
SlaveReadOnlyCount	integer	否	備可用性區域的唯讀節點數量。	1
EngineVersion	string	否	資料庫版本，預設取值：1.0，不同 Tair 產品類型傳參規則： Tair_rdb: Tair 記憶體型相容 Redis 5.0、Redis 6.0 和 Redis 7.0 協議，傳5.0、6.0或7.0。 Tair_scm: Tair 持久記憶體相容 Redis 6.0 協議，傳1.0。 Tair_essd: Tair 磁碟（ESSD/SSD）相容 Redis 6.0 協議。建立 ESSD 型請傳入1.0、建立 SSD 型請傳入2.0。	1.0
InstanceType	string	是	儲存介質，取值： tair_rdb：記憶體型。 tair_scm：持久記憶體型。 tair_essd：磁碟型。	tair_scm
GlobalInstanceId	string	否	是否將本次建立的執行個體作為分布式執行個體中的子執行個體，通過該方式可建立分布執行個體。若希望建立的執行個體作為第一個子執行個體，請輸入 true。若希望建立的執行個體作為第二、三個子執行個體，請輸入分布式執行個體 ID，例如 gr-bp14rkqrhac****。不作為分布式執行個體，您無需輸入任何值。說明若希望作為分布式執行個體，本次建立的執行個體需為 Tair 記憶體型。	gr-bp14rkqrhac****
Tag	array<object>	否	執行個體的標籤資訊。
	object	否	標籤資訊。
Key	string	否	標籤的鍵，與 Tag Value 組成標籤的索引值對。說明單次最多支援傳入 5 組標籤的索引值對。	key1_test
Value	string	否	標籤的值。說明 N 表示傳入第幾個標籤的值。例如Tag.1.Value表示傳入第一個標籤的值；Tag.2.Value表示傳入第二個標籤的值。	value1_test
DryRun	boolean	否	是否對本次建立執行個體的操作執行預檢查，取值： true：執行預檢查操作，不建立執行個體。檢查專案包含請求參數、請求格式、業務限制和庫存。如果檢查不通過，則返回對應錯誤。如果檢查通過，則返回錯誤碼`DryRunOperation`。 false（預設）：發送正常請求，通過檢查後直接建立執行個體。	false
Port	integer	否	執行個體的服務連接埠，取值範圍：1~65535，預設值為 6379。	6379
GlobalSecurityGroupIds	string	否	執行個體的全域 IP 白名單模板，多個 IP 白名單模板請用英文逗號（,）分隔，不可重複。	g-zsldxfiwjmti0kcm****
ParamGroupId	string	否	參數模板 ID，根據新建立的參數模板參數建立執行個體，不可重複。	g-50npzjcqb1ua6q6j****
RestoreTime	string	否	若源執行個體已開啟資料閃回，您可在此參數中指定源執行個體備份保留周期內的任意時間點，系統將使用源執行個體在該時間點的備份資料建立新執行個體。格式為yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。	2021-07-06T07:25:57Z
ConnectionStringPrefix	string	否	串連地址的首碼，需由小寫英文字母與數字組成，以小寫字母開頭，長度為 8~40 個字元。說明串連地址格式為：<首碼-執行個體 ID>.redis.rds.aliyuncs.com。	r-bp1zxszhcgatnx****
InstanceEndpointType	string	否	建立雲原生雙可用性區域讀寫分離執行個體時，使用的串連地址類型。不顯式傳該參數時，值預設為 AzIndependentEndpoint。 AzIndependentEndpoint : 預設值。可用性區域獨立串連地址。主、備可用性區域分別提供獨立串連地址，可通過不同的串連地址實現可用性區域就近訪問。 UnifiedEndpoint : 統一串連地址。提供統一的串連地址，通過該地址同時訪問到主備可用性區域的節點，但會出現跨可用性區域訪問。重要該參數僅適用於雲原生雙可用性區域讀寫分離執行個體。對於其他類型執行個體，僅支援可用性區域獨立串連地址，即使傳入 UnifiedEndpoint 也不會真正生效。重要 UnifiedEndpoint 參數目前僅面向白名單使用者開放。非白名單使用者傳入該參數將導致調用報錯。如需開通使用許可權，請提交工單申請加白。	AzIndependentEndpoint

返回參數

名稱	類型	描述	樣本值
	object	對象。
QPS	integer	每秒處理的最大讀寫運算元，單位為次/秒，此處為當前執行個體規格的理論值。	100000
ConnectionDomain	string	執行個體的內網串連地址。	r-bp13ac3d047b****.tairpena.rds.aliyuncs.com
ChargeType	string	執行個體的付費類型，傳回值： PrePaid：預付費。 PostPaid：隨用隨付。	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	執行個體的最大頻寬，單位：MB/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

樣本

正常返回樣本

JSON格式

{
  "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 status code	錯誤碼	錯誤資訊	描述
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.	VPC未找到，建議檢查VPC ID是否正確。
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.	指定的地區Region無效
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.

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

變更歷史

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