文档

ModifyDBNode - 变更RDS实例节点

更新时间:
重要

本文中含有需要您注意的重要提示信息,忽略该信息可能对您的业务造成影响,请务必仔细阅读。

该接口用于变更RDS MySQL集群系列实例节点的规格、存储类型、存储空间。

接口说明

适用引擎

  • RDS MySQL

相关功能文档

变更节点配置

警告 该 API 操作涉及费用,请仔细阅读相关功能文档后再进行操作。

调试

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

授权信息

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

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

请求参数

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

用于保证请求的幂等性。

ETnLKlblzczshOTUbOCzxxxxxxx
DBInstanceIdstring

实例 ID。

rm-bp1k8s41l2o52****
DBInstanceStorageTypestring

实例储存类型,取值:

  • cloud_essd:ESSD PL1 云盘
  • cloud_essd2:ESSD PL2 云盘
  • cloud_essd3:ESSD PL3 云盘
cloud_essd
DBInstanceStoragestring

新实例存储容量。单位:GB。详情请参见实例规格

20
DBNodeobject []

节点相关信息。

说明 该参数用于 MySQL 集群系列实例。
classCodestring

节点规格信息。

mysql.n2.medium.xc
nodeIdstring

节点 ID。

rn-6256r4a87xvv7****
EffectiveTimestring

生效时间,取值:

  • Immediate(默认值):立即生效。
  • MaintainTime:在可运维时间段内生效,请参见 ModifyDBInstanceMaintainTime。
Immediate
AutoPayboolean

是否自动支付。 取值范围:

  1. true:自动支付。您需要确保账户余额充足。

  2. false:只生成订单不扣费。

说明 默认值为 true。如果您的支付方式余额不足,可以将参数 AutoPay 设置为 false,此时会生成未支付订单,您可以登录 RDS 管理控制台自行支付。
true
DryRunboolean

是否对本次节点变更的操作执行预检查。取值范围:

  • true:执行预检查操作,不执行变更。检查项目包含请求参数、请求格式、业务限制和库存等。
  • false:发送正常请求,通过检查后直接执行变更(默认)。
false
ProduceAsyncboolean

是否异步执行生产。取值范围:

  • true:请求只下发订单,变更操作会异步执行(默认)。
  • false:请求下发的同时,通过检查后直接执行变更。
说明 默认值为 true,变更操作异步执行。如果设置为 false,变更操作同步执行,接口响应时间会相对较长。
true

返回参数

名称类型描述示例值
object

返回信息。

RequestIdstring

请求 ID。

5CD61041-35F7-10F7-BE94-33A48B221218
DBInstanceIdstring

实例 ID。

rm-uf6wjk5****
OrderIdlong

订单 ID。

20793850608****
Successboolean

表示请求是否成功,各取值含义如下:

  • true:成功
  • false:失败
true

示例

正常返回示例

JSON格式

{
  "RequestId": "5CD61041-35F7-10F7-BE94-33A48B221218",
  "DBInstanceId": "rm-uf6wjk5****",
  "OrderId": 0,
  "Success": true
}

错误码

