变更Redis实例的规格。
接口说明
说明
关于变更实例规格的执行流程、影响、功能限制及费用说明,请参见变更实例配置。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
kvstore:ModifyInstanceSpec | update |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
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 |
ForceUpgrade | boolean | 否 | 是否强制变配,取值:
| true |
EffectiveTime | string | 否 | 变更执行时间,取值:
| Immediately |
AutoPay | boolean | 否 | 是否自动付款,取值:
| true |
OrderType | string | 否 | 变配类型,包年包月实例变配时需要传入本参数,取值:
说明
| DOWNGRADE |
MajorVersion | string | 否 | 适用于经典版实例升级的实例大版本,取值:2.8、4.0或5.0。 说明
升级版本时 InstanceClass 参数为必填,表示本接口仅支持在更新实例规格时升级版本。若您仅需升级实例版本,请调用 ModifyInstanceMajorVersion 。
| 5.0 |
ClientToken | string | 否 | 用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过 64 个 ASCII 字符,且该参数值中不能包含非 ASCII 字符。 | ETnLKlblzczshOTUbOCz**** |
SourceBiz | string | 否 | 调用来源,本参数仅用于内部维护使用,无需传入。 | SDK |
ShardCount | integer | 否 | 分片数,本参数仅适用于云原生版集群架构实例,您可以通过该参数实现自定义分片数量。 说明
| 8 |
ReadOnlyCount | integer | 否 | 主可用区的只读节点数,取值:0~5,本参数仅适用于如下情况:
| 5 |
ForceTrans | boolean | 否 | 是否开启强制传输,取值:
| false |
SlaveReadOnlyCount | integer | 否 | 用于创建多可用区读写分离实例,指定备可用区的只读节点数量,取值为 1~9,但该参数与 ReadOnlyCount 的总和不能大于 9。 | 2 |
NodeType | string | 否 | 节点类型,取值:
说明
云原生版实例请选择MASTER_SLAVE或STAND_ALONE,经典版实例请选择 double 或 single。
| MASTER_SLAVE |
返回参数
示例
正常返回示例
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. | - |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-03-21 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2024-01-29 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2023-12-27 | OpenAPI 错误码发生变更 | 查看变更详情 |
2023-07-04 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2022-02-22 | OpenAPI 错误码发生变更 | 查看变更详情 |