CreateInstance - 建立執行個體 - Tair (Redis® OSS-Compatible)

建立一個 Redis開源版經典架構、Redis開源版雲原生架構、Tair記憶體型經典架構執行個體。若要建立雲原生架構的Tair執行個體，請使用CreateTairInstance介面。

介面說明

請確保在使用該介面前，已充分瞭解雲資料庫 Tair（相容 Redis）產品的收費方式和[價格](~~54532~~)。本介面可建立Redis開源版執行個體、Tair記憶體型經典版執行個體，如需建立Tair雲原生版執行個體，請調用[CreateTairInstance](~~473770~~)介面。 > 該API對應的控制台操作方法和選型建議，請參見[建立Redis執行個體](~~26351~~)。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

kvstore:CreateInstance

create

*DBInstance

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

kvstore:InstanceClass
kvstore:Appendonly
kvstore:InstanceType

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	地區ID，可調用[DescribeRegions](~~473763~~)查詢，使用此參數指定要建立執行個體的地區。	cn-hangzhou
Token	string	否	用於保證請求的等冪性。由用戶端產生該參數值，要保證在不同請求間唯一，大小寫敏感、不超過64個ASCII字元。	ETnLKlblzczshOTUbOCz****
InstanceName	string	否	執行個體名稱。名稱為2~80個字元，以大小寫字母或中文開頭，不支援字元`@/:=”<>{[]}`和空格。	apitest
Password	string	否	執行個體密碼。長度為8－32位，需包含大寫字母、小寫字母、特殊字元和數字中的至少三種，允許的特殊字元包括`!@#$%^&*()_+-=`。	Pass!123456
Capacity	integer	否	執行個體的儲存容量，單位為MB。 > 調用此介面需至少傳遞Capacity或InstanceClass中的一個參數。	16384
InstanceClass	string	否	執行個體的規格，例如redis.master.small.default為社區版（經典版）標準架構雙副本1GB執行個體，詳細資料請參見[規格查詢導航](~~26350~~)。 > 調用此介面需至少傳遞Capacity或InstanceClass中的一個參數。	redis.master.small.default
ZoneId	string	否	主可用性區域ID，可調用[DescribeRegions](~~473763~~)查詢，使用此參數指定要建立執行個體的可用性區域。 > 您也可以再傳入SecondaryZoneId參數指定備可用性區域，主備節點將分別部署在指定的主可用性區域和備可用性區域，實現同城雙中心主備架構。例如指定ZoneId參數為"cn-hangzhou-h"，指定SecondaryZoneId參數為"cn-hangzhou-g"。	cn-hangzhou-h
SecondaryZoneId	string	否	備可用性區域ID，可調用[DescribeZones](~~473764~~)介面查詢。 > 本參數和ZoneId參數傳入的值不能相同，且不可傳入多可用性區域對應的ID。	cn-hangzhou-g
ChargeType	string	否	付費類型，取值： * PrePaid：預付費。 * PostPaid（預設）：隨用隨付。	PostPaid
NodeType	string	否	節點類型，取值： * MASTER_SLAVE：高可用（雙副本） * STAND_ALONE：單副本 * double：雙副本 * single：單副本 > 雲原生版執行個體請選擇MASTER_SLAVE或STAND_ALONE，經典版執行個體請選擇double或single。	STAND_ALONE
NetworkType	string	否	網路類型，取值： * VPC：專用網路，預設值。	VPC
VpcId	string	否	VPC網路的ID。	vpc-bp1nme44gek34slfc****
VSwitchId	string	否	虛擬交換器的ID。	vsw-bp1e7clcw529l773d****
Period	string	否	付費周期，單位為月，取值：1~9、12、24、36、60 。 > ChargeType取值為PrePaid時，本參數才可用且必須傳入。	12
BusinessInfo	string	否	活動ID、商務資訊。	000000000
CouponNo	string	否	優惠碼，預設值為：`default`。	youhuiquan_promotion_option_id_for_blank
SrcDBInstanceId	string	否	如需基於某個執行個體的備份組建立新執行個體，請先在此參數中指定源執行個體ID。 > 然後通過BackupId、ClusterBackupId（雲原生叢集架構建議使用ClusterBackupId）或RestoreTime參數指定需要使用的備份組或指定時間點，本參數需要與上述3個中的任意一個參數組合使用。	r-bp1zxszhcgatnx****
BackupId	string	否	您可在此參數中指定源執行個體的備份組ID，系統將使用該備份組中儲存的資料建立新執行個體。通過調用[DescribeBackups](~~473823~~)可查詢BackupId。如果源執行個體是叢集執行個體，則此處需要填寫源執行個體各個分區的備份組id，並且通過逗號隔開，例如"10,11,15**"。 > 若您的執行個體是雲原生架構執行個體，並且是叢集執行個體，則建議您使用[DescribeClusterBackupList](~~2679168~~)查詢出叢集備份組id，例如"cb-xx"，然後填入ClusterBackupId請求參數來達到複製叢集執行個體的目的，免去您輸入各個分區備份組id的煩惱。	111111111
InstanceType	string	否	執行個體類型，取值： * Redis（預設） * Memcache	Redis
EngineVersion	string	否	Redis經典版本，版本號碼取值： * 2.8（不推薦，[計劃停止全面支援](~~2674657~~)） * 4.0（不推薦） * 5.0 Redis雲原生版本，版本號碼取值： * 5.0 * 6.0（推薦） * 7.0 > 預設值為5.0。枚舉值： 4.0 : 4.0 5.0 : 5.0 6.0 : 6.0 7.0 : 7.0 2.8 : 2.8	5.0
PrivateIpAddress	string	否	指定新執行個體的內網IP地址。 > 內網IP需在執行個體所屬的交換器網段內。	172.16.0.***
AutoUseCoupon	string	否	是否使用代金券，取值： * true：使用代金券。 * false（預設）：不使用代金券。	false
AutoRenew	string	否	是否開啟自動續約，取值： * true：開啟。 * false（預設）：不開啟。	true
AutoRenewPeriod	string	否	自動續約周期，單位為月，取值：1、2、3、6、12。 > 當AutoRenew取值為true時，本參數必須傳入。	3
ResourceGroupId	string	否	資源群組ID。	rg-resourcegroupid1
RestoreTime	string	否	若源執行個體已開啟資料閃回，您可在此參數中指定源執行個體備份保留周期內的任意時間點，系統將使用源執行個體在該時間點的備份資料建立新執行個體。格式為yyyy-MM-ddTHH:mm:ssZ（UTC時間）。	2019-06-19T16:00:00Z
DedicatedHostGroupId	string	否	專屬叢集ID，在專屬叢集內建立Redis執行個體時需傳入本參數。	dhg-uv4fnk6r7zff****
ShardCount	integer	否	分區數，本參數僅適用於建立雲原生版叢集架構執行個體，您可以通過該參數實現自訂分區數量。	4
ReplicaCount	integer	否	主可用性區域的備節點，本參數僅適用於建立雲原生版叢集多副本執行個體，您可以通過該參數實現自訂備節點數量，取值：1~4。 > 若建立多可用性區域執行個體，您可以通過該參數與SlaveReplicaCount參數自訂主、備可用性區域的備節點數量。同時，該參數與SlaveReplicaCount參數的總和不能超過4。	2
SlaveReplicaCount	integer	否	備可用性區域的備節點數量。	2
ReadOnlyCount	integer	否	主可用性區域的唯讀節點數，本參數僅適用於建立雲原生讀寫分離執行個體。 * 若執行個體為標準架構，取值為1~9。 * 若執行個體為叢集架構，取值為1-4，表示每資料分區的唯讀節點數。 > 若建立多可用性區域執行個體，您可以通過該參數和SlaveReadOnlyCount參數自訂主備可用性區域的唯讀節點數量。 > - 若執行個體為標準架構，該參數與SlaveReadOnlyCount的總和不能大於9。 > - 若執行個體為叢集架構，該參數與SlaveReadOnlyCount的總和不能大於4。	2
SlaveReadOnlyCount	integer	否	備可用性區域的唯讀節點數量。	2
GlobalInstanceId	string	否	分布式執行個體ID，本參數僅適用於中國站。如需將新建立的Redis執行個體追加為分布式執行個體中的新子執行個體，本參數才可用且必須傳入。相關說明與控制台操作，請參見[為分布式執行個體添加子執行個體](~~106885~~)。	gr-bp14rkqrhac****
GlobalInstance	boolean	否	是否將本次建立的執行個體作為分布式執行個體中的第一個子執行個體，通過該方式可建立分布執行個體，取值： * true：作為第一個子執行個體。 * false（預設）：不作為第一個子執行個體。 > * 如需傳入true，本次建立的執行個體需為Tair記憶體型，引擎版本為5.0。 > * 本參數僅適用於中國站。	false
Port	string	否	執行個體的服務連接埠，取值範圍：1~65535，預設值為6379。	6379
DryRun	boolean	否	是否對本次建立執行個體的操作執行預檢查，取值： * true：執行預檢查操作，不建立執行個體。檢查專案包含請求參數、請求格式、業務限制和庫存。如果檢查不通過，則返回對應錯誤。如果檢查通過，則返回錯誤碼`DryRunOperation`。 * false（預設）：發送正常請求，通過檢查後直接建立執行個體。	false
GlobalSecurityGroupIds	string	否	執行個體的全域IP白名單模板，多個IP白名單模板請用英文逗號（,）分隔，不可重複。 >該參數僅適用於雲原生執行個體，經典版執行個體不支援白名單模板功能。>	g-zsldxfiwjmti0kcm****
Appendonly	string	否	指定新建立執行個體的AOF參數配置，取值： - yes（預設）：開啟AOF持久化。 - no：關閉AOF持久化。 > 該參數適用於經典版執行個體，雲原生版執行個體暫不支援指定AOF參數。枚舉值： no : 關閉AOF yes : 開啟AOF	yes
ConnectionStringPrefix	string	否	串連地址的首碼，需由小寫英文字母與數字組成，以小寫字母開頭，長度為8~40個字元。 > > 串連地址格式為：<首碼>.redis.rds.aliyuncs.com。	r-bp1zxszhcgatnx****
ParamGroupId	string	否	參數模板ID，全域唯一。>僅支援雲原生執行個體>	rpg-test**
Tag	array<object>	否	執行個體的標籤資訊。
	object	否	對象。
