ModifyDBInstanceConfig - ApsaraDB RDS - Centro de documentación de Alibaba Cloud

Modifica los elementos de configuración de una instancia de ApsaraDB RDS.

Descripción de la operación

Motores compatibles

ApsaraDB RDS for PostgreSQL
ApsaraDB RDS for SQL Server

Nota

Actualmente, los elementos de configuración compatibles incluyen PgBouncer de ApsaraDB RDS for PostgreSQL, cifrado de discos en la nube de ApsaraDB RDS for PostgreSQL, cifrado de discos en la nube de ApsaraDB RDS for SQL Server y limpieza de registros de errores de ApsaraDB RDS for SQL Server.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

rds:ModifyDBInstanceConfig

none

*DBInstance.

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

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
DBInstanceId	string	Sí	El ID de la instancia. Puede llamar a DescribeDBInstances para obtener el ID de la instancia.	pgm-2ze****
ConfigName	string	Sí	El nombre del elemento de configuración que se va a modificar. Este parámetro se utiliza junto con ConfigValue. Elementos de configuración de ApsaraDB RDS for PostgreSQL pgbouncer: Modifica la función PgBouncer. encryptionKey: Modifica la función de cifrado de disco en la nube. duckdb_create_databases: Configura las bases de datos de la instancia principal como bases de datos de almacenamiento columnar de DuckDB en lotes. duckdb_prepare_dependency: Configura la instancia principal con un solo clic para que sus parámetros y versión secundaria del motor cumplan con los requisitos previos para crear una instancia analítica basada en DuckDB. Si la instancia principal ya tiene instancias de solo lectura, las instancias de solo lectura también se actualizan. enable_db_visible_by_connect_rls: Habilita CONNECT RLS en la instancia para controlar la visibilidad de la base de datos. set_db_visible_by_connect_rls: Habilita CONNECT RLS en una base de datos para controlar la visibilidad de la base de datos. Solo se puede llamar después de habilitar CONNECT RLS en la instancia. Elementos de configuración de ApsaraDB RDS for SQL Server clear_errorlog: Borra los registros de errores. encryptionKey: Modifica la función de cifrado de disco en la nube. Las instancias Serverless y los tipos de instancias compartidas no admiten esta función.	pgbouncer
ConfigValue	string	Sí	El valor del elemento de configuración que se va a modificar. Este parámetro se utiliza junto con ConfigName. Valores de los elementos de configuración de ApsaraDB RDS for PostgreSQL Función PgBouncer: true (habilitar) o false (deshabilitar). Función de cifrado de disco en la nube: ServiceKey: Utiliza una clave generada automáticamente por Alibaba Cloud, que es la clave de servicio administrada por RDS (CMK de servicio predeterminada), para habilitar el cifrado de disco en la nube. : Utiliza una clave personalizada para habilitar el cifrado de disco en la nube o reemplaza la clave actual. Ejemplo: `494c98ce-f2b5-48ab-96ab-36c986b6**`. disabled: Deshabilita el cifrado de disco en la nube. Corrección con un clic de los requisitos previos para crear una instancia analítica basada en DuckDB: duckdb_prepare_dependency Configurar las bases de datos de la instancia principal como bases de datos de almacenamiento columnar de DuckDB en lotes. El valor es una cadena JSON. Ejemplo: `{"dbNames": "db1,db2,db3", "accountName": "yourSuperAccountName"}`, donde: dbNames: Los nombres de las bases de datos que se convertirán en bases de datos de almacenamiento columnar de DuckDB. Separe varios nombres de bases de datos con comas (,). accountName: El usuario con privilegios. Especifique solo un usuario con privilegios. Habilitar CONNECT RLS en la instancia para controlar la visibilidad de la base de datos: true para habilitar. Habilitar CONNECT RLS en las bases de datos para controlar la visibilidad de la base de datos: Los nombres de las bases de datos administrados por CONNECT RLS. Separe varios nombres de bases de datos con comas (,). Ejemplo: testdb1,testdb2. Cuando un cliente se conecta a una base de datos con CONNECT RLS habilitado, la lista de bases de datos se muestra según si el cliente tiene permisos CONNECT en otras bases de datos. Valores de los elementos de configuración de ApsaraDB RDS for SQL Server Función de limpieza de registros de errores: 1 (confirmar limpieza). Función de cifrado de disco en la nube (esta función no se puede deshabilitar después de habilitarla): serviceKey: Utiliza una clave generada automáticamente por Alibaba Cloud, que es la clave de servicio administrada por RDS (CMK de servicio predeterminada), para habilitar el cifrado de disco en la nube. : Utiliza una clave personalizada para habilitar el cifrado de disco en la nube o reemplaza la clave actual. Ejemplo: `494c98ce-f2b5-48ab-96ab-36c986b6**`.	true
ResourceGroupId	string	No	El ID del grupo de recursos. Puede llamar a DescribeDBInstanceAttribute para obtener el ID del grupo de recursos.	rg-bp67acfmxazb4p****
ClientToken	string	No	El token de cliente que se utiliza para garantizar la idempotencia de la solicitud. Puede utilizar el cliente para generar el token, pero debe asegurarse de que el token sea único entre las distintas solicitudes. El token solo puede contener caracteres ASCII y no puede superar los 64 caracteres de longitud.	6000170000591aed949d0f****
SwitchTime	string	No	La hora en la que surte efecto la modificación. Se recomienda realizar los cambios de especificaciones durante las horas de menor actividad. Formato: yyyy-MM-ddTHH:mm:ssZ (UTC).	2025-05-06T09:24:00Z
SwitchTimeMode	string	No	La hora de conmutación. Valores válidos: Immediate: La modificación surte efecto inmediatamente. MaintainTime: La modificación surte efecto durante la ventana de mantenimiento. Puede llamar a ModifyDBInstanceMaintainTime para modificar la ventana de mantenimiento.	Immediate

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los parámetros de respuesta.
RequestId	string	El ID de la solicitud.	76364A52-E0AB-5CC8-9818-CF1DC482C092

