Todos os produtos
Search
Central de documentação

:Criar um proxy endpoint

Última atualização: Jun 26, 2026

Chame a operação CreateDBProxyEndpointAddress para criar um proxy endpoint usado na conexão com o proxy de banco de dados de uma instância do ApsaraDB RDS.

Após ativar o recurso de proxy dedicado em uma instância do ApsaraDB RDS for MySQL ou o recurso de proxy de banco de dados em uma instância do ApsaraDB RDS for PostgreSQL, um proxy endpoint padrão é criado automaticamente. Chame esta operação para criar proxy endpoints de diferentes tipos de rede. Para mais informações, consulte O que são proxies de banco de dados? e Ativar e configure o recurso de proxy de banco de dados para uma instância do ApsaraDB RDS for PostgreSQL.

Nota
  • Os seguintes tipos de rede são compatíveis com instâncias que utilizam SSDs locais: VPC, Classic e Public.

  • Os seguintes tipos de rede são compatíveis com instâncias que utilizam SSDs padrão ou SSDs aprimorados (ESSDs): VPC e Public. Para crie um proxy endpoint do tipo de rede pública, configure listas de permissões de endereços IP para a instância e suas instâncias somente leitura, garantindo a conectividade entre o cliente e a instância. Chame a operação ModifySecurityIps para configure uma lista de permissões de endereços IP para uma instância.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code for different SDKs.

Parâmetros de requisição

Parameter Type Required Example Description
Action String Yes CreateDBProxyEndpointAddress

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

RegionId String Yes cn-hangzhou

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

DBInstanceId String Yes rm-t4n3axxxxx

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

DBProxyEndpointId String Yes ta9um4xxxxx

O ID do proxy endpoint. Chame a operação DescribeDBProxyEndpoint para consultar o ID do proxy endpoint.

ConnectionStringPrefix String Yes test1234

O prefixo do proxy endpoint. Insira um prefixo personalizado.

DBProxyNewConnectStringPort String No 3306

O número da porta associada ao proxy endpoint.

  • Se a instância usar MySQL, o valor padrão é 3306.
  • Se a instância usar PostgreSQL, o valor padrão é 5432.
DBProxyConnectStringNetType String Yes Public

O tipo de rede do proxy endpoint. Valores válidos:

  • Public
  • VPC
  • Classic

Valor padrão: Classic.

VPCId String No vpc-bpxxxxxx

O ID da VPC à qual o proxy endpoint pertence. Chame a operação DescribeDBInstanceAttribute para consultar o ID da VPC.

Nota Se o parâmetro DBProxyConnectStringNetType for definido como VPC, especifique também o parâmetro VPCId.
VSwitchId String No vsw-bpxxxxxx

O ID do vSwitch associado à VPC especificada. Chame a operação DescribeDBInstanceAttribute para consultar o ID do vSwitch.

Nota Se o parâmetro DBProxyConnectStringNetType for definido como VPC, especifique também o parâmetro VSwitchId.
DBProxyEngineType String No normal

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

ResourceGroupId String No rg-acfmy*****

O ID do grupo de recursos.

Parâmetros de resposta

Parameter

Type

Example

Description

RequestId

String

F2911788-25E8-42E5-A3A3-1B38D263F01E

O ID da requisição.

Exemplos

Exemplos de requisições

http(s)://rds.aliyuncs.com/?Action=CreateDBProxyEndpointAddress
&RegionId=cn-hangzhou
&DBInstanceId=m-t4n3axxxxx
&DBProxyEndpointId=ta9um4xxxxx
&DBProxyConnectStringNetType=Public
&ConnectionStringPrefix=test1234
&<Common request parameters>

Exemplos de respostas bem-sucedidas

XML format

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

<CreateDBProxyEndpointAddressResponse>
<RequestId>F2911788-25E8-42E5-A3A3-1B38D263F01E</RequestId>
</CreateDBProxyEndpointAddressResponse>

JSON format

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

{
  "RequestId" : "F2911788-25E8-42E5-A3A3-1B38D263F01E"
}

Códigos de erro

HTTP status code

Error code

Error message

Description

400

InvalidPort.Malformed

Specified port is not valid.

A porta especificada é inválida.

400

NetTypeExists

Specified net type already existed.

Já existe um proxy endpoint do tipo de rede especificado.

400

IncorrectDBInstanceNetType

Current DB instance net type does not support this operation.

O tipo de rede da instância não é compatível com esta operação.

400

InvalidConnectionString.Duplicate

Specified connection string already exists in the Aliyun RDS.

O proxy endpoint especificado já existe. Especifique um endpoint diferente.

400

InvalidVpcInstanceId

Specified vpc instance id is not valid.

O ID de VPC especificado é inválido.

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.

403

IncorrectDBInstanceType

Current DB instance type does not support this operation.

Esta operação não é compatível com a instância no estado atual.

403

IncorrectDBInstanceState

Current DB instance state does not support this operation.

Esta operação não é compatível quando a instância está no estado atual.

404

Endpoint.NotFound

Specified endpoint is not found.

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

404

InvalidVSwitchId.NotFound

The specified VSwitch is invalid.

O ID do vSwitch especificado é inválido.

404

Maxscale.NotFound

The related maxscale instance is not found.

As instâncias MaxScale associadas não foram encontradas.

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