ModifyDBInstanceConfig - 修改RDS实例的配置项 - 云数据库 RDS

该接口用于修改RDS实例的配置项。

接口说明

适用引擎

RDS PostgreSQL
RDS SQL Server

说明

当前支持的配置项为RDS PostgreSQL PgBouncer 功能、RDS PostgreSQL 云盘加密功能、RDS SQL Server 云盘加密功能和RDS SQL Server 错误日志清理功能。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

rds:ModifyDBInstanceConfig

none

*DBInstance

acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}

无

请求参数

名称	类型	必填	描述	示例值
DBInstanceId	string	是	实例 ID。可调用 DescribeDBInstances 获取。	pgm-2ze****
ConfigName	string	是	待修改的配置项名称，配合 ConfigValue 使用。 RDS PostgreSQL 配置项 pgbouncer：修改 PgBouncer 功能。 encryptionKey：修改云盘加密功能。 duckdb_create_databases: 批量配置主实例数据库为 DuckDB 列存库。 duckdb_prepare_dependency: 一键配置主实例使其参数、内核小版本满足创建 DuckDB 分析实例的前提条件。如果主实例已创建了只读实例，会将只读实例同步修改。 enable_db_visible_by_connect_rls: 实例开启 CONNECT RLS 控制数据库可见性。 set_db_visible_by_connect_rls: 数据库开启 CONNECT RLS 控制数据库可见性，只有实例开启 CONNECT RLS 后才可调用。 RDS SQL Server 配置项 clear_errorlog：清理错误日志。 encryptionKey：修改云盘加密功能。Serverless 实例和共享规格实例暂不支持开启该功能。	pgbouncer
ConfigValue	string	是	待修改配置项的取值，配合 ConfigName 使用。 RDS PostgreSQL 配置项取值 PgBouncer 功能：true（开启）、false（关闭）。云盘加密功能： ServiceKey：使用由阿里云自动生成的密钥，即使用 RDS 托管的服务密钥（Default Service CMK）开启云盘加密。 <密钥>：使用自定义密钥开启云盘加密，或者更换当前密钥。例如`494c98ce-f2b5-48ab-96ab-36c986b6**`。 disabled：关闭云盘加密。一键修复创建 DuckDB 分析实例所需的前提条件: duckdb_prepare_dependency 批量设置主实例数据库为 DuckDB 列存库，JSON 字符串，例如`{"dbNames": "db1,db2,db3", "accountName": "yourSuperAccountName"}`，其中： dbNames：要转为 DuckDB 列存库的数据库名称。多个数据库之间使用英文逗号（,）分隔。 accountName：高权限账号。只需配置一个高权限账号。实例开启 CONNECT RLS 控制数据库可见性：true 开启。数据库开启 CONNECT RLS 控制数据库可见性：受 CONNECT RLS 管控数据库名称。多个数据库之间使用英文逗号（,）分隔。如 testdb1,testdb2。客户连接开启 CONNECT RLS 的数据库会根据是否对其他数据库有 CONNECT 权限而正确展示数据库列表。 RDS SQL Server 配置项取值错误日志清理功能：1（确认清理）。云盘加密功能（该功能开启后无法关闭）： serviceKey：使用由阿里云自动生成的密钥，即使用 RDS 托管的服务密钥（Default Service CMK）开启云盘加密。 <密钥>：使用自定义密钥开启云盘加密，或者更换当前密钥。例如`494c98ce-f2b5-48ab-96ab-36c986b6**`。	true
ResourceGroupId	string	否	资源组 ID。可调用 DescribeDBInstanceAttribute 获取。	rg-bp67acfmxazb4p****
ClientToken	string	否	用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过 64 个 ASCII 字符，且该参数值中不能包含非 ASCII 字符。	6000170000591aed949d0f****
SwitchTime	string	否	指定执行修改的时间。建议在业务低峰期执行变配。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2025-05-06T09:24:00Z
SwitchTimeMode	string	否	切换时间。取值： Immediate：立即生效。 MaintainTime：在可运维时间段内生效，可调用 ModifyDBInstanceMaintainTime 接口修改可运维时间段。	Immediate

