ModifyInstanceSpec - 變更執行個體規格 - Tair (Redis® OSS-Compatible)

變更雲資料庫 Tair（相容 Redis）執行個體的規格。

介面說明

說明

關於變更執行個體規格的執行流程、影響、功能限制及費用說明，請參見變更執行個體配置。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

kvstore:ModifyInstanceSpec

update

*DBInstance

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

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	否	地區 ID，可調用 DescribeRegions 查詢，使用此參數指定要變更執行個體的地區。	cn-hangzhou
InstanceId	string	是	執行個體 ID，可調用 DescribeInstances 擷取。	r-bp1zxszhcgatnx****
InstanceClass	string	否	變更後的執行個體規格代碼，您可以調用 DescribeAvailableResource 查詢執行個體所屬的可用性區域可以變更配置的規格。說明各規格的詳情，請參見規格查詢導航。	redis.master.small.default
BusinessInfo	string	否	活動 ID、商務資訊。	000000001
CouponNo	string	否	優惠碼，預設值：`youhuiquan_promotion_option_id_for_blank`。	youhuiquan_promotion_option_id_for_blank
ForceUpgrade	boolean	否	是否強制變更配置，取值： false：不強制變更配置。 true：強制變更配置，預設值。	true
EffectiveTime	string	否	變更執行時間，取值： Immediately：立即執行，預設值。 MaintainTime：在執行個體的可維護時間段執行，您可以調用 ModifyInstanceMaintainTime 修改可維護時間段。	Immediately
AutoPay	boolean	否	是否自動付款，取值： true：自動付款，預設值。 false：手動付款。取值為 false 時，您需要在執行個體到期前通過控制台手動續約，詳情請參見手動續約。	true
OrderType	string	否	變更配置類型，訂用帳戶執行個體變更配置時需要傳入本參數，取值： UPGRADE：升級配置，預設值。 DOWNGRADE：降級配置。說明訂用帳戶執行個體降級配置時必須將該參數的值設定為 DOWNGRADE。如果變更配置的目標規格比現有規格的價格高，則為升級配置，反之為降級配置。例如，讀寫分離 8G 版（5 唯讀節點）的價格比 16G 叢集版的價格高，從後者變更配置到前者為升級配置。枚舉值： DOWNGRADE : DOWNGRADE UPGRADE : UPGRADE	DOWNGRADE
MajorVersion	string	否	適用於經典版執行個體升級的執行個體大版本，取值：2.8、4.0或5.0。說明升級版本時 InstanceClass 參數為必填，表示本介面僅支援在更新執行個體規格時升級版本。若您僅需升級執行個體版本，請調用 ModifyInstanceMajorVersion 。	5.0
ClientToken	string	否	用於保證請求的等冪性。由用戶端產生該參數值，要保證在不同請求間唯一，最大值不超過 64 個 ASCII 字元，且該參數值中不能包含非 ASCII 字元。	ETnLKlblzczshOTUbOCz****
SourceBiz	string	否	調用來源，本參數僅用於內部維護使用，無需傳入。	SDK
ShardCount	integer	否	分區數，本參數僅適用於雲原生版叢集架構執行個體，您可以通過該參數實現自訂分區數量。說明如果要從雲原生版叢集架構執行個體變更配置到標準架構，ShardCount 需要顯式傳 1，並且規格傳標準規格。如果要從雲原生版標準架構執行個體變更配置到叢集架構，ShardCount 需要顯式傳大於 1 的值，並且規格傳叢集規格。	8
ReplicaCount	integer	否	主可用性區域的備節點數量，本參數僅適用於雲原生版叢集多副本執行個體，您可以通過該參數實現自訂備節點數量，取值：1~4。說明若執行個體為多可用性區域執行個體，您可以通過該參數與 SlaveReplicaCount 參數自訂主、備可用性區域的備節點數量。同時，該參數與 SlaveReplicaCount 參數的總和不能超過 4。	1
SlaveReplicaCount	integer	否	備可用性區域的備節點數量。	1
ReadOnlyCount	integer	否	主可用性區域的唯讀節點數，本參數僅適用於建立雲原生讀寫分離執行個體。若執行個體為標準架構，取值為 0-9，0 表示關閉讀寫分離，將執行個體切換為標準架構。若執行個體為叢集架構，取值為 1-4，表示每資料分區的唯讀節點數。說明若建立多可用性區域執行個體，您可以通過該參數和 SlaveReadOnlyCount 參數自訂主備可用性區域的唯讀節點數量。若執行個體為標準架構，該參數與 SlaveReadOnlyCount 的總和不能大於 9。若執行個體為叢集架構，該參數與 SlaveReadOnlyCount 的總和不能大於 4。	5
SlaveReadOnlyCount	integer	否	備可用性區域的唯讀節點數量。	2
ForceTrans	boolean	否	是否開啟強制傳輸，取值： false（預設）：在變更配置前，系統會檢查執行個體當前的核心小版本，若核心版本過低則會報錯，您需要升級核心小版本後重試。 true：跳過檢查項，直接執行變更配置操作。	false
NodeType	string	否	節點類型，取值： MASTER_SLAVE：高可用（雙副本） STAND_ALONE：單副本 double：雙副本 single：單副本說明雲原生版執行個體請選擇MASTER_SLAVE或STAND_ALONE，經典版執行個體請選擇 double 或 single。	MASTER_SLAVE
StorageType	string	否	儲存類型，取值為essd_pl1、essd_pl2、essd_pl3。說明當 InstanceType 取值為tair_essd時，且執行個體為 Tair 磁碟 ESSD 型時，才需要輸入本參數。	essd_pl1
Storage	integer	否	磁碟型執行個體的儲存空間，不同的規格取值範圍有所區別，詳情請參見磁碟型規格。說明當 InstanceType 取值為tair_essd時，且建立 Tair 磁碟 ESSD 型時，才需要輸入本參數。對於建立 Tair 磁碟 SSD 型執行個體，容量欄位按不同的規格定義為不同的固定值，無需指定該欄位。	60

