Changes the specifications of an ApsaraDB for Redis instance.
Operation description
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
kvstore:ModifyInstanceSpec | update |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
RegionId | string | No | The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
InstanceId | string | Yes | The ID of the instance. You can call the DescribeInstances operation to query the ID of the instance. | r-bp1zxszhcgatnx**** |
InstanceClass | string | No | 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 .
| redis.master.small.default |
BusinessInfo | string | No | The ID of the promotional event or business information. | 000000001 |
CouponNo | string | No | The coupon code. Default value: | youhuiquan_promotion_option_id_for_blank |
ForceUpgrade | boolean | No | Specifies whether to forcefully change the configurations of the instance. Default value: true. Valid values:
| true |
EffectiveTime | string | No | The time when to change the configurations. Default value: Immediately. Valid values:
| Immediately |
AutoPay | boolean | No | Specifies whether to enable auto-renewal. Default value: true. Valid values:
| true |
OrderType | string | No | The change type. This parameter is required when you change the configurations of a subscription instance. Default value: UPGRADE. Valid values:
Note
| DOWNGRADE |
MajorVersion | string | No | The major version to which you want to upgrade the instance. When you change the configurations of an instance, you can upgrade the major version of the instance by setting this parameter. Valid values: 2.8, 4.0, and 5.0. We recommend that you upgrade the major version to 5.0. | 5.0 |
ClientToken | string | No | 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. | ETnLKlblzczshOTUbOCz**** |
SourceBiz | string | No | The source of the operation. This parameter is used only for internal maintenance. You do not need to specify this parameter. | SDK |
ShardCount | integer | No | The number of shards. This parameter is available only for cluster instances that use cloud disks. | 8 |
ReadOnlyCount | integer | No | The number of read replicas in the primary zone. Valid values: 0 to 5. This parameter applies only to the following scenarios:
| 5 |
ForceTrans | boolean | No | Specifies whether to enable forced transmission during a configuration change. Valid values:
| false |
SlaveReadOnlyCount | integer | No | The number of read replicas in the secondary zone. This parameter is used to create a read/write splitting instance that is deployed in multiple zones. Valid values: 1 to 9. The sum of the SlaveReadOnlyCount and ReadOnlyCount values cannot be greater than 9. | 2 |
NodeType | string | No | The node type. Valid values:
Note
For cloud-native instances, set this parameter to MASTER_SLAVE or STAND_ALONE. For classic instances, set this parameter to double or single.
| MASTER_SLAVE |
Response parameters
Examples
Sample success responses
JSON
format
{
"OrderId": "20722623431****",
"RequestId": "0DA1D7EF-C80D-432C-8758-7D225182626B"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | PaymentMethodNotFound | No payment method has been registered on the account. | No payment methods are specified for your account. |
400 | HasRenewChangeOrder | This instance has a renewChange order. | An order for renewal and configuration change already exists. |
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. | the current operation does not support the specified target major version. make sure that the specified target major version is greater than the current major version of the instance. |
400 | IncorrectMinorVersion | Current engine minor version does not support operations. | The operation is not supported by the minor version of the instance. Update the instance to the latest minor version and try again. |
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. | When adjusting only the number of shards for directly connected instances and global multi-active instances, you need to specify 2 or 0.5 times the original number of shards. |
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. | - |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2024-03-21 | The Error code has changed. The request parameters of the API has changed | View Change Details |
2024-01-29 | The Error code has changed. The request parameters of the API has changed | View Change Details |
2023-12-27 | The Error code has changed | View Change Details |
2023-07-04 | The Error code has changed. The request parameters of the API has changed | View Change Details |
2022-02-22 | The Error code has changed | View Change Details |