Todos os produtos
Search
Central de documentação

ApsaraDB RDS:ModifyDBProxyEndpoint

Última atualização: Jul 07, 2026

Modifica as configurações de conexão de um endpoint de proxy de banco de dados.

Descrição da operação

Mecanismos de banco de dados compatíveis

  • RDS MySQL

  • RDS PostgreSQL

Referências

Nota

Antes de chamar esta operação, leia os tópicos a seguir e certifique-se de compreender totalmente os pré-requisitos e os impactos 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:ModifyDBProxyEndpoint

update

*DBInstance

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

  • rds:ResourceTag
  • rds:ResourceTag
  • rds:ResourceTag
Nenhuma

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

DBInstanceId

string

Sim

O ID da instância. Você pode chamar a operação DescribeDBInstances para consultar o ID da instância.

rm-bp145737x5bi6****

DBProxyEndpointId

string

Não

O ID do endpoint de proxy. Você pode chamar a operação DescribeDBProxyEndpoint para consultar o ID do endpoint de proxy.

Nota
  • Se a instância executar MySQL e você definir DbEndpointOperator como Delete ou Modify, deverá especificar DBProxyEndpointId.

  • Se a instância executar PostgreSQL e você definir DbEndpointOperator como Delete, Modify ou Create, deverá especificar DBProxyEndpointId.

gos787jog2wk0y****

ConfigDBProxyFeatures

string

Não

Os recursos que você deseja ativar para o endpoint de proxy. Se você especificar mais de um recurso, separe-os com ponto e vírgula (;). Formato: Recurso 1:Status;Recurso 2:Status;.... Não adicione um ponto e vírgula (;) no final do valor.

Valores válidos de recursos:

  • ReadWriteSpliting: divisão de leitura e gravação

  • ConnectionPersist: pool de conexões

  • TransactionReadSqlRouteOptimizeStatus: divisão de transações

  • AZProximityAccess: acesso mais próximo

  • CausalConsistRead: consistência de leitura

Valores válidos de status:

  • 1: ativado

  • 0: desativado

Nota
  • Se a instância executar PostgreSQL, você poderá ativar apenas a divisão de leitura e gravação, que é especificada por ReadWriteSpliting.

  • O acesso mais próximo é compatível apenas com proxies de banco de dados dedicados para instâncias RDS que executam MySQL.

ReadWriteSpliting:1;ConnectionPersist:0

RegionId

string

Não

O ID da região. Você pode chamar a operação DescribeRegions para consultar a lista de regiões mais recente.

cn-hangzhou

ReadOnlyInstanceMaxDelayTime

string

Não

O limite máximo de latência permitido para a divisão de leitura e gravação. Se a latência em uma instância somente leitura exceder o limite especificado, o sistema não encaminhará mais solicitações de leitura para a instância somente leitura. Se você não especificar este parâmetro, o valor original deste parâmetro será mantido. Valores válidos: 0 a 3600.

Nota
  • Você deve especificar este parâmetro apenas quando a divisão de leitura e gravação estiver ativada.

  • Se o endpoint de proxy de banco de dados tiver os atributos de leitura e gravação, o valor padrão deste parâmetro será 30 e a divisão de leitura e gravação será compatível. Se o endpoint de proxy de banco de dados tiver o atributo somente leitura, o valor padrão deste parâmetro será -1 e a divisão de leitura e gravação não será compatível. Unidade: segundos.

30

CausalConsistReadTimeout

string

Não

O tempo limite de leitura de consistência. Unidade: milissegundos. Valor padrão: 10. Valores válidos: 0 a 60000

10

ReadOnlyInstanceDistributionType

string

Não

A política usada para alocar pesos de leitura. Valores válidos:

  • Standard (padrão): O sistema atribui automaticamente pesos de leitura às instâncias primárias e somente leitura com base nas especificações dessas instâncias.

  • Custom: Você deve alocar manualmente os pesos de leitura para as instâncias primárias e somente leitura.

Nota