Key	string	否	標籤的鍵。 > * N表示傳入第幾個標籤的鍵，單個執行個體最多可綁定20個標籤。例如Tag.1.Key表示傳入第一個標籤的鍵；Tag.2.Key表示傳入第二個標籤的鍵。 > * 如果標籤的鍵不存在，則自動建立。	testkey
Value	string	否	標籤的值。 > N表示傳入第幾個標籤的值。例如Tag.1.Value表示傳入第一個標籤的值；Tag.2.Value表示傳入第二個標籤的值。	testvalue
ClusterBackupId	string	否	部分新叢集架構支援叢集備份組ID，您可以通過[DescribeClusterBackupList](~~2679168~~)介面擷取。 * 若支援，可輸入指定的叢集備份組ID即可，無需再填寫BackupId參數。 * 若不支援，請在BackupId參數中填寫為原執行個體各個分區下的備份組ID，通過逗號隔開，例如"2158\\\\20,2158\\\\22"等。	cb-hyxdof5x9kqb****
RecoverConfigMode	string	否	使用指定備份組建立執行個體時，是否從原備份組中恢複帳號（account）、核心參數（config）、白名單（whitelist）資訊。例如需恢複帳號資訊，則取值為`account`。預設為空白，表示不從原備份組中恢複帳號、核心參數、白名單資訊。 > 本參數僅適用於雲原生版執行個體，且需要原備份組中已儲存了帳號、核心參數、白名單資訊。您可以通過[DescribeBackups](~~473823~~)介面查詢指定備份組中的RecoverConfigMode參數是否包含上述資訊。	whitelist,config,account
InstanceEndpointType	string	否	建立雲原生雙可用性區域讀寫分離執行個體時，使用的串連地址類型。不顯式傳該參數時，值預設為AzIndependentEndpoint。 - AzIndependentEndpoint : 預設值。可用性區域獨立串連地址。主、備可用性區域分別提供獨立串連地址，可通過不同的串連地址實現可用性區域就近訪問。 - UnifiedEndpoint : 統一串連地址。提供統一的串連地址，通過該地址同時訪問到主備可用性區域的節點，但會出現跨可用性區域訪問。 >該參數僅適用於雲原生雙可用性區域讀寫分離執行個體。對於其他類型執行個體，僅支援可用性區域獨立串連地址，即使傳入UnifiedEndpoint也不會真正生效。> > UnifiedEndpoint 參數目前僅面向白名單使用者開放。非白名單使用者傳入該參數將導致調用報錯。如需開通使用許可權，請提交工單申請加白。>	AzIndependentEndpoint

