Todos os produtos
Search
Central de documentação

ApsaraDB RDS:ModifyDBProxyEndpoint

Última atualização: Oct 23, 2026

Configura a política de acesso para o endpoint de proxy de banco de dados de uma instância do ApsaraDB RDS.

Descrição da operação

Mecanismos de banco de dados compatíveis

  • ApsaraDB RDS for MySQL

  • ApsaraDB RDS for PostgreSQL

Documentação de recursos relacionados

Importante Antes de chamar esta operação, leia a documentação do recurso cuidadosamente para 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.

rm-bp145737x5bi6****

DBProxyEndpointId

string

Não

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

Nota
  • MySQL: Este parâmetro é obrigatório quando DbEndpointOperator é definido como Delete ou Modify.

  • PostgreSQL: Este parâmetro é obrigatório quando DbEndpointOperator é definido como Delete, Modify ou Create.

gos787jog2wk0y****

ConfigDBProxyFeatures

string

Não

Especifica os recursos de proxy a serem ativados para o endpoint de proxy. Separe vários recursos com ponto e vírgula (;). Formato: Recurso 1:Status;Recurso 2:Status;.... Não adicione um ponto e vírgula (;) no final.

Valores válidos para 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.

  • HtapFilter: Distribuição automática de solicitações entre nós de armazenamento de linhas e armazenamento de colunas para HTAP.

Valores válidos para o status:

  • 1: O recurso está ativado.

  • 0: O recurso está desativado.

Nota
  • O ApsaraDB RDS for PostgreSQL oferece suporte apenas a ReadWriteSpliting.

  • O recurso de acesso mais próximo é suportado apenas por proxies de banco de dados dedicados para MySQL.

ReadWriteSpliting:1;ConnectionPersist:0

RegionId

string

Não

O ID da região. Você pode chamar a operação DescribeRegions para consultar o ID.

cn-hangzhou

ReadOnlyInstanceMaxDelayTime

string

Não

O limite máximo de latência para instâncias somente leitura na divisão de leitura e gravação. Se a latência de uma instância somente leitura exceder esse limite, o tráfego de leitura não será roteado para a instância. Unidade: segundos. Se você não especificar este parâmetro, o valor original será mantido. Valores válidos: 0 a 3600.

Nota
  • Este parâmetro é obrigatório apenas quando a divisão de leitura e gravação está ativada.

  • Valor padrão: 30 quando o atributo de leitura/gravação é definido como Leitura/Gravação (divisão de leitura e gravação) e -1 (desativado) quando o atributo de leitura/gravação é definido como Somente leitura.

30

CausalConsistReadTimeout

string

Não

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

10

ReadOnlyInstanceDistributionType

string

Não

O padrão de alocação de peso de leitura. Valores válidos:

  • Standard: Aloca automaticamente os pesos de leitura com base nas especificações da instância. Este é o valor padrão.

  • Custom: Pesos alocados personalizados.

Nota

Este parâmetro é obrigatório apenas quando a divisão de leitura e gravação está ativada. Para obter mais informações sobre o padrão de alocação de peso de leitura, consulte Distribuição de peso de leitura para MySQL e Ativar e configurar o serviço de proxy de banco de dados para PostgreSQL.

Standard

ReadOnlyInstanceWeight

string

Não

Os pesos de leitura personalizados das instâncias primárias e somente leitura. O peso deve ser um múltiplo de 100 e não pode exceder 10000. Formato:

  • 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 do ApsaraDB RDS for MySQL 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 é um parâmetro de solicitação específico para instâncias Cluster Edition. Ele contém o NodeID e o Weight dos nós primário e secundário.

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

DbEndpointOperator

string

Não

O tipo de operação. Valores válidos:

  • Modify: Modifica o 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 parâmetro é reservado e não precisa ser especificado.

RWSplit

DbEndpointReadWriteMode

string

Não

O modo de leitura/gravação. Valores válidos:

  • ReadWrite: Conecta-se à instância primária e pode aceitar solicitações de gravação.

  • ReadOnly: Não se conecta à instância primária e não pode aceitar solicitações de gravação. Este é o valor padrão.

Nota
  • Este parâmetro é obrigatório quando DbEndpointOperator é definido como Create.

  • Para uma instância do ApsaraDB RDS for MySQL, se 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

[Deprecated] Este parâmetro foi descontinuado e não precisa ser configurado.

normal

VSwitchId

string

Não