Você deve especificar este parâmetro quando a divisão de leitura e gravação estiver ativada. Para obter mais informações sobre a política de alocação de pesos, consulte Modificar o limite de latência e os pesos de leitura das instâncias do ApsaraDB RDS for MySQL e Ativar e configurar o recurso de proxy de banco de dados para uma instância do ApsaraDB RDS for PostgreSQL.

Standard

ReadOnlyInstanceWeight

string

Não

Os pesos de leitura da instância e de suas instâncias somente leitura. Um peso de leitura deve ser um múltiplo de 100 e não pode exceder 10000. Formatos:

  • Instância padrão: {"ID da instância primária":"Peso","ID da instância somente leitura":"Peso"...}

    Exemplo: {"rm-uf6wjk5****":"500","rr-tfhfgk5xxx":"200"...}

  • Instância no RDS Cluster Edition: {"ID da instância somente leitura":"Peso","DBClusterNode":{"ID do nó primário":"Peso","ID do nó secundário":"Peso","ID do nó secundário":"Peso"...}}

    Exemplo: {"rr-tfhfgk5****":"200","DBClusterNode":{"rn-2z****":"0","rn-2z****":"400","rn-2z****":"400"...}}

    Nota

    DBClusterNode é obrigatório se a instância executar o RDS Cluster Edition. O parâmetro DBClusterNode inclui informações sobre os IDs e pesos dos nós primário e secundário.

{"rm-uf6wjk5****":"500","rr-tfhfgk5xxx":"200"...}

DBInstanceId

string

Sim

O ID da instância. Você pode chamar a operação DescribeDBInstances para consultar o ID da instância.

rm-bp145737x5bi6****

DbEndpointOperator

string

Não

O tipo de operação que você deseja realizar. Valores válidos:

  • Modify: Modifica um endpoint de proxy. Este é o valor padrão.

  • Create: Cria um endpoint de proxy.

  • Delete: Exclui um endpoint de proxy.

Modify

DbEndpointAliases

string

Não

A descrição do endpoint de proxy.

test-proxy

DbEndpointType

string

Não

O tipo do endpoint de proxy. Este é um parâmetro reservado. Você não precisa especificar este parâmetro.

RWSplit

DbEndpointReadWriteMode

string

Não

Os atributos de leitura e gravação do endpoint de proxy. Valores válidos:

  • ReadWrite: O endpoint de proxy se conecta à instância primária e pode receber solicitações de leitura e gravação.

  • ReadOnly: O endpoint de proxy não se conecta à instância primária e pode receber apenas solicitações de leitura. Este é o valor padrão.

Nota
  • Se você definir DbEndpointOperator como Create, também deverá especificar DbEndpointReadWriteMode.

  • Se a instância executar MySQL e você alterar o valor deste parâmetro de ReadWrite para ReadOnly, o recurso de divisão de transações será desativado.

ReadWrite

DBProxyEngineType

string

Não

Um parâmetro obsoleto. Você não precisa especificar este parâmetro.

normal

VSwitchId

string

Não

O ID do vSwitch na zona em que o endpoint de proxy é especificado. O valor padrão é o ID do vSwitch que corresponde ao endpoint padrão do proxy de banco de dados. Você pode chamar a operação DescribeVSwitches para consultar os vSwitches existentes.

vsw-uf6adz52c2p****

EffectiveTime

string

Não

O horário de vigência. Valores válidos:

  • Immediate: O horário de vigência é imediato.

  • MaintainTime: O horário de vigência está dentro da janela de manutenção. Para obter mais informações, consulte ModifyDBInstanceMaintainTime.

  • SpecificTime: O horário de vigência é um ponto no tempo especificado.

Valor padrão: MaintainTime.

MaintainTime

EffectiveSpecificTime

string

Não

O ponto no tempo que você deseja especificar. Especifique o horário no padrão ISO 8601 no formato aaaa-MM-ddTHH:mm:ssZ. O horário deve estar em UTC.

Nota

Se EffectiveTime estiver definido como SpecificTime, você deverá especificar este parâmetro.

2023-05-06T07:08:09Z

DbEndpointMinSlaveCount

string

Não

O número mínimo de instâncias reservadas.

2

DbEndpointCostThresholdForDuckdb

string

Não

VpcId