Ejemplos

Respuesta exitosa

JSON Formato

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

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	%s	DB Operation Failed:%s.
400	InvalidDBInstanceName.NotFound	The specified DB instance name does not exist.	El ID de instancia especificado no existe. Verifique el ID de la instancia e inténtelo de nuevo.
400	MinorVersionNotSupport	The current database minor version does not support the operation.	La versión menor actual del motor de la instancia no admite esta operación. Intente actualizar la versión menor del motor.
400	InvalidConfigName	The ConfigName is not valid.	El parámetro ConfigName especificado no es válido.
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.	Las instancias incluidas en un paquete no se pueden operar individualmente.
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.	No se encontró el resultado del plan de precios.
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.	No ha completado la verificación de nombre real y no es elegible para realizar una compra. Inicie sesión en Gastos y costos para completar la verificación de nombre real.
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.	El saldo de su cuenta es menor que 0. Recargue su cuenta antes de intentar realizar una compra.
400	CommodityServiceCalling.Exception	Failed to call commodity service.	La llamada al servicio de productos falló.
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.	Alibaba Cloud planea optimizar y ajustar la región actual. Los servicios en la nube de esta región dejarán de operar. Para garantizar la continuidad de su negocio y una migración de datos sin problemas, no puede realizar nuevos pedidos de compra en este momento. Gracias por su comprensión y apoyo.
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.	El módulo adquirido no es válido. Adquiera el módulo nuevamente.
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.	La región especificada ha sido descontinuada.
400	Price.CommoditySys	Commodity system call exception.	Ocurrió una excepción al llamar al sistema de productos.
400	Pay.InsufficientBalance	Insufficient available balance.	El saldo actual de la cuenta es inferior a 100. Recargue su cuenta antes de realizar una compra.
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.	El período de suscripción seleccionado no es válido. Seleccione un período de suscripción diferente.
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.	Existe un pedido no pagado para el servicio seleccionado. Pague o cancele el pedido existente antes de realizar uno nuevo.
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.	Su información está incompleta. Complete su información antes de continuar.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.	Su cuenta presenta una excepción. Póngase en contacto con el servicio de atención al cliente para obtener más detalles.
400	Api.NotSupport	Specified api is not supported.	La operación actual no es compatible.
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.	Existe una etiqueta que bloquea pedidos. Póngase en contacto con su distribuidor para resolver este problema.
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.	La instancia especificada no existe. Verifique si la instancia existe y no ha sido eliminada.
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type	El tipo de instancia actual no admite este tipo de almacenamiento.
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.	La operación falló. El parámetro no es válido.
400	KmsApiError	User secret key invalid.	La clave de usuario no es válida.
400	System.SaleValidateFailed	Sales expression validation system error.	La solicitud no contiene un período de suscripción válido. Verifique el parámetro Period o UsedTime.
400	Abs.InvalidAccount.NotFound	account is not found.	La cuenta no existe.
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.	El comando SQL no se pudo ejecutar o se agotó el tiempo de espera.
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.	La versión actual del motor DPI de la instancia no admite el archivado de datos fríos.
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.	La versión actual del kernel no admite el archivado de datos fríos.
400	IncorrectTargetClasscode	The current instance type does not support this operation.	El tipo de instancia actual no admite esta operación.
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.	El nombre de la dirección de conexión está duplicado. Especifique una cadena de conexión diferente.
400	RequiredParam.NotFound	Required input param is not found.	Falta un parámetro obligatorio.
400	Parameters.Invalid	Parameter error, please check the parameters.	El parámetro no es válido. Verifique los parámetros.
400	BackupPolicyNotSupport	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.	El archivado de datos fríos no admite respaldos entre regiones ni respaldos mediante instantáneas de alta frecuencia. Verifique la política de respaldo.
400	InvalideStatus.Format	The instance status does not support this operation.	El estado de la instancia no admite esta operación.
400	InvalidReleasedKeepPolicy.Format	Specified Released Keep Policy is not valid.	La política de retención de datos de respaldo archivados después de la liberación de la instancia no es válida.
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.	El tipo de motor de base de datos de la instancia no admite esta operación.
400	Pay.NoCreditCard	No credit cards.	La cuenta no está vinculada a una tarjeta de crédito.
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.	Esta operación no es compatible con instancias de tipo de red VPC.
400	MirrorInsExists	Specified DB instance mirror ins already existed.	La imagen de la instancia de base de datos ya existe.
400	UnsupportedClassCode	The specified DB instance class stops selling.	El tipo de instancia ya no está disponible para su compra.
400	InvalidBackupSet	The specified database does not exist in the backup set.	La base de datos especificada no existe en el conjunto de respaldo.
400	OrdTCommodityQueryError	Failed to query for product.	No se pudo consultar el producto.
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.	La instancia ha sido liberada. Verifique la instancia antes de realizar un pedido.
400	RegionEndTimeDissolvedIndia	The region is no longer supported.	La región especificada ha sido descontinuada.
400	InvalidSourceCategory	specified source category is invalid.	La categoría de origen especificada no es válida.
400	InvalidParameter	Invalid parameter.	El parámetro no es válido.
400	InvalidConfigValue	The ConfigValue is not valid.	La operación falló. La configuración de parámetros especificada no es válida.
400	InvalidParameters.Format	Specified parameters is not valid.	El parámetro no es válido.
400	DuckDBOperationConflictBetweenPrimaryAndReadOnlyInstance	Current instance is already attached to another duckdb instance, operation is conflict.	La instancia actual ya está asociada con otra instancia analítica basada en DuckDB, lo cual entra en conflicto con la operación actual de DuckDB.
400	KmsServiceLinkedRoleNotGranted	The service linked role is not granted, please check.
500	ExternalFailure	The request processing has failed due to external service failure.	La solicitud falló. Inténtelo de nuevo más tarde.
500	RequestMetaDataFailed	The service request failed. Please try again later or contact service personnel.	La solicitud falló. Inténtelo de nuevo más tarde o póngase en contacto con el soporte técnico.
500	InvokeProxyFailure	The request processing has failed due to service failure of rds api.	La solicitud falló debido a un error en el servicio de la API de RDS.
403	IncorrectDBInstanceType	Current DB instance type does not support this operation.	La operación falló. El motor y el tipo de la instancia de base de datos actual no son compatibles.
403	IncorrectDBInstanceLockMode	Current DB instance lock mode does not support this operation.
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.	La operación falló. El estado actual de la instancia no admite esta operación. Inténtelo de nuevo más tarde.
403	CloudDiskEncryptionNotSupport	The encryption key is not allowed for general-purpose instance.	Las instancias de uso general no admiten el cifrado de discos en la nube.
403	OrderStatus.UnPaid	The specified db instance has unpaid order.	La instancia tiene un pedido pendiente de pago. Pague el pedido e inténtelo de nuevo.
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.	La capacidad objetivo para la reducción de escala no puede ser menor que el uso de almacenamiento actual.
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.	Esta operación no es compatible con discos SSD. Actualice a ESSD.
403	InvalidUserOperatorPermission	The user permission does not support this operation.	Los permisos del usuario no admiten esta operación.
403	InvalidVswitchId	Specified conn vswitch id is not valid.	El VSwitchId especificado tiene un formato no válido o está vacío.
403	IncorrectMinorVersion	Current engine minor version does not support operations.	La versión secundaria actual del motor no admite esta operación.
403	OperationDenied.ZoneResource	There is no available zone for inventory.	No existen zonas de inventario disponibles.
403	NotInFlowController	Sorry,no permission.	Esta operación no está disponible para usuarios de nube que no sean empresariales. No tiene los permisos necesarios.
403	InvalidKmsKey	Kms key is disabled.	La clave de KMS está deshabilitada.
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.	La operación falló. El código de especificación indicado no admite el número de endpoints especificado. Verifique el número de fragmentos y el número actual de endpoints.
403	UnsupportedByBlueGreenDeployment	Operation prohibited due to blue green deployment.	Esta operación no está permitida porque existe un despliegue azul-verde.
403	EncryptionKeyNotSupport	The encryption key is not support to generate encryption disk.	La clave especificada no admite la creación de instancias con discos en la nube cifrados.
403	IncorrectDBState	The current DB state does not support this operation.	La operación falló. El estado actual de la base de datos no es válido. Por ejemplo, la base de datos se está creando o se está migrando a la nube.
403	UnsupportedReadOrBakReadState	Current DB instance has read or bak read running in unsupport states	La instancia de base de datos actual ya se está ejecutando en un estado no compatible con lectura o lectura de copia de seguridad habilitada.
403	IncorrectAccountPrivilegeType	the current account privilege type does not support this operation.	El tipo de permiso de la cuenta actual no admite esta operación.
403	DBInstanceStatusNotActive	The status of the current instance is not active.	La operación falló. Verifique el estado de ejecución de la instancia.
403	ReadOnlyInstanceNotSupport	Read-only instance does not support this operation.	La operación falló porque las instancias de solo lectura no admiten esta operación.
403	Invalid.Parameter	Specified parameters is not valid.	El parámetro especificado no es válido.
403	TargetMajorVesionNotSupported	The specified major version is not supported.	La versión principal de destino no es compatible.
403	ReadInstanceNotSupport	Instances with read-only do not support this operation.	Esta operación no es compatible con instancias que tienen instancias de solo lectura.
403	IncorrectDBInstance	The current DB instance does not support this operation.	La operación falló. La instancia actual no admite esta operación.
404	InvalidDBInstance.NotFound	Specified instance does not exist or not support.	La instancia especificada no existe o no admite esta operación.
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.	La instancia actual no está autorizada para acceder a Key Management Service.
404	Request.NotFound	The requested resource is not available.	El recurso solicitado no está disponible.
404	HostInfo.NotFound	The specified host info is not found.	La información del host especificado no existe.
404	InvalidAccountName.NotFound	The specified account is not found.	No se encontró la cuenta. Si está creando una cuenta o restableciendo una contraseña, especifique su cuenta.
404	InvalidReadDBInstance.NotFound	The specified read only database instance does not exist.	La instancia de solo lectura no se ha creado o el parámetro de instancia de la solicitud no es válido.

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.