建立Redis 7.0叢集架構的請求樣本如下。

{
  "RegionId": "cn-shenzhen",
  "InstanceName": "apitest",
  "Password": "D****23",
  "ZoneId": "cn-shenzhen-f",
  "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	Virtual Private Cloud的ID。	vpc-bp1nme44gek34slfc****
QPS	integer	每秒訪問次數，此處為當前規格執行個體的理論值。	100000
Capacity	integer	執行個體的儲存容量，單位：MB。	16384
ConnectionDomain	string	Redis執行個體的內網串連地址。	r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com
ChargeType	string	付費類型，傳回值： * PrePaid：預付費。 * PostPaid：隨用隨付。	PostPaid
NetworkType	string	網路類型，傳回值： * CLASSIC：傳統網路。 * VPC：專用網路。	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	執行個體所在地區。	cn-hongkong
EndTime	string	預付費執行個體到期時間，格式為yyyy-MM-ddTHH:mm:ssZ（UTC時間）。	2019-01-18T16:00:00Z
VSwitchId	string	虛擬交換器ID。	vsw-bp1e7clcw529l773d****
RequestId	string	請求ID。	5DEA3CC9-F81D-4387-8E97-CEA40F09****
NodeType	string	節點類型，傳回值： * STAND_ALONE：單副本。 * MASTER_SLAVE：雙副本。	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

樣本

正常返回樣本

JSON格式

{
  "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 status code	錯誤碼	錯誤資訊	描述
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.	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無效
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.

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

變更歷史

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