ModifyParameter - ApsaraDB RDS: Central de Documentação do Alibaba Cloud

Modifica os valores dos parâmetros de uma instância.

Descrição da operação

Mecanismos de banco de dados compatíveis

MySQL
PostgreSQL
SQL Server
MariaDB.

Referências

Nota

Antes de chamar esta operação, leia atentamente a seguinte documentação. Certifique-se de compreender totalmente os pré-requisitos e os impactos da chamada desta operação.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

rds:ModifyParameter

update

*DBInstance

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

rds:ResourceTag
rds:TLSVersion

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ClientToken	string	Não	O token do cliente usado para garantir a idempotência da solicitação. Você pode usar o cliente para gerar o token, mas deve garantir que o token seja exclusivo entre diferentes solicitações. O token pode conter apenas caracteres ASCII e não pode exceder 64 caracteres de comprimento.	ETnLKlblzczshOTUbOCz****
DBInstanceId	string	Sim	O ID da instância.	rm-uf6wjk5****
Parameters	string	Não	As strings JSON dos parâmetros e seus valores. Todos os valores dos parâmetros são do tipo string. Formato: {"Nome do parâmetro 1":"Valor do parâmetro 1","Nome do parâmetro 2":"Valor do parâmetro 2"...}. Você pode chamar a operação DescribeParameterTemplates para consultar os nomes e valores dos parâmetros. Nota Se você especificar este parâmetro, não precisará especificar ParameterGroupId.	{"delayed_insert_timeout":"600","max_length_for_sort_data":"2048"}
Forcerestart	boolean	Não	Especifica se a instância deve ser reiniciada para que um novo valor de parâmetro entre em vigor. Valores válidos: true: O sistema reinicia a instância à força. Se um novo valor de parâmetro entrar em vigor somente após a reinicialização da instância, você deverá definir este parâmetro como true. Caso contrário, o novo valor do parâmetro não poderá entrar em vigor. false: O sistema não reinicia a instância à força. Valor padrão: false.	false
ParameterGroupId	string	Não	O ID do modelo de parâmetro. Nota Se você especificar este parâmetro, não precisará especificar Parameters. Se o modelo de parâmetro puder ser aplicado somente após a reinicialização da instância, você deverá especificar Forcerestart.	rpg-****
SwitchTimeMode	string	Não	O horário em que a modificação entra em vigor. Valores válidos: Immediate: modifica o parâmetro imediatamente. Este é o valor padrão. MaintainTime: modifica o parâmetro durante a janela de manutenção da instância. Você pode chamar a operação ModifyDBInstanceMaintainTime para alterar a janela de manutenção. ScheduleTime: modifica o parâmetro no horário especificado por você. Se você especificar este valor, também deverá especificar SwitchTime. Valores válidos: ScheduleTime : modifica o parâmetro no horário especificado por você. Se você especificar este valor, também deverá especificar SwitchTime. Immediate : modifica o parâmetro imediatamente. MaintainTime : modifica o parâmetro durante a janela de manutenção da instância. Você pode chamar a operação ModifyDBInstanceMaintainTime para alterar a janela de manutenção.	ScheduleTime
SwitchTime	string	Não	O horário em que a modificação entra em vigor. Especifique o horário no padrão ISO 8601 no formato aaaa-MM-ddTHH:mm:ssZ. O horário deve estar em UTC. Nota Este horário deve ser posterior ao horário em que você chama esta operação.	2022-05-06T09:24:00Z

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
RequestId	string	O ID da solicitação.	542BB8D6-4268-45CC-A557-B03EFD7AB30A

Exemplos

Resposta de sucesso

JSON formato

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

Resposta de erro

JSON formato