O ID do vSwitch na zona do endpoint de proxy de banco de dados. Valor padrão: o ID do vSwitch que corresponde ao endpoint padrão da instância de proxy. Você pode chamar a operação DescribeVSwitches para consultar os vSwitches criados.

vsw-uf6adz52c2p****

EffectiveTime

string

Não

O horário de efetivação. Valores válidos:

  • Immediate: A modificação entra em vigor imediatamente.

  • MaintainTime: A modificação entra em vigor dentro da janela de manutenção. Para obter mais informações, consulte ModifyDBInstanceMaintainTime.

  • SpecificTime: A modificação entra em vigor em um horário especificado.

Valor padrão: MaintainTime.

MaintainTime

EffectiveSpecificTime

string

Não

O horário específico em que a modificação entra em vigor. Especifique o horário no formato aaaa-MM-ddTHH:mm:ssZ. O horário deve estar em UTC.

Nota

Este parâmetro é obrigatório quando EffectiveTime é definido como SpecificTime.

2023-05-06T07:08:09Z

DbEndpointMinSlaveCount

string

Não

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

2

DbEndpointCostThresholdForDuckdb

string

Não

O limite de custo de execução para instruções SQL na distribuição automática de solicitações entre nós de armazenamento de linhas e armazenamento de colunas para HTAP.

30000

VpcId

string

Não

