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

Modifica los valores de los parámetros de una instancia.

Descripción de la operación

Motores de base de datos compatibles

MySQL
PostgreSQL
SQL Server
MariaDB

Referencias

Nota

Antes de llamar a esta operación, lea detenidamente la siguiente documentación. Asegúrese de comprender completamente los requisitos previos y los impactos de llamar a esta operación.

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:ModifyParameter

update

*DBInstance.

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

rds:ResourceTag
rds:TLSVersion

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
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 diferentes solicitudes. El token solo puede contener caracteres ASCII y no puede superar los 64 caracteres de longitud.	ETnLKlblzczshOTUbOCz****
DBInstanceId	string	Sí	El ID de la instancia.	rm-uf6wjk5****
Parameters	string	No	Las cadenas JSON de los parámetros y sus valores. Todos los valores de los parámetros son de tipo cadena. Formato: {"Nombre del parámetro 1":"Valor del parámetro 1","Nombre del parámetro 2":"Valor del parámetro 2"...}. Puede llamar a la operación DescribeParameterTemplates para consultar los nombres y valores de los parámetros. Nota Si especifica este parámetro, no necesita especificar ParameterGroupId.	{"delayed_insert_timeout":"600","max_length_for_sort_data":"2048"}
Forcerestart	boolean	No	Especifica si se debe reiniciar la instancia para que un nuevo valor de parámetro surta efecto. Valores válidos: true: El sistema reinicia la instancia de forma forzada. Si un nuevo valor de parámetro solo surte efecto después de reiniciar la instancia, debe establecer este parámetro en true. De lo contrario, el nuevo valor del parámetro no podrá surtir efecto. false: El sistema no reinicia la instancia de forma forzada. Valor predeterminado: false.	false
ParameterGroupId	string	No	El ID de la plantilla de parámetros. Nota Si especifica este parámetro, no necesita especificar Parameters. Si la plantilla de parámetros solo se puede aplicar después de reiniciar la instancia, debe especificar Forcerestart.	rpg-****
SwitchTimeMode	string	No	El momento en que la modificación surte efecto. Valores válidos: Immediate: modifica el parámetro inmediatamente. Este es el valor predeterminado. MaintainTime: modifica el parámetro durante la ventana de mantenimiento de la instancia. Puede llamar a la operación ModifyDBInstanceMaintainTime para cambiar la ventana de mantenimiento. ScheduleTime: modifica el parámetro en el momento que usted especifique. Si especifica este valor, también debe especificar SwitchTime. Valores válidos: ScheduleTime : modifica el parámetro en el momento que usted especifique. Si especifica este valor, también debe especificar SwitchTime. Immediate : modifica el parámetro inmediatamente. MaintainTime : modifica el parámetro durante la ventana de mantenimiento de la instancia. Puede llamar a la operación ModifyDBInstanceMaintainTime para cambiar la ventana de mantenimiento.	ScheduleTime
SwitchTime	string	No	El momento en que la modificación surte efecto. Especifique la hora en formato ISO 8601 con el patrón aaaa-MM-ddTHH:mm:ssZ. La hora debe estar en UTC. Nota Esta hora debe ser posterior al momento en que llama a esta operación.	2022-05-06T09:24:00Z

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los parámetros de respuesta.
RequestId	string	El ID de la solicitud.	542BB8D6-4268-45CC-A557-B03EFD7AB30A

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "542BB8D6-4268-45CC-A557-B03EFD7AB30A"
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error
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.
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.
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.
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.
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.
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.
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.
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.
400	Pay.NoCreditCard	No credit cards.
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.
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.
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.
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.
403	GroupReplicationNotSupport.InvalidEngineVersion	Group Replication requires the instance engine version to be 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.
403	GroupReplicationNotSupport.InvalidXengine	Group Replication is not supported because the instance has xengine tables.
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.
403	InvalidUserOperatorPermission	The user permission does not support this operation.
403	InvalidVswitchId	Specified conn vswitch id is not valid.
403	OperationDenied.ZoneResource	There is no available zone for inventory.
403	NotInFlowController	Sorry,no permission.
403	InvalidKmsKey	Kms key is disabled.
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.
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.

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.