返回參數

名稱	類型	描述	樣本值
	object	對象。
OrderId	string	訂單 ID。	20722623431****
RequestId	string	請求 ID。	0DA1D7EF-C80D-432C-8758-7D225182626B

樣本

正常返回樣本

JSON格式

{
  "OrderId": "20722623431****",
  "RequestId": "0DA1D7EF-C80D-432C-8758-7D225182626B"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	PaymentMethodNotFound	No payment method has been registered on the account.
400	HasRenewChangeOrder	This instance has a renewChange order.
400	%s	Warn: {%s} are not supported after upgraded. you can set forceUpgrade=true to force upgrade.
400	GdcInstanceNotSupport	The gdc custins trans not support.
400	AbnormalResourceStatusForRenew	Abnormal resource status for renew.
400	MissingRedisShardingUnsupportPerfItem	The metadb is missing redis sharding unsupoort command perf item.
400	IllegalParamError	Action or resource must not be null.
400	IncorrectTargetMajorVersion	Current target majorversion does not support this operation.	當前操作不支援所指定的目標大版本，請確保指定的目標大版本大於執行個體當前大版本
400	IncorrectMinorVersion	Current engine minor version does not support operations.	當前執行個體小版本號碼不支援，請升級到最新小版本後重試
400	DirectTargetLevelNotSupport	The direct custins tranfer target instance level does not support.
400	DirectTransPreCheckError	The direct custins trans pre check IsAddReduceNodes error.
400	DtsOpendNotSupportTrans	The custins DtsSyncStatus opend does not support trans.
400	DirectTransNodeDoubleLevelError	The direct custins tranfer node double target level error.	直連執行個體和全球多活執行個體在僅調整分區數時，需要指定為原分區數的2倍或0.5倍
400	DirectTransUpgradeMajorVersionNotSupport	The direct custins tranfer does not support upgrade major version.
403	TargetMemoryLessThanCurrentUsed	The target instance memory size below the current instance used memory.

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

變更歷史

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