文档

ModifyInstanceSpec - 变更Redis实例的规格

更新时间:

变更Redis实例的规格。

接口说明

说明 关于变更实例规格的执行流程、影响、功能限制及费用说明,请参见变更实例配置

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
kvstore:ModifyInstanceSpecWrite
  • DBInstance
    acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID,可调用 DescribeRegions 查询,使用此参数指定要变更实例的地域。

cn-hangzhou
InstanceIdstring

实例 ID,可调用 DescribeInstances 获取。

r-bp1zxszhcgatnx****
InstanceClassstring

变更后的实例规格代码,您可以调用 DescribeAvailableResource 查询实例所属的可用区可以变配的规格。

说明 各规格的详情,请参见规格查询导航
redis.master.small.default
BusinessInfostring

活动 ID、业务信息。

000000001
CouponNostring

优惠码,默认值:youhuiquan_promotion_option_id_for_blank

youhuiquan_promotion_option_id_for_blank
ForceUpgradeboolean

是否强制变配,取值:

  • false:不强制变配。
  • true:强制变配,默认值。
true
EffectiveTimestring

变更执行时间,取值:

  • Immediately:立即执行,默认值。
  • MaintainTime:在实例的可维护时间段执行,您可以调用 ModifyInstanceMaintainTime 修改可维护时间段。
Immediately
AutoPayboolean

是否自动付款,取值:

  • true:自动付款,默认值。
  • false:手动付款。取值为 false 时,您需要在实例到期前通过控制台手动续费,详情请参见手动续费
true
OrderTypestring

变配类型,包年包月实例变配时需要传入本参数,取值:

  • UPGRADE:升级配置,默认值。
  • DOWNGRADE:降级配置。
说明
  • 包年包月实例降级配置时必须将该参数的值设置为 DOWNGRADE
  • 如果变配的目标规格比现有规格的价格高,则为升级配置,反之为降级配置。例如,读写分离 8G 版(5 只读节点)的价格比 16G 集群版的价格高,从后者变配到前者为升级配置。
  • DOWNGRADE
    MajorVersionstring

    变更配置的同时,可升级实例的大版本,传入要升级到的大版本号,取值4.05.06.07.0

    5.0
    ClientTokenstring

    用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过 64 个 ASCII 字符,且该参数值中不能包含非 ASCII 字符。

    ETnLKlblzczshOTUbOCz****
    SourceBizstring

    调用来源,本参数仅用于内部维护使用,无需传入。

    SDK
    ShardCountinteger

    分片数,本参数仅适用于云盘版集群架构实例,您可以通过该参数实现自定义分片数量。

    8
    ReadOnlyCountinteger

    主可用区的只读节点数,取值:0~5,本参数仅适用于如下情况:

    • 若实例为云盘版标准架构,您可以将该参数设置为大于 0 的值,开启读写分离架构。
    • 若实例为云盘版读写分离架构实例,您可以通过该参数实现自定义只读节点数量,也可以将该参数设置为 0,关闭读写分离架构,将实例切换为标准架构。
    5
    ForceTransboolean

    是否开启强制传输,取值:

    • false(默认):在变配前,系统会检查实例当前的内核小版本,若内核版本过低则会报错,您需要升级内核小版本后重试。
    • true:跳过检查项,直接执行变配操作。
    false
    SlaveReadOnlyCountinteger

    用于创建多可用区读写分离实例,指定备可用区的只读节点数量,取值为 1~9,但该参数与 ReadOnlyCount 的总和不能大于 9。

    2

    返回参数

    名称类型描述示例值
    object

    对象。

    OrderIdstring

    订单 ID。

    20722623431****
    RequestIdstring

    请求 ID。

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

    示例

    正常返回示例

    JSON格式

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

    错误码

    HTTP status code错误码错误信息描述
    400PaymentMethodNotFoundNo payment method has been registered on the account.帐户上没有登记付款方法。
    400HasRenewChangeOrderThis instance has a renewChange order.实例还有续费变配订单。
    400%sWarn: {%s} are not supported after upgraded. you can set forceUpgrade=true to force upgrade.-
    400GdcInstanceNotSupportThe gdc custins trans not support.-
    400AbnormalResourceStatusForRenewAbnormal resource status for renew.-
    400MissingRedisShardingUnsupportPerfItemThe metadb is missing redis sharding unsupoort command perf item.-
    400IllegalParamErrorAction or resource must not be null.-
    400IncorrectTargetMajorVersionCurrent target majorversion does not support this operation.-
    400IncorrectMinorVersionCurrent engine minor version does not support operations.当前实例小版本号不支持,请升级到最新小版本后重试
    400DirectTargetLevelNotSupportThe direct custins tranfer target instance level does not support.-
    400DirectTransPreCheckErrorThe direct custins trans pre check IsAddReduceNodes error.-
    400DtsOpendNotSupportTransThe custins DtsSyncStatus opend does not support trans.-
    400DirectTransNodeDoubleLevelErrorThe direct custins tranfer node double target level error.-
    400DirectTransUpgradeMajorVersionNotSupportThe direct custins tranfer does not support upgrade major version.-
    403TargetMemoryLessThanCurrentUsedThe target instance memory size below the current instance used memory.-

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

    变更历史

    变更时间变更内容概要操作
    2024-03-21OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
    入参OpenAPI 入参发生变更
      新增入参:NodeType
    2024-01-29OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
    入参OpenAPI 入参发生变更
      新增入参:SlaveReadOnlyCount
    2023-12-27OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
    2023-07-04OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
    入参OpenAPI 入参发生变更
      新增入参:ForceTrans
    2022-02-22OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
    • 本页导读 (1)
    文档反馈