HTTP status code错误码错误信息描述
400DBNodeFormatFaultThe specified parameter DBNode is malformeddbNode格式不正确
400DBNodeParameterRequiredThe specified parameter DBNode is required.缺少dbNode参数
400DBNodeIdParameter.NotExistsThe specified DBNodeId is not existed.-
400SecondaryClassCode.UnsupportedAt least one secondary node has the same classCode as the primary node.至少有一个备节点的规格是与主节点一致的
400IncorrectDBInstanceStateThe current instance state does not support this operation.当前实例状态不支持此操作。
400InvalidDBInstanceName.NotFoundThe specified DB instance name does not exist.数据库实例名称不存在,请检查。
400InvalidNodeIdParameter node id is not valid.参数nodeId无效。
400SlaveClassCode.UnsupportedNeed at least one secondary's class_code same as primary's.至少需要一个备节点与主节点规格一致。
400InvalidDBInstanceStorageThe specified DBInstanceStorage is invalid.指定的数据库实例存储无效
400UnsupportedOperationDirection.DiskUpgradeThe specified operation is not allowed, class and storage can only modify to one direction, current class: DOWNGRADE.不允许当前操作,存储和规格必须是同方向变更,当前规格是降配。
400UnsupportedOperationDirection.DiskDowngradeThe specified operation is not allowed, class and storage can only modify to one direction, current class: UPGRADE不允许当前操作,存储和规格必须是同方向变更,当前规格是升配。
400InvalidDBInstanceStorageTypeThe specified DBInstanceStorageType is invalid.指定的数据库实例存储类型无效
400InvalidMultiTenantMulti tenants cannot exist in a same instance.一个实例中不允许存在多种租户类型的节点。
400DBNodeParameter.InvalidCombinationDBNode class code combination is not valid.DBNode参数包含无效的规格码组合。
400InvalidClassCodeThe specification code in the parameter is invalid.参数中的规格码是无效的。
400Commodity.InvalidComponentThe module you purchased is not legal, please buy it again.您购买的模块不合法,请重新购买。
400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.套餐实例不允许单独操作。
400Price.PricingPlanResultNotFoundPricing plan price result not found.定价计划价格结果没有找到。
400Order.NoRealNameAuthenticationYou have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。
400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.您的账户可用额度小于0,请先充值后再尝试购买。
400CommodityServiceCalling.ExceptionFailed to call commodity service.调用商品服务返回失败。
400RegionDissolvedEOMDear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.客户您好,阿里云计划对当前地域进行优化调整,该区域云服务将停止运营,为确保您的业务连续性及数据迁移工作的平稳过渡,您目前无法操作新购类型的订单,感谢理解与支持。
400RegionEndTimeDissolvedIndiaCloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.客户您好,印度地域裁撤,购买的服务效期不能超过2024.07.15。
400RegionEndTimeDissolvedAustraliaCloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.客户您好,澳洲地域裁撤,购买的服务效期不能超过2024.09.30
400Price.CommoditySysCommodity system call exception.商品系统调用异常。
400Pay.InsufficientBalanceInsufficient available balance.可用金不足。
400Order.PeriodInvalidThere is a problem with the period you selected, please choose again.您选购的周期有问题,请重新选购。
400pay.noCreditCardAccount not bound to credit card.账户未绑定信用卡。
400Order.InstHasUnpaidOrderThere is an unpaid order for the service you have purchased. Please pay or void it before placing the order.您选购的服务存在未支付订单,请支付或作废后再下单。
400noAvailablePaymentMethodNo payment method is specified for your account. We recommend that you add a payment method.没有为您的帐户指定付款方式。我们建议您添加一种付款方式。
400BasicInfoUncompletedYour information is incomplete. Complete your information before the operation.您的基本信息未完善,请在操作前先完善您的基本信息。
400Risk.RiskControlRejectionYour account is abnormal, please contact customer service for details.您的账户出现异常,详情请联系客服。
400BasicInfoUncompletedYour information is incomplete, Complete your information before the operation.您的信息不完整,请在操作前填写您的信息。
400System.SaleValidateFailedSales expression validation system error.销售表达式校验系统错误。
403InvalidSaleComponentFaultThe request not refer to the correct order sale component. please contact customer service.询价失败,请联系客服同学。
403OrderStatus.UnPaidThe specified db instance has unpaid order.实例当前存在未支付订单,请支付后重试。
404InvalidDBInstance.NotFoundThe specified instance does not exist or is not supported.没有找到指定的实例,请检查实例的正确性。
404InsufficientResourceCapacityCurrent cluster resources are insufficient. Try again later.当前集群的资源不足,请您稍后再试。

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

变更历史

变更时间变更内容概要操作
2024-04-16OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:404
2023-11-23OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
入参OpenAPI 入参发生变更
    新增入参:EffectiveTime
2023-10-21OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:404
  • 本页导读 (1)
文档反馈