Todos os produtos
Search
Central de documentação

:Modifique configurações do endpoint de proxy

Última atualização: Jun 26, 2026

Use a operação ModifyDBProxyEndpoint para modificar as configurações do endpoint de proxy de uma instância.

Antes de usar a operação ModifyDBProxyEndpoint, certifique-se de ter usado a operação ModifyDBProxy para ativar o recurso de proxy de banco de dados na instância.

  • O recurso de proxy dedicado do ApsaraDB RDS for MySQL oferece funcionalidades como divisão de leitura/escrita e otimização de conexões de curta duração. Para mais informações, consulte O que são proxies de banco de dados?

  • O recurso de proxy de banco de dados do ApsaraDB RDS for PostgreSQL oferece suporte à divisão de leitura/escrita. Para mais informações, consulte O que são proxies de banco de dados?

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos usar esta operação no OpenAPI Explorer, que gera dinamicamente códigos de exemplo para diferentes SDKs.

Parâmetros da solicitação

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

Operação a ser executada. Defina o valor como ModifyDBProxyEndpoint.

DBInstanceId String Sim rm-bp145737x5bi6****

ID da instância. Use a operação DescribeDBInstances para consultar o ID da instância.

DBProxyEndpointId String Sim gos787jog2wk0y****

ID do endpoint de proxy. Use a operação DescribeDBProxyEndpoint para consultar o ID do endpoint de proxy.

Nota
  • Se a instância executar MySQL e o parâmetro DbEndpointOperator estiver definido como Delete ou Modify, especifique o parâmetro DBProxyEndpointId.
  • Se a instância executar PostgreSQL e o parâmetro DbEndpointOperator estiver definido como Delete, Modify ou Create, especifique o parâmetro DBProxyEndpointId.
ConfigDBProxyFeatures String Não ReadWriteSpliting:1;ConnectionPersist:0

Recursos a serem ativados para o endpoint de proxy. Se especificar mais de um recurso, separe-os por ponto e vírgula (;). Formato: Feature 1:Status;Feature 2:Status;.... Não adicione ponto e vírgula (;) ao final do último valor.

Valores válidos para recursos:

  • ReadWriteSpliting: divisão de leitura/escrita
  • ConnectionPersist: pool de conexões
  • TransactionReadSqlRouteOptimizeStatus: divisão de transações

Valores válidos para status:

  • 1: ativado
  • 0: desativado
Nota Se a instância executar PostgreSQL, apenas o recurso de divisão de leitura/escrita pode ser ativado, especificado por ReadWriteSpliting.
RegionId String Não cn-hangzhou

ID da região da instância. Use a operação DescribeRegions para consultar a lista de regiões mais recente.

ReadOnlyInstanceMaxDelayTime String Não 30

Limiar máximo de latência permitido para divisão de leitura/escrita. Se a latência em uma instância somente leitura exceder o limiar especificado, o ApsaraDB RDS deixará de encaminhar solicitações de leitura para essa instância. Se este parâmetro não for especificado, o valor original será mantido. Unidade: segundos. Valores válidos: de 30 a 3600. Valor padrão: 30.

Nota Especifique este parâmetro apenas quando o recurso de divisão de leitura/escrita estiver ativado.
ReadOnlyInstanceDistributionType String Não Standard

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

  • Standard: o ApsaraDB RDS aloca automaticamente pesos de leitura para a instância e suas instâncias somente leitura com base nas especificações das instâncias.
  • Custom: aloque manualmente os pesos de leitura para a instância e suas instâncias somente leitura.
Nota Especifique este parâmetro apenas quando o recurso de divisão de leitura/escrita estiver ativado.

Para mais informações sobre a política de alocação de pesos, consulte Modificar o limiar de latência e os pesos de leitura de instâncias do ApsaraDB RDS for MySQL e Ative e configure o recurso de proxy de banco de dados para uma instância do ApsaraDB RDS for PostgreSQL.

ReadOnlyInstanceWeight String Não {"rm-uf6wjk5xxxx":"500","rr-tfhfgk5xxx":"200"...}

Pesos de leitura da instância e de suas instâncias somente leitura. O peso de leitura deve ser 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-uf6wjk5xxxx":"500","rr-tfhfgk5xxx":"200"...}

  • Instância cluster: {"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-tfhfgk5xxx":"200","DBClusterNode":{"rn-2z****":"0","rn-2z****":"400","rn-2z****":"400"...}}
    Nota O parâmetro DBClusterNode é obrigatório se a instância executar a Edição Cluster do RDS. Esse parâmetro inclui informações sobre IDs e pesos dos nós primários e secundários.
DbEndpointOperator String Não Modify