O ID da VPC na zona do endpoint de proxy de banco de dados. Valor padrão: o ID da VPC que corresponde ao endpoint padrão da instância de proxy. Você pode chamar a operação DescribeDBInstanceAttribute para consultar a VPC padrão da 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 porque o ID da instância VPC atual é inválido.
400 InvalidEndPoint.Format The specified EndPoint is not valid. O ID do endpoint de proxy dedicado (DBProxyEndpointId) não foi fornecido. Verifique o parâmetro Endpoint.
400 InvalidEndpointType.Format The specified EndpointType is invalid. O EndpointType especificado é inválido. Verifique o parâmetro.
400 IncorrectDBInstanceNetType The current database instance network type does not support the operation. A operação falhou porque o tipo de rede do banco de dados não oferece suporte a esta operação.
400 EndpointNum.Error The number of endpoint is invalid. O número atual de endpoints não atende aos requisitos. Verifique a quantidade de endpoints com suporte.
400 EndpointTypeOperation.NotSupport The endpoint type does not support the operation. O tipo de endpoint atual não oferece suporte a esta operação. Verifique o tipo de endpoint de proxy.
400 InvalidDBInstanceName Specified parameter DBInstanceName is not valid. O nome da instância especificado (DBInstanceName) é inválido. Verifique se o valor do parâmetro é nulo ou uma string vazia.
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. A operação falhou porque a instância não oferece suporte ao proxy dedicado. Verifique a configuração para ativar o proxy dedicado.
400 InvalidAvZone.Format Specified AvZone is not valid. A AvZone especificada é inválida. Verifique se o parâmetro está correto.
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 de preços para o plano 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 passou pela verificação de nome real e não atende aos requisitos de 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 saldo disponível da sua conta é menor que zero. Adicione fundos à sua conta antes de tentar fazer uma compra.
400 CommodityServiceCalling.Exception Failed to call commodity service. A chamada para o serviço de comércio falhou.
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. A Alibaba Cloud planeja otimizar e ajustar a região atual, e os serviços em nuvem nesta região cessarão as operações. Para garantir a continuidade dos negócios e uma transição suave para a migração de dados, você não pode fazer novos pedidos de compra no momento. Agradecemos a 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 comércio.
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 novamente o período.
400 pay.noCreditCard Account not bound to credit card. A sua conta não está vinculada 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. Você tem pedidos não pagos para o serviço selecionado. Pague ou cancele os pedidos não pagos antes de fazer um novo pedido.
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 sua conta. Adicione um método de pagamento.
400 BasicInfoUncompleted Your information is incomplete. Complete your information before the operation. Suas informações estão incompletas. Complete suas informações antes de prosseguir.
400 Risk.RiskControlRejection Your account is abnormal, please contact customer service for details. Uma anomalia foi detectada em sua conta. Entre em contato com o suporte ao cliente para obter detalhes.
400 Api.NotSupport Specified api is not supported. Esta operação de API não é suportada.
400 ContainForbiddenLabelError There is a label that prohibits placing orders. Please contact your distributor for assistance. Existe uma tag que proíbe a realização de pedidos. Entre em contato com seu distribuidor para obter assistência.
400 InvalidDBInstanceId.NotFound The DBInstanceId provided does not exist in records. A instância especificada não existe. Verifique se a instância existe e se não foi excluída.
400 InvalidInstanceLevel.DiskType Specified instance level not support request disk type O tipo de instância atual não suporta este tipo de armazenamento.
400 InvalidParam Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica. A operação falhou porque o parâmetro é 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. A conta não existe.
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 de banco de dados 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 suporta esta operação.
400 InvalidConnectionString.Duplicate Specified connection string already exists in the RDS. O nome do endpoint está duplicado. Reconfigure a string de conexão.
400 RequiredParam.NotFound Required input param is not found. Os parâmetros obrigatórios não foram fornecidos.
400 Parameters.Invalid Parameter error, please check the parameters. O parâmetro é inválido. Verifique os parâmetros.
400 BackupPolicyNotSupport Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy. O arquivamento de dados não suporta backups entre regiões ou snapshots de nível de segundo. Verifique a política de backup.
400 InvalideStatus.Format The instance status does not support this operation. O status atual 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 para backups 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 venda.
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. A consulta do produto falhou.
400 ProductInstanceReleased The instance has been released. Please check before placing the order. A instância foi liberada. Verifique o status da instância antes de fazer um pedido.
400 RegionEndTimeDissolvedIndia The region is no longer supported. A região foi desativada.
400 APICallingFailed Api calling failed. Uma chamada interna para a API de backend falhou.
400 InvalidVSwitchId.Format The specified vswitch Id format is incorrect. O formato do ID do vSwitch especificado está incorreto.
500 ExternalFailure The request processing has failed due to external service failure. A solicitação de 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 técnico.
500 InvokeProxyFailure The request processing has failed due to service failure of rds api. O processamento da solicitação falhou devido a uma falha no serviço da API do ApsaraDB RDS.
403 MaxScaleLevel.NotSupport The current maxscale ins_num does not support this operation. A operação falhou porque as especificações atuais 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. A instância de banco de dados atual não possui uma instância somente leitura.
403 IncorrectKindCode The current KindCode of the custins does not support the operation. A operação falhou porque o tipo de ambiente da instância atual não é suportado. Verifique os tipos de instância suportados pela operação de API.
403 IncorrectDBInstanceState The current database instance state does not support the operation. A operação falhou. O status atual da instância não oferece suporte a esta operação. Tente novamente mais tarde.
403 IncorrectDBInstanceEngine Current DB Instance engine does not support this operation. A operação falhou porque o mecanismo de banco de dados atual não é suportado.
403 IncorrectDBInstanceType Current DB instance type does not support this operation. A operação falhou porque o mecanismo e o tipo da instância de banco de dados atual não são suportados.
403 OrderStatus.UnPaid The specified db instance has unpaid order. A instância possui pedidos não pagos. Pague os pedidos e tente novamente.
403 InvalidReduceDiskSize The storage capacity after the scale-down must be larger than the used amount. A capacidade de armazenamento de destino 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 SSDs padrão não suportam esta operação. Atualize para ESSDs.
403 InvalidUserOperatorPermission The user permission does not support this operation. Você não tem as permissões necessárias para realizar esta operação.
403 InvalidVswitchId Specified conn vswitch id is not valid. O VSwitchId especificado é inválido ou está vazio.
403 IncorrectMinorVersion Current engine minor version does not support operations. A versão secundária atual do mecanismo não oferece suporte a esta operação.
403 OperationDenied.ZoneResource There is no available zone for inventory. Nenhuma zona tem estoque disponível.
403 NotInFlowController Sorry,no permission. Este recurso não está disponível para usuários de nuvem não corporativos. 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. A operação falhou porque o código de especificação especificado não suporta o número de endpoints. Verifique o número de shards e o número atual de endpoints.
404 EndpointConfig.Invalid Please check the endpoint config parameter. A configuração do endpoint de proxy está incorreta. Verifique os parâmetros.
404 Readins.NotFound The current instance does not contain any read only instance. The operation is not supported. A operação falhou porque não existe nenhuma instância somente leitura para a instância atual.
404 Endpoint.NotFound Specified endpoint is not found. A operação falhou porque o endpoint especificado não foi encontrado.
404 EndpointType.NotFound The specified endpoint type is not found. A operação falhou porque 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 da instância solicitado é inválido.
404 InvalidParam The specified Weight is invalid. A operação falhou porque o parâmetro é inválido.
404 Maxscale.NotFound The related maxscale instance is not found. A operação falhou porque 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.