返回参数

名称	类型	描述	示例值
	object	返回参数详情。
RequestId	string	请求 ID。	76364A52-E0AB-5CC8-9818-CF1DC482C092

示例

正常返回示例

JSON格式

{
  "RequestId": "76364A52-E0AB-5CC8-9818-CF1DC482C092"
}

错误码

HTTP status code	错误码	错误信息	描述
400	%s	DB Operation Failed:%s.
400	InvalidDBInstanceName.NotFound	The specified DB instance name does not exist.	数据库实例名称不存在，请检查。
400	MinorVersionNotSupport	The current database minor version does not support the operation.	当前实例内核小版本不支持该操作，可尝试升级内核小版本。
400	InvalidConfigName	The ConfigName is not valid.	ConfigName无效。
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	InvalideStatus.Format	The instance status does not support this operation.	实例状态不支持此操作。
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	InvalidSourceCategory	specified source category is invalid.	指定的源类别无效。
400	InvalidParameter	Invalid parameter.	无效的参数。
400	InvalidConfigValue	The ConfigValue is not valid.	操作失败，指定的参数配置无效。
400	InvalidParameters.Format	Specified parameters is not valid.	无效的参数。
400	DuckDBOperationConflictBetweenPrimaryAndReadOnlyInstance	Current instance is already attached to another duckdb instance, operation is conflict.	当前实例已经关联了另一个 DUCKDB 实例，这和当前的 DUCKDB 操作冲突了
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	Current DB instance type does not support this operation.	操作失败，该实例状态下不支持此操作。
403	IncorrectDBInstanceLockMode	Current DB instance lock mode does not support this operation.
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.	当前实例状态不支持此操作。
403	CloudDiskEncryptionNotSupport	The encryption key is not allowed for general-purpose instance.	通用型规格实例不支持云盘加密。
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	IncorrectMinorVersion	Current engine minor version does not support operations.	当前引擎小版本不支持此操作。
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.	当前数据库实例级别不支持此操作。
403	UnsupportedByBlueGreenDeployment	Operation prohibited due to blue green deployment.	操作不允许因为存在蓝绿部署。
403	EncryptionKeyNotSupport	The encryption key is not support to generate encryption disk.	该密钥不支持创建云盘加密实例。
403	IncorrectDBState	The current DB state does not support this operation.	操作失败，当前数据库状态不正确。例如，数据库正在创建中或者正在上云中。
403	UnsupportedReadOrBakReadState	Current DB instance has read or bak read running in unsupport states	当前DB实例已在不支持状态下运行read或bak read
403	IncorrectAccountPrivilegeType	the current account privilege type does not support this operation.	当前账户权限类型不支持此操作
403	DBInstanceStatusNotActive	The status of the current instance is not active.	操作失败，请检查实例运行状态。
403	ReadOnlyInstanceNotSupport	Read-only instance does not support this operation.	只读实例不支持此操作。
403	Invalid.Parameter	Specified parameters is not valid.	指定的参数无效。
403	TargetMajorVesionNotSupported	The specified major version is not supported.	目标大版本不支持
403	ReadInstanceNotSupport	Instances with read-only do not support this operation.	带只读的实例不支持此操作。
403	IncorrectDBInstance	The current DB instance does not support this operation.	操作失败，当前实例不支持此操作。
404	InvalidDBInstance.NotFound	Specified instance does not exist or not support.	指定的实例不存在指定的实例被删除或者实例不支持当前操作。
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.	指定的主机信息不存在。
404	InvalidAccountName.NotFound	The specified account is not found.	未找到该账户。如果您是在做创建账号或者重置密码等操作，请指定您的账号。
404	InvalidReadDBInstance.NotFound	The specified read only database instance does not exist.	只读实例未创建或请求实例参数有误。

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

变更历史

更多信息，参考变更详情。