Todos os produtos
Search
Central de documentação

:Modificar parâmetros de uma instância

Última atualização: Jun 26, 2026

Chame a operação ModifyParameter para modificar os parâmetros de uma instância.

Modifique os parâmetros diretamente ou use um modelo de parâmetros. Após o envio da solicitação de modificação, o ApsaraDB RDS inicia uma tarefa para aplicar os novos valores à instância. Se algum novo valor exigir reinicialização para entrar em vigor, o ApsaraDB RDS reinicia a instância automaticamente. Para mais informações sobre os parâmetros configuráveis, consulte Configurar os parâmetros de uma instância do ApsaraDB RDS for MySQL.

Nota

Antes de executar a tarefa de modificação, o ApsaraDB RDS verifica se os parâmetros existem, se são configuráveis e se os novos valores são válidos.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para sua conveniência. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros da solicitação

Parâmetro Tipo Obrigatório Exemplo Descrição
Action String Sim ModifyParameter

A operação a ser executada. Defina o valor como ModifyParameter.

ClientToken String Não ETnLKlblzczshOTUbOCzxxxxxxxxxx

Token do cliente usado para garantir a idempotência da solicitação. Gere esse valor com o cliente, mas certifique-se de que o token seja exclusivo entre diferentes solicitações. O token pode conter apenas caracteres ASCII e não deve exceder 64 caracteres.

DBInstanceId String Sim rm-uf6wjk5xxxxxxx

O ID da instância.

Parameters String Sim {"delayed_insert_timeout":"600","max_length_for_sort_data":"2048"}

Strings JSON dos parâmetros e seus respectivos valores. Todos os valores de 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"...}. Chame a operação DescribeParameterTemplates para consultar nomes e valores de parâmetros.

Nota Se você especificar este parâmetro, não será necessário especificar o parâmetro ParameterGroupId.
Forcerestart Boolean Não false

Define se a instância deve ser reiniciada para que um novo valor de parâmetro entre em vigor. Valores válidos:

  • true: O sistema força a reinicialização da instância. Se um novo valor de parâmetro só entrar em vigor após a reinicialização, defina este parâmetro como true. Caso contrário, o novo valor não será aplicado.
  • false: O sistema não força a reinicialização da instância.

Valor padrão: false

ParameterGroupId String Não rpg-xxxxxxxxx

O ID do modelo de parâmetros.

Nota
  • Ao especificar este parâmetro, não é necessário informar o parâmetro Parameters.
  • Caso o modelo de parâmetros só possa ser aplicado após a reinicialização da instância, especifique o parâmetro Forcerestart.
SwitchTimeMode String Não ScheduleTime

O momento em que a modificação entra em vigor. Valores válidos:

  • Immediately: modifica o parâmetro imediatamente. Este é o valor padrão.
  • MaintainTime: aplica a modificação durante a janela de manutenção da instância. Chame a operação ModifyDBInstanceMaintainTime para alterar a janela de manutenção da instância.
  • ScheduleTime: A modificação entra em vigor no horário especificado. Ao escolher esta opção, também é obrigatório definir o parâmetro SwitchTime.
SwitchTime String Não 2022-05-06T09:24:00Z

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 momento da chamada desta operação.

Parâmetros de resposta

Parâmetro

Tipo

Exemplo

Descrição

RequestId

String

542BB8D6-4268-45CC-A557-B03EFD7AB30A

O ID da solicitação.

Exemplos

Exemplos de solicitações

http(s)://rds.aliyuncs.com/?Action=ModifyParameter
&DBInstanceId=rm-uf6wjk5xxxxxxx
&Parameters={"delayed_insert_timeout":"600","max_length_for_sort_data":"2048"}
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<ModifyParameterResponse>
       <RequestId>542BB8D6-4268-45CC-A557-B03EFD7AB30A</RequestId>
</ModifyParameterResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

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

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

Mensagem retornada porque o horário especificado para a entrada em vigor da modificação já passou.

400

InvalidParameters.Format

Specified parameters is not valid.

Mensagem retornada porque o valor de um parâmetro especificado é inválido.

400

InvalidParameters.Format

The format of the specified parameter is invalid.

Mensagem retornada porque o formato de um parâmetro especificado é inválido.

400

Invalid.ParamGroupDBCategory

ParamGroup category is basic, not standard.

Mensagem retornada porque a categoria do modelo de parâmetros especificado é básica, e não padrão.

403

IncorrectDBInstanceType

The current database instance type does not support the operation.

Mensagem retornada porque a configuração da instância não oferece suporte a esta operação.

403

IncorrectDBInstanceState

The current database status does not support the operation.

Mensagem retornada porque o status da instância não permite esta operação. Verifique se a instância está no estado Running.

403

Invalid.Parameter

Specified parameters is not valid.

Mensagem retornada porque um parâmetro especificado é inválido.

404

InvalidDBInstance.NotFound

The specified instance does not exist or is not supported.

Mensagem retornada porque a instância especificada não foi encontrada. Verifique o ID da instância.

Para obter uma lista de códigos de erro, visite o API Error Center.