string

Não

O ID da VPC da zona em que o endpoint de proxy é especificado. O valor padrão é o ID da VPC que corresponde ao endpoint padrão do proxy de banco de dados. Você pode chamar a operação DescribeDBInstanceAttribute para consultar a VPC padrão de uma instância.

vpc-2zeusejj******

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

Os parâmetros de resposta.

RequestId

string

O ID da solicitação.

6B50D92C-1960-4D4F-A290-AFADD6B1A5C8

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "6B50D92C-1960-4D4F-A290-AFADD6B1A5C8"
}

Códigos de erro

Código de status HTTP

Código de erro

Mensagem de erro

Descrição

400 InvalidVpcInstanceId The specified VPC instance ID is invalid. A operação falhou. O ID da instância conectada à VPC atual é inválido.
400 InvalidEndPoint.Format The specified EndPoint is not valid. O ID do endpoint de proxy dedicado (DBProxyEndpointId) não foi especificado ou não existe. Verifique o parâmetro Endpoint.
400 InvalidEndpointType.Format The specified EndpointType is invalid. O EndpointType especificado é inválido. Verifique o valor do parâmetro.
400 IncorrectDBInstanceNetType The current database instance network type does not support the operation. A operação falhou. O tipo de rede da instância não é suportado.
400 EndpointNum.Error The number of endpoint is invalid. O número de endpoints atingiu o limite superior. Não é possível criar mais endpoints.
400 EndpointTypeOperation.NotSupport The endpoint type does not support the operation. O tipo de endpoint atual não suporta esta operação. Verifique o tipo de endpoint de proxy.
400 InvalidDBInstanceName Specified parameter DBInstanceName is not valid. O valor DBInstanceName especificado é nulo ou nenhuma instância correspondente foi encontrada. Verifique o parâmetro DBInstanceName.
400 ClusterEndpoint.StatusNotValid The cluster endpoint status is invalid. O status do endpoint do cluster é inválido.
400 MaxscaleNotSupport Current custins can not support Maxscale. Esta operação não é compatível com instâncias com MaxScale.
400 InvalidAvZone.Format Specified AvZone is not valid. A operação falhou. A zona está incorreta. Verifique e tente novamente.
400 Order.ComboInstanceNotAllowOperate A package instance is not allowed to operate independently. Operações individuais não são permitidas para instâncias de pacote.
400 Price.PricingPlanResultNotFound Pricing plan price result not found. O resultado do preço do plano de preços não foi encontrado.
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. Você não concluiu a verificação de nome real e não está elegível para fazer uma compra. Faça login em Despesas e Custos para concluir a verificação de nome real.
400 InsufficientAvailableQuota Your account quota limit is less than 0, please recharge before trying to purchase. O crédito disponível da sua conta é menor que 0. Recarregue sua conta antes de tentar fazer uma compra.
400 CommodityServiceCalling.Exception Failed to call commodity service. A chamada para o serviço de commodity retornou uma falha.
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. O Alibaba Cloud planeja otimizar e ajustar a região atual. Os serviços em nuvem nesta região serão descontinuados. Para garantir a continuidade dos seus negócios e uma migração de dados tranquila, você não pode fazer novos pedidos de compra no momento. Agradecemos sua compreensão e apoio.
400 Commodity.InvalidComponent The module you purchased is not legal, please buy it again. O módulo adquirido é inválido. Adquira um módulo válido.
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. A região foi desativada.
400 Price.CommoditySys Commodity system call exception. Ocorreu uma exceção ao chamar o sistema de commodities.
400 Pay.InsufficientBalance Insufficient available balance.
400 Order.PeriodInvalid There is a problem with the period you selected, please choose again. O período de assinatura selecionado é inválido. Selecione um período de assinatura válido.
400 pay.noCreditCard Account not bound to credit card. A conta não está associada a um cartão de crédito.
400 Order.InstHasUnpaidOrder There is an unpaid order for the service you have purchased. Please pay or void it before placing the order. Existe um pedido não pago para o serviço selecionado. Pague ou cancele o pedido antes de fazer um novo.
400 noAvailablePaymentMethod No payment method is specified for your account. We recommend that you add a payment method. Nenhum método de pagamento está especificado para a conta. Adicione um método de pagamento.
400 BasicInfoUncompleted Your information is incomplete. Complete your information before the operation. Suas informações básicas estão incompletas. Complete suas informações básicas antes de realizar esta operação.
400 Risk.RiskControlRejection Your account is abnormal, please contact customer service for details. Ocorreu uma exceção com a sua conta. Entre em contato com o atendimento ao cliente para obter detalhes.
400 Api.NotSupport Specified api is not supported. A operação de API atual não é suportada.
400 ContainForbiddenLabelError There is a label that prohibits placing orders. Please contact your distributor for assistance. Existe uma tag de bloqueio de pedido. Entre em contato com seu distribuidor para obter assistência.
400 InvalidDBInstanceId.NotFound The DBInstanceId provided does not exist in records. O DBInstanceId especificado não existe.
400 InvalidInstanceLevel.DiskType Specified instance level not support request disk type O tipo de instância atual não oferece suporte ao tipo de armazenamento especificado.
400 InvalidParam Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica. O parâmetro de entrada é inválido.
400 KmsApiError User secret key invalid. A chave do usuário é inválida.
400 System.SaleValidateFailed Sales expression validation system error.
400 Abs.InvalidAccount.NotFound account is not found. Sua conta da Alibaba Cloud não existe ou sua AccessKey expirou.
400 SqlExecuteFailedOrTimeout sql command execution failed or timed out:%s. A execução do comando SQL falhou ou expirou.
400 ColdData.EngineVersionNotSupport The current instance engine version not support coldDataEnabled. A versão atual do mecanismo DPI da instância não suporta o arquivamento de dados frios.
400 ColdData.MinorVersionNotSupport The current instance minor version not support coldDataEnabled. A versão atual do kernel não suporta o arquivamento de dados frios.
400 IncorrectTargetClasscode The current instance type does not support this operation. O tipo de instância atual não oferece suporte a esta operação.
400 InvalidConnectionString.Duplicate Specified connection string already exists in the RDS. O nome do endereço de conexão está duplicado. Reconfigure a string de conexão.
400 RequiredParam.NotFound Required input param is not found. Parâmetros obrigatórios estão ausentes.
400 Parameters.Invalid Parameter error, please check the parameters. O parâmetro está incorreto. Verifique o parâmetro.
400 BackupPolicyNotSupport Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy. O arquivamento de dados frios não oferece suporte a backup entre regiões ou backup de snapshot de alta frequência. Verifique a política de backup.
400 InvalideStatus.Format The instance status does not support this operation. O status da instância não suporta esta operação.
400 InvalidReleasedKeepPolicy.Format Specified Released Keep Policy is not valid. A política de retenção de dados de backup arquivados após a liberação da instância é inválida.
400 InvalidDBInstanceEngineType.Format the DB instance engine type does not support this operation. O tipo de mecanismo de banco de dados da instância não oferece suporte a esta operação.
400 Pay.NoCreditCard No credit cards.
400 VpcNetworkTypeNotSupport The vpc network type instance does not support this operation. Esta operação não é suportada para instâncias do tipo de rede VPC.
400 MirrorInsExists Specified DB instance mirror ins already existed. A imagem da instância de banco de dados atual já existe.
400 UnsupportedClassCode The specified DB instance class stops selling. O tipo de instância não está mais disponível para compra.
400 InvalidBackupSet The specified database does not exist in the backup set. O banco de dados especificado não existe no conjunto de backup.
400 OrdTCommodityQueryError Failed to query for product. Falha ao consultar o produto.
400 ProductInstanceReleased The instance has been released. Please check before placing the order. A instância foi liberada. Verifique a instância antes de fazer o pedido.
400 RegionEndTimeDissolvedIndia The region is no longer supported. A região foi desativada.
400 APICallingFailed Api calling failed. A chamada de API falhou. Verifique a VPC, o vSwitch, o VIP e outros parâmetros.
400 InvalidVSwitchId.Format The specified vswitch Id format is incorrect. O ID do vSwitch especificado está em um formato incorreto.
500 ExternalFailure The request processing has failed due to external service failure. A solicitação para o serviço falhou. Tente novamente mais tarde.
500 RequestMetaDataFailed The service request failed. Please try again later or contact service personnel. A solicitação de serviço falhou. Tente novamente mais tarde ou entre em contato com o suporte.
500 InvokeProxyFailure The request processing has failed due to service failure of rds api. A solicitação falhou porque o serviço da API do RDS apresentou falha.
403 MaxScaleLevel.NotSupport The current maxscale ins_num does not support this operation. A operação falhou. A especificação atual do proxy de banco de dados não oferece suporte a esta operação.
403 ReadDBInstance.NotFound The current database instance does not contain any read only instance. A instância de banco de dados atual não possui instâncias somente leitura.
403 IncorrectKindCode The current KindCode of the custins does not support the operation. A operação falhou. O tipo de ambiente da instância atual não é suportado. Verifique os tipos de instância suportados pela operação.
403 IncorrectDBInstanceState The current database instance state does not support the operation. O status da instância de proxy não está ativado.
403 IncorrectDBInstanceEngine Current DB Instance engine does not support this operation. A operação falhou. O mecanismo do banco de dados atual não é suportado.
403 IncorrectDBInstanceType Current DB instance type does not support this operation. A operação falhou. Esta operação não é suportada no status atual da instância.
403 OrderStatus.UnPaid The specified db instance has unpaid order. Existe um pedido não pago para a instância atual. Pague o pedido e tente novamente.
403 InvalidReduceDiskSize The storage capacity after the scale-down must be larger than the used amount. A capacidade de destino para redução de escala não pode ser menor que o uso de armazenamento atual.
403 CloudSSDNotSupport Cloud ssd does not support this operation, please upgrade to essd. Os discos em nuvem SSD não suportam esta operação. Faça upgrade para ESSD.
403 InvalidUserOperatorPermission The user permission does not support this operation. As permissões do usuário não suportam esta operação.
403 InvalidVswitchId Specified conn vswitch id is not valid. O VSwitchId especificado está em um formato incorreto ou está vazio.
403 IncorrectMinorVersion Current engine minor version does not support operations. A versão secundária atual do mecanismo não suporta esta operação.
403 OperationDenied.ZoneResource There is no available zone for inventory. Não há regiões de inventário disponíveis.
403 NotInFlowController Sorry,no permission. Este recurso está disponível apenas para usuários de nuvem corporativa. Você não tem as permissões necessárias.
403 InvalidKmsKey Kms key is disabled. A chave KMS está desativada.
403 InvalidInstanceLevel.Malformed Current DB instance level does not support this operation. O nível atual da instância de banco de dados não oferece suporte a esta operação.
404 EndpointConfig.Invalid Please check the endpoint config parameter. A configuração do endpoint de proxy está incorreta. Verifique se os parâmetros estão corretos.
404 Readins.NotFound The current instance does not contain any read only instance. The operation is not supported. A operação falhou. A instância atual não possui instâncias somente leitura.
404 Endpoint.NotFound Specified endpoint is not found. O endpoint de destino não existe.
404 EndpointType.NotFound The specified endpoint type is not found. A operação falhou. O tipo de endpoint de proxy é desconhecido. Verifique o tipo de endpoint.
404 InvalidReadDBInstance.NotFound The specified read only database instance does not exist. A instância somente leitura não foi criada ou o parâmetro de instância da solicitação é inválido.
404 InvalidParam The specified Weight is invalid. O parâmetro de entrada é inválido.
404 Maxscale.NotFound The related maxscale instance is not found. A operação falhou. A instância MaxScale associada não foi encontrada.
404 IncorrectVswitchId The specified parameter VSwitchId is not valid. O parâmetro vSwitch é inválido.
404 InvalidClusterKms The current instance does not authorized to access the Key Management Service. A instância atual não está autorizada a acessar o Key Management Service (KMS).
404 Request.NotFound The requested resource is not available. O recurso solicitado não está disponível.
404 HostInfo.NotFound The specified host info is not found. As informações do host especificado não existem.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.