{
    "RequestId": "7463B73D-35CC-4D19-A010-6B8D65D242EF",
    "HostId": "rds.aliyuncs.com",
    "Code": "UnsupportedOperation",
    "Message": "The specified action is not supported."
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	PendingActionOverdue	the action execution time is already overdue	The specified execution time has expired.
400	EngineMigration.ActionDisabled	Specified action is disabled while custins is in engine migration.	The specified operation is disabled when the instance is being migrated across engines.
400	%s	The following parameters are prohibited: %s
400	Invalid.ParamGroupDBCategory	ParamGroup category is basic, not standard.	The parameter group is a basic parameter group not a standard parameter group.
400	InvalidEffectiveTime.SpecialTimeIsNull	SpecialTime is not valid.
400	InvalidParameters.Format	Specified parameters is not valid.	The values of some parameters are invalid.
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	A database connection error occurred. Check the instance state and the database connection pool.
400	InvalidInstanceParameter	Specified name for the instance parameter is not valid.	The name specified for the instance parameter is invalid.
400	GroupReplicationNotSupport.InvalidParameters	Group Replication limits parameters and does not support modification.	The group Replication has restrictions on parameters and cannot be modified.
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.	A package instance is not allowed to operate independently.
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.	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.	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.	Your account available limit is less than 0, please recharge before trying to purchase.
400	CommodityServiceCalling.Exception	Failed to call commodity service.	Failed to call commodity service return.
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.	Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, 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.	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.	Hello customer, this area has been abolished.
400	Price.CommoditySys	Commodity system call exception.	Commodity system call exception.
400	Pay.InsufficientBalance	Insufficient available balance.	Insufficient available balance.
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.	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.	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.	No payment method has been specified for your account. We recommend that you add a payment method.
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.	Your basic information is not complete, please complete your basic information before operation.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.	Your account is abnormal, please contact customer service for details.
400	Api.NotSupport	Specified api is not supported.	The current interface does not support.
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.	You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.	The DBInstanceId provided does not exist.
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type	The current instance type does not support the specified storage type.
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.	The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.
400	KmsApiError	User secret key invalid.	The user key is invalid.
400	System.SaleValidateFailed	Sales expression validation system error.	A system error occurs when the sales expression is verified.
400	Abs.InvalidAccount.NotFound	account is not found.	The account does not exist.
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.	SQL command execution failed or timed out
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.	The current instance engine version not support coldDataEnabled.
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.	The current instance minor version not support coldDataEnabled.
400	IncorrectTargetClasscode	The current instance type does not support this operation.	This operation is not supported by the instance type.
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.	The link address name is duplicate. Please reset the connection string.
400	RequiredParam.NotFound	Required input param is not found.
400	Parameters.Invalid	Parameter error, please check the parameters.	Parameter error, please check the parameters.
400	BackupPolicyNotSupport	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.
400	InvalidReleasedKeepPolicy.Format	Specified Released Keep Policy is not valid.	Specified Released Keep Policy is not valid.
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.	This operation is not supported for the database engine of the instance.
400	Pay.NoCreditCard	No credit cards.	No credit cards.
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.	The vpc network type instance does not support this operation.
400	MirrorInsExists	Specified DB instance mirror ins already existed.	Specified DB instance mirror ins already existed.
400	UnsupportedClassCode	The specified DB instance class stops selling.	The specified DB instance class stops selling.
400	InvalidBackupSet	The specified database does not exist in the backup set.	The specified database does not exist in the backup set.
400	OrdTCommodityQueryError	Failed to query for product.	Failed to query product.
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.	The instance has been released, please verify and place an order.
400	RegionEndTimeDissolvedIndia	The region is no longer supported.	The region is no longer supported.
400	OperationDenied.XengineSwitch	Current custins can not turn off xengine param.	The current instance has a xengine table and cannot switch to another parameter template.
400	InvalidParameterValue.Limit	Parameter value exceeds limit.
500	ExternalFailure	The request processing has failed due to external service failure.	The request processing has failed due to external service failure.
500	RequestMetaDataFailed	The service request failed. Please try again later or contact service personnel.	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.	The request failed to be processed due to an RDS API failure.
403	IncorrectDBInstanceType	The current database instance type does not support the operation.	This operation is not supported for the database engine of the current instance.
403	IncorrectDBInstanceState	The current database status does not support the operation.	The operation failed. The RDS instance is not running.
403	ParamNotSupportedForCurrentVersion	Parameter is not supported for current version.
403	Invalid.Parameter	Specified parameters is not valid.	The specified parameter is invalid.
403	IncorrectEffectiveTime	The specified EffectiveTime params is not valid.	The value of the EffectiveTime parameter is invalid.
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.	This operation is not supported for the current minor engine version.
403	GroupReplicationNotSupport.TableWithoutPrimaryKey	Group Replication is not supported because the instance exists table has no primary key.	The instance has tables without primary keys and does not support MySQL group replication (MGR).
403	IncorrectDBInstance	The current DB instance does not support this operation.	The operation failed. The operation is not supported for the RDS instance.
403	OrderStatus.UnPaid	The specified db instance has unpaid order.	The instance has an unpaid order. Please pay first and try again.
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.	The scale-in target capacity cannot be less than the current storage space usage
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.
403	InvalidUserOperatorPermission	The user permission does not support this operation.	The user is not authorized to perform this operation.
403	InvalidVswitchId	Specified conn vswitch id is not valid.
403	OperationDenied.ZoneResource	There is no available zone for inventory.	There is no available zone for inventory.
403	NotInFlowController	Sorry,no permission.	Sorry,no permission.
403	InvalidKmsKey	Kms key is disabled.
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.	The specified database instance type does not support this operation.
404	InvalidDBInstance.NotFound	The specified instance does not exist or is not supported.	The RDS instance cannot be found. Check the ID or name of the RDS instance.
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.	The instance does not have permissions to access Key Management Service (KMS).
404	Request.NotFound	The requested resource is not available.	The requested resources are unavailable.
404	HostInfo.NotFound	The specified host info is not found.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.