ModifyInstanceSpec变更实例规格-云数据库 Tair（兼容 Redis®）-阿里云-云数据库 Tair（兼容 Redis®）(Tair)-阿里云帮助中心

变更云数据库 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
SecondaryZoneId	string	否	当单可用区实例需要变配并迁移至多可用区时，必须指定备可用区 ID。可调用 DescribeZones 接口查询。说明本参数和 ZoneId 参数传入的值不能相同，且不可传入多可用区对应的 ID。	cn-hangzhou-h

返回参数

名称	类型	描述	示例值
	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.

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。