Tipo de operação a ser executada. Valores válidos:

  • Modify: modifique um endpoint de proxy. Este é o valor padrão.
  • Create: crie um endpoint de proxy.
  • Delete: exclua um endpoint de proxy.
DbEndpointAliases String Não test-proxy

Descrição do endpoint de proxy.

DbEndpointType String Não RWSplit

Tipo do endpoint de proxy. Este é um parâmetro reservado. Não é necessário especificá-lo.

DbEndpointReadWriteMode String Não ReadWrite

Atributos de leitura e escrita do endpoint de proxy. Valores válidos:

  • ReadWrite: o endpoint de proxy conecta-se à instância primária e pode receber solicitações de leitura e escrita.
  • ReadOnly: o endpoint de proxy não se conecta à instância primária e recebe apenas solicitações de leitura. Este é o valor padrão.
Nota
  • Se o parâmetro DbEndpointOperator estiver definido como Create, também especifique o parâmetro 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.
DBProxyEngineType String Não normal

Parâmetro interno. Não é necessário especificá-lo.

Parâmetros de resposta

Parâmetro

Tipo

Exemplo

Descrição

RequestId

String

6B50D92C-1960-4D4F-A290-AFADD6B1A5C8

ID da solicitação.

Exemplos

Solicitações de exemplo

http(s)://rds.aliyuncs.com/?Action=ModifyDBProxyEndpoint
&DBInstanceId=rm-bp145737x5bi6****
&DBProxyEndpointId=gos787jog2wk0y****
&ConfigDBProxyFeatures=ReadWriteSpliting:1;ConnectionPersist:1;
&ReadOnlyInstanceMaxDelayTime=30
&ReadOnlyInstanceDistributionType=Standard
&<Common request parameters>

Respostas de sucesso de exemplo

Formato XML

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

<ModifyDBProxyEndpointResponse>
  <RequestId>6B50D92C-1960-4D4F-A290-AFADD6B1A5C8</RequestId>
</ModifyDBProxyEndpointResponse>

Formato JSON

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

{
  "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.

O ID da VPC especificado é inválido.

400

InvalidEndPoint.Format

The specified EndPoint is not valid.

O parâmetro DBProxyEndpointId está vazio ou o endpoint de proxy especificado pelo parâmetro DBProxyEndpointId não foi encontrado.

400

InvalidEndpointType.Format

The specified EndpointType is invalid.

O valor do parâmetro EndpointType é inválido.

400

IncorrectDBInstanceNetType

The current database instance network type does not support the operation.

O tipo de rede da instância não oferece suporte a esta operação.

400

EndpointNum.Error

The number of endpoint is invalid.

O número de endpoints de proxy configurados não atende aos requisitos.

400

EndpointTypeOperation.NotSupport

The endpoint type does not support the operation.

O tipo de endpoint de proxy especificado não oferece suporte a esta operação.

400

InvalidDBInstanceName

Specified parameter DBInstanceName is not valid.

O valor do parâmetro DBInstanceName é inválido. Verifique se o valor é nulo ou uma string vazia.

400

ClusterEndpoint.StatusNotValid

The cluster endpoint status is invalid.

O status do endpoint de proxy é inválido.

403

MaxScaleLevel.NotSupport

The current maxscale ins_num does not support this operation.

As especificações do proxy de banco de dados não oferecem suporte a esta operação.

403

ReadDBInstance.NotFound

The current database instance does not contain any read only instance.

Nenhuma instância somente leitura está anexada à instância.

403

IncorrectKindCode

The current KindCode of the custins does not support the operation.

A configuração da instância não oferece suporte a esta operação. Verifique a configuração da instância.

403

IncorrectDBInstanceState

The current database instance state does not support the operation.

O status da instância não oferece suporte a esta operação. Verifique se a instância está no estado Running.

404

EndpointConfig.Invalid

Please check the endpoint config parameter.

As configurações do endpoint de proxy são inválidas. Verifique os valores dos parâmetros relacionados.

404

Readins.NotFound

The current instance does not contain any read only instance. The operation is not supported.

Nenhuma instância somente leitura está anexada à instância.

404

Endpoint.NotFound

Specified endpoint is not found.

A porta usada para conectar ao endpoint de proxy não foi encontrada.

404

EndpointType.NotFound

The specified endpoint type is not found.

O tipo de endpoint de proxy especificado é desconhecido pelo sistema.

404

InvalidReadDBInstance.NotFound

The specified read only database instance does not exist.

Nenhuma instância somente leitura está anexada à instância ou as configurações de alguns parâmetros da solicitação estão incorretas.

404

InvalidParam

The specified Weight is invalid.

Os pesos de leitura especificados são inválidos.

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