Changes the configurations of an ApsaraDB for Redis instance.

Note For more information about the procedure, impacts, limits, and fees of this operation, see Change the configurations of an instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ModifyInstanceSpec

The operation that you want to perform. Set the value to ModifyInstanceSpec.

RegionId String No cn-hangzhou

The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.

InstanceId String Yes r-bp1zxszhcgatnx****

The ID of the instance. You can call the DescribeInstances operation to query the ID of the instance.

InstanceClass String No redis.master.small.default

The new instance type. You can call the DescribeAvailableResource operation to query the instance types available for configuration change within the zone to which the instance belongs.

Note For more information about the instance types, see Overview.
BusinessInfo String No 000000001

The ID of the promotional event or business information.

CouponNo String No youhuiquan_promotion_option_id_for_blank

The coupon code. Default value: youhuiquan_promotion_option_id_for_blank.

ForceUpgrade Boolean No true

Specifies whether to forcefully change the configurations of the instance. Default value: true. Valid values:

  • false: The system does not forcefully change the configurations.
  • true: The system forcefully changes the configurations.
EffectiveTime String No Immediately

The time when to change the configurations. Default value: Immediately. Valid values:

  • Immediately: The configurations are immediately changed.
  • MaintainTime: The configurations are changed within the maintenance window. You can call the ModifyInstanceMaintainTime operation to change the maintenance window.
AutoPay Boolean No true

Specifies whether to enable auto-renewal. Default value: true. Valid values:

  • true: enables auto-renewal.
  • false: disables auto-renewal. If you set this parameter to false, the instance must be manually renewed before it expires. For more information, see Renew an instance.
OrderType String No DOWNGRADE

The change type. This parameter is required when you change the configurations of a subscription instance. Default value: UPGRADE. Valid values:

  • UPGRADE: upgrades the configurations of a subscription instance.
  • DOWNGRADE: downgrades the configurations of a subscription instance.
Note
  • To downgrade a subscription instance, you must set this parameter to DOWNGRADE.
  • If the price of an instance increases after its configurations are changed, the instance is upgraded. If the price decreases, the instance is downgraded. For example, the price of an 8 GB read/write splitting instance with five read replicas is higher than that of a 16 GB cluster instance. If you want to change a 16 GB cluster instance to an 8 GB read/write splitting instance with five read replicas, you must upgrade the instance.
MajorVersion String No 5.0

The major version to which you want to upgrade. When you change the configurations of an instance, you can upgrade the major version of the instance by setting this parameter. Valid values: 4.0 and 5.0.

ClientToken String No ETnLKlblzczshOTUbOCz****

The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

SourceBiz String No SDK

The source of the operation. This parameter is used only for internal maintenance. You do not need to specify this parameter.

ShardCount Integer No 8

The number of shards. This parameter is available only for cluster instances that use cloud disks.

ReadOnlyCount Integer No 5

The number of read-only nodes. This parameter is available only for read/write splitting instances that use cloud disks. Valid values: 1 to 5.

Response parameters

Parameter Type Example Description
OrderId String 20722623431****

The ID of the order.

RequestId String 0DA1D7EF-C80D-432C-8758-7D225182626B

The ID of the request.

Examples

Sample requests

https://r-kvstore.aliyuncs.com/?Action=ModifyInstanceSpec
&InstanceId=r-bp1zxszhcgatnx****
&InstanceClass=redis.master.small.default
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<ModifyInstanceSpecResponse>
	<RequestId>A4828C10-AF0A-4CD7-8FBE-737C6CC1193E</RequestId>
	<OrderId>20722623431****</OrderId>
</ModifyInstanceSpecResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "A4828C10-AF0A-4CD7-8FBE-737C6CC1193E",
  "OrderId" : "20722623431****"
}

Error codes

HttpCode Error code Error message Description
400 PaymentMethodNotFound No payment method has been registered on the account. The error message returned because no payment method is specified for your account.
400 HasRenewChangeOrder This instance has a renewChange order. The error message returned because an order for renewal and configuration change already exists.
400 IncorrectMinorVersion Current engine minor version does not support operations. The error message returned because the minor version of the instance is not supported for this operation. Update the minor version and try again.

For a list of error codes, visit the API Error Center.