该接口用于修改RDS实例的参数值。
接口说明
适用引擎
RDS MySQL
RDS PostgreSQL
RDS SQL Server
RDS MariaDB
相关功能文档
重要 使用该接口前，请仔细阅读功能文档，确保完全了解使用接口的前提条件及使用后造成的影响后，再进行操作。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
rds:ModifyParameter |
update |
*DBInstance
|
|
无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ClientToken |
string |
否 |
用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过 64 个 ASCII 字符，且该参数值中不能包含非 ASCII 字符。 |
ETnLKlblzczshOTUbOCz**** |
| DBInstanceId |
string |
是 |
实例 ID。 |
rm-uf6wjk5**** |
| Parameters |
string |
否 |
参数及其值的 JSON 串，参数的值都是字符串类型。格式：{"参数名称 1":"参数值 1","参数名称 2":"参数值 2"...}。可调用 DescribeParameterTemplates 查询参数名称和参数值。 说明
传入该参数，则无需传入参数 ParameterGroupId。 |
{"delayed_insert_timeout":"600","max_length_for_sort_data":"2048"} |
| Forcerestart |
boolean |
否 |
修改参数是否重启数据库，取值：
默认值：false。 |
false |
| ParameterGroupId |
string |
否 |
参数模板 ID。 说明
|
rpg-**** |
| SwitchTimeMode |
string |
否 |
修改参数的执行时间，取值：
枚举值：
|
ScheduleTime |
| SwitchTime |
string |
否 |
指定修改参数的执行时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。 说明
该时间必须大于当前时间（执行调用的时间）。 |
2022-05-06T09:24:00Z |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回参数详情。 |
||
| RequestId |
string |
请求 ID。 |
542BB8D6-4268-45CC-A557-B03EFD7AB30A |
示例
正常返回示例
JSON格式
{
"RequestId": "542BB8D6-4268-45CC-A557-B03EFD7AB30A"
}异常返回示例
JSON格式
{
"RequestId": "7463B73D-35CC-4D19-A010-6B8D65D242EF",
"HostId": "rds.aliyuncs.com",
"Code": "UnsupportedOperation",
"Message": "The specified action is not supported."
}错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | PendingActionOverdue | the action execution time is already overdue | 选择的执行时间已过期 |
| 400 | EngineMigration.ActionDisabled | Specified action is disabled while custins is in engine migration. | 实例在引擎迁移中时，指定的操作被禁用。 |
| 400 | %s |
The following parameters are prohibited: %s |
|
| 400 | Invalid.ParamGroupDBCategory | ParamGroup category is basic, not standard. | 参数组类别是基本的，而不是标准的。 |
| 400 | InvalidEffectiveTime.SpecialTimeIsNull | SpecialTime is not valid. | SpecialTime无效。 |
| 400 | InvalidParameters.Format | Specified parameters is not valid. | 无效的参数。 |
| 400 | StorageEngine.NotSupported | Current instance storage engine dose not support this operation. | 当前实例的存储引擎不支持该操作。 |
| 400 | InvalideStatus.Format | The instance status does not support this operation. | 实例状态不支持此操作。 |
| 400 | SystemParamGroupCode.Format | Specific DBParamGroupId is not valid. | 创建参数 DBParamGroupId 无效。 |
| 400 | Database.ConnectError | Database connect error. please check instance status and database processlist | 数据库连接异常，请检查实例状态及数据库的连接池 |
| 400 | InvalidInstanceParameter | Specified name for the instance parameter is not valid. | 实例参数指定的名称无效。 |
| 400 | GroupReplicationNotSupport.InvalidParameters | Group Replication limits parameters and does not support modification. | Group Replication 对参数有限制，不支持修改。 |
| 400 | Order.ComboInstanceNotAllowOperate | A package instance is not allowed to operate independently. | 套餐实例不允许单独操作。 |
| 400 | Price.PricingPlanResultNotFound | Pricing plan price result not found. | 定价计划价格结果没有找到。 |
| 400 | Order.NoRealNameAuthentication | You 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. | 您还未通过实名认证，不符合购买条件，请登录费用与成本进行实名认证。 |
| 400 | InsufficientAvailableQuota | Your account quota limit is less than 0, please recharge before trying to purchase. | 您的账户可用额度小于0，请先充值后再尝试购买。 |
| 400 | CommodityServiceCalling.Exception | Failed to call commodity service. | 调用商品服务返回失败。 |
| 400 | RegionDissolvedEOM | Dear 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. | 客户您好，阿里云计划对当前地域进行优化调整，该区域云服务将停止运营，为确保您的业务连续性及数据迁移工作的平稳过渡，您目前无法操作新购类型的订单，感谢理解与支持。 |
| 400 | Commodity.InvalidComponent | The module you purchased is not legal, please buy it again. | 您购买的模块不合法，请重新购买。 |
| 400 | RegionEndTimeDissolvedAustralia | Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024. | 客户您好，该地域已裁撤。 |
| 400 | Price.CommoditySys | Commodity system call exception. | 商品系统调用异常。 |
| 400 | Pay.InsufficientBalance | Insufficient available balance. | 可用金不足。 |
| 400 | Order.PeriodInvalid | There is a problem with the period you selected, please choose again. | 您选购的周期有问题，请重新选购。 |
| 400 | pay.noCreditCard | Account not bound to credit card. | 账户未绑定信用卡。 |
| 400 | Order.InstHasUnpaidOrder | There is an unpaid order for the service you have purchased. Please pay or void it before placing the order. | 您选购的服务存在未支付订单，请支付或作废后再下单。 |
| 400 | noAvailablePaymentMethod | No payment method is specified for your account. We recommend that you add a payment method. | 没有为您的账户指定付款方式。我们建议您添加一种付款方式。 |
| 400 | BasicInfoUncompleted | Your information is incomplete. Complete your information before the operation. | 您的基本信息未完善，请在操作前先完善您的基本信息。 |
| 400 | Risk.RiskControlRejection | Your account is abnormal, please contact customer service for details. | 您的账户出现异常，详情请联系客服。 |
| 400 | Api.NotSupport | Specified api is not supported. | 当前接口不支持。 |
| 400 | ContainForbiddenLabelError | There is a label that prohibits placing orders. Please contact your distributor for assistance. | 存在禁止下单的标签，请联系您的分销商处理 |
| 400 | InvalidDBInstanceId.NotFound | The DBInstanceId provided does not exist in records. | 提供的DBInstanceId不存在。 |
| 400 | InvalidInstanceLevel.DiskType | Specified instance level not support request disk type | 当前实例规格不支持该存储类型。 |
| 400 | InvalidParam | Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica. | 指定的 wal_level 参数无效。实例中仍然存在复制槽，因此无法将其设置为replica。 |
| 400 | KmsApiError | User secret key invalid. | 用户密钥失效。 |
| 400 | System.SaleValidateFailed | Sales expression validation system error. | 销售表达式校验系统错误。 |
| 400 | Abs.InvalidAccount.NotFound | account is not found. | 账户不存在。 |
| 400 | SqlExecuteFailedOrTimeout | sql command execution failed or timed out:%s. | sql命令执行失败或执行超时 |
| 400 | ColdData.EngineVersionNotSupport | The current instance engine version not support coldDataEnabled. | 当前实例引擎版本不支持归档冷数据。 |
| 400 | ColdData.MinorVersionNotSupport | The current instance minor version not support coldDataEnabled. | 当前内核版本不支持归档冷数据。 |
| 400 | IncorrectTargetClasscode | The current instance type does not support this operation. | 当前规格不支持此操作。 |
| 400 | InvalidConnectionString.Duplicate | Specified connection string already exists in the RDS. | 链接地址名重复，请重新设置连接字符串。 |
| 400 | RequiredParam.NotFound | Required input param is not found. | 没有传入必要的参数。 |
| 400 | Parameters.Invalid | Parameter error, please check the parameters. | 参数错误，请检查参数。 |
| 400 | BackupPolicyNotSupport | Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy. | 数据归档不支持跨地域备份和秒级快照，请检查备份策略。 |
| 400 | InvalidReleasedKeepPolicy.Format | Specified Released Keep Policy is not valid. | 实例释放后的归档备份保留策略无效。 |
| 400 | InvalidDBInstanceEngineType.Format | the DB instance engine type does not support this operation. | DB实例引擎类型不支持此操作。 |
| 400 | Pay.NoCreditCard | No credit cards. | 无信用卡。 |
| 400 | VpcNetworkTypeNotSupport | The vpc network type instance does not support this operation. | vpc网络类型实例不支持此操作。 |
| 400 | MirrorInsExists | Specified DB instance mirror ins already existed. | 当前数据库实例镜像已存在。 |
| 400 | UnsupportedClassCode | The specified DB instance class stops selling. | 实例规格停止售卖。 |
| 400 | InvalidBackupSet | The specified database does not exist in the backup set. | 备份集中没有指定的数据库。 |
| 400 | OrdTCommodityQueryError | Failed to query for product. | 查询产品失败。 |
| 400 | ProductInstanceReleased | The instance has been released. Please check before placing the order. | 实例已释放，请核实后下单。 |
| 400 | RegionEndTimeDissolvedIndia | The region is no longer supported. | 指定的地域无效。 |
| 400 | OperationDenied.XengineSwitch | Current custins can not turn off xengine param. | 当前实例存在 xengine 表，无法切换到其他参数模板。 |
| 400 | InvalidParameterValue.Limit | Parameter value exceeds limit. | 参数值超过限制。 |
| 500 | ExternalFailure | The request processing has failed due to external service failure. | 请求服务失败，请稍后重试。 |
| 500 | RequestMetaDataFailed | The service request failed. Please try again later or contact service personnel. | 请求服务失败，请稍后再试或联系服务人员。 |
| 500 | InvokeProxyFailure | The request processing has failed due to service failure of rds api. | 由于rds api服务失败，请求处理失败。 |
| 403 | IncorrectDBInstanceType | The current database instance type does not support the operation. | 当前数据库实例类型不支持此操作。 |
| 403 | IncorrectDBInstanceState | The current database status does not support the operation. | 操作失败，该实例状态下不支持此操作。 |
| 403 | ParamNotSupportedForCurrentVersion | Parameter is not supported for current version. | |
| 403 | Invalid.Parameter | Specified parameters is not valid. | 指定的参数无效。 |
| 403 | IncorrectEffectiveTime | The specified EffectiveTime params is not valid. | EffectiveTime参数无效。 |
| 403 | GroupReplicationNotSupport.InvalidEngineVersion | Group Replication requires the instance engine version to be 8.0. | 实例数据库版本不是MySQL 8.0，不支持组复制。 |
| 403 | GroupReplicationNotSupport.InvalidNodeClassCode | Group Replication requires the ClassCode of each node to be consistent. | 实例各节点间规格不一致，不支持组复制。 |
| 403 | GroupReplicationNotSupport.InvalidNodeNum | Group Replication is not supported, the number of nodes must be an odd number greater than or equal to 3. | 实例节点个数不是大于等于3的单数，不支持组复制。 |
| 403 | GroupReplicationNotSupport.InvalidXengine | Group Replication is not supported because the instance has xengine tables. | 实例存在xengine引擎表，不支持组复制。 |
| 403 | GroupReplicationNotSupport.MemoryTooSmall | Group Replication is not supported because the memory is too small. | 实例规格内存太小，不支持组复制。 |
| 403 | IncorrectMinorVersion | Current engine minor version does not support operations. | 当前引擎小版本不支持此操作。 |
| 403 | GroupReplicationNotSupport.TableWithoutPrimaryKey | Group Replication is not supported because the instance exists table has no primary key. | 实例存在无主键的表，不支持组复制。 |
| 403 | IncorrectDBInstance | The current DB instance does not support this operation. | 操作失败，当前实例不支持此操作。 |
| 403 | OrderStatus.UnPaid | The specified db instance has unpaid order. | 实例当前存在未支付订单，请支付后重试。 |
| 403 | InvalidReduceDiskSize | The storage capacity after the scale-down must be larger than the used amount. | 缩容目标容量不能小于当前存储空间使用量 |
| 403 | CloudSSDNotSupport | Cloud ssd does not support this operation, please upgrade to essd. | SSD盘不支持此操作，请升级至ESSD。 |
| 403 | InvalidUserOperatorPermission | The user permission does not support this operation. | 用户权限不支持此操作。 |
| 403 | InvalidVswitchId | Specified conn vswitch id is not valid. | 指定的VSwitchId格式不正确或为空 |
| 403 | OperationDenied.ZoneResource | There is no available zone for inventory. | 没有可用的库存区域。 |
| 403 | NotInFlowController | Sorry,no permission. | 非集团上云用户不可用，无权限。 |
| 403 | InvalidKmsKey | Kms key is disabled. | Kms key已禁用。 |
| 403 | InvalidInstanceLevel.Malformed | Current DB instance level does not support this operation. | 当前数据库实例级别不支持此操作。 |
| 404 | InvalidDBInstance.NotFound | The specified instance does not exist or is not supported. | 没有找到指定的实例，请检查实例的正确性。 |
| 404 | InvalidParam | Sepcified wal_level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica. | 指定的wal_level参数无效。实例中有此参数，因此无法替换。 |
| 404 | InvalidClusterKms | The current instance does not authorized to access the Key Management Service. | 当前实例未授权访问密钥管理服务。 |
| 404 | Request.NotFound | The requested resource is not available. | 请求的资源不可用。 |
| 404 | HostInfo.NotFound | The specified host info is not found. | 指定的主机信息不存在。 |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。