Todos os produtos
Search
Central de documentação

:Solicitar um endpoint público

Última atualização: Jun 26, 2026

Chame a operação AllocateInstancePublicConnection para solicitar um endpoint público para uma instância do ApsaraDB RDS.

Debugging

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para maior comodidade, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parameter Type Required Example Description
Action String Yes AllocateInstancePublicConnection

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

DBInstanceId String Yes rm-uf6wjk5*****

O ID da instância.

ConnectionStringPrefix String Yes test1234

O prefixo do endpoint público. Um endpoint público válido segue o formato: Prefixo.Motor de banco de dados.rds.aliyuncs.com. Exemplo: test1234.mysql.rds.aliyuncs.com.

Nota O valor deve ter entre 5 e 40 caracteres e pode conter letras, dígitos e hifens (-). Os seguintes caracteres não são permitidos: ~ ! # % ^ & * = + | {} ; : ' " , <> / ?
Port String Yes 3306

A porta pública da instância. Valores válidos: 1000 a 5999.

BabelfishPort String No 1433

A porta Tabular Data Stream (TDS) da instância com Babelfish ativado.

Nota Este parâmetro se aplica apenas a instâncias do ApsaraDB RDS for PostgreSQL. Para mais informações sobre o Babelfish para ApsaraDB RDS for PostgreSQL, consulte Introdução ao Babelfish.
GeneralGroupName String No rgc-bp1tkv8*****

O nome do cluster dedicado ao qual a instância pertence. Este parâmetro só tem efeito quando a instância executa MySQL na RDS Standard Edition e foi criada em um cluster dedicado.

Parâmetros de resposta

Parameter

Type

Example

Description

DbInstanceName

String

rm-bp1*

O ID da instância.

RequestId

String

65BDA532-28AF-4122-AA39-B382721EEE64

O ID da solicitação.

ConnectionString

String

test*.mysql.rds.aliyuncs.com

O endpoint usado para se conectar à instância.

Exemplos

Exemplos de solicitação

http(s)://rds.aliyuncs.com/?Action=AllocateInstancePublicConnection
&ConnectionStringPrefix=test1234
&DBInstanceId=rm-uf6wjk5*****
&Port=3306
&<Common request parameters>

Exemplos de resposta bem-sucedida

XML format

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

<AllocateInstancePublicConnectionResponse>
    <DbInstanceName>rm-bp1*****</DbInstanceName>
    <RequestId>65BDA532-28AF-4122-AA39-B382721EEE64</RequestId>
    <ConnectionString>test*****.mysql.rds.aliyuncs.com</ConnectionString>
</AllocateInstancePublicConnectionResponse>

JSON format

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

{
  "DbInstanceName" : "rm-bp1*****",
  "RequestId" : "65BDA532-28AF-4122-AA39-B382721EEE64",
  "ConnectionString" : "test*****.mysql.rds.aliyuncs.com"
}

Códigos de erro

HTTP status code

Error code

Error message

Description

400

OtherEndpoint.Exist

Other endpoint exist.

O prefixo do endpoint público especificado já existe.

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