Consulta de endpoints - : Central de Documentação do Alibaba Cloud

Depuração

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

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribeDBInstanceNetInfo	Operação a ser executada. Defina o valor como DescribeDBInstanceNetInfo.
ClientToken	String	Não	ETnLKlblzczshOTUbOC*****	Token do cliente usado para garantir a idempotência da solicitação. Gere o token no cliente e garanta que seja único entre diferentes solicitações. O token aceita apenas caracteres ASCII e não pode exceder 64 caracteres.
DBInstanceId	String	Sim	rm-uf6wjk5*****	ID da instância.
Flag	Integer	Não	N/A	Parâmetro reservado.
DBInstanceNetRWSplitType	String	Não	Normal	Tipo do endpoint. Valores válidos: Normal: endpoint padrão ReadWriteSplitting: endpoint de divisão de leitura e escrita Nota Por padrão, o sistema retorna ambos os tipos de endpoint.
GeneralGroupName	String	Não	rgc-2ze*****	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

Parâmetro	Tipo	Exemplo	Descrição
SecurityIPMode	String	safety	Modo da lista de permissões da instância. Valores válidos: normal: modo de lista de permissões padrão safety: modo de lista de permissões aprimorado
RequestId	String	777C4593-8053-427B-99E2-105593277CAB	ID da solicitação.
InstanceNetworkType	String	VPC	Tipo de rede da instância. Valores válidos: Classic VPC
DBInstanceNetInfos	Array of DBInstanceNetInfo		Detalhes dos endpoints da instância.
DBInstanceNetInfo
VSwitchId	String	vsw-uf6adz52c2p*****	ID do vSwitch.
ConnectionStringType	String	Normal	Tipo do endpoint. Valores válidos: Normal: endpoint padrão ReadWriteSplitting: endpoint de divisão de leitura e escrita
ConnectionString	String	rm-uf6w*****.mysql.rds.aliyuncs.com	Endpoint da instância.
ExpiredTime	String	1209534	Período de validade restante da instância na rede clássica em modo de acesso híbrido. Unidade: segundos.
Upgradeable	String	Disabled	Indica se é possível atualizar a versão do IP. Valores válidos: Ative: a versão do IP pode ser atualizada. Disabled: a versão do IP não pode ser atualizada. Nota É possível atualizar a versão do IP de IPv4 para IPv6.
MaxDelayTime	String	12	Limiar de latência. Retornado apenas para endpoints de divisão de leitura e escrita. Unidade: segundos. Nota 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.
IPType	String	Public	Tipo de rede. Valores válidos para instâncias na rede clássica: Inner:: rede interna Public: Internet Valores válidos para instâncias em uma Virtual Private Cloud (VPC): Private: rede interna Public: Internet
Port	String	3306	Porta usada para conectar à instância.
BabelfishPort	String	1433	Porta TDS (Tabular Data Stream) da instância com o Babelfish ativado. Nota Este parâmetro aplica-se apenas a instâncias do ApsaraDB RDS for PostgreSQL. Para obter mais informações sobre o Babelfish para ApsaraDB RDS for PostgreSQL, consulte Introdução ao Babelfish.
VPCId	String	vpc-uf6f7l4fg90*****	ID da VPC à qual a instância pertence.
DistributionType	String	Standard	Política de atribuição de pesos de leitura. Retornado apenas para endpoints de divisão de leitura e escrita. Valores válidos: Standard: o ApsaraDB RDS atribui automaticamente pesos de leitura à instância e às suas instâncias somente leitura com base nas especificações delas. Custom: atribua manualmente os pesos de leitura à instância e às suas instâncias somente leitura.
IPAddress	String	192.168.XX.XX	Endereço IP da instância.
SecurityIPGroups	Array of securityIPGroup		Detalhes das listas de permissões de IP da instância.
securityIPGroup
SecurityIPs	String	127.0.XX.XX	Endereços IP contidos na lista de permissões de IP.
SecurityIPGroupName	String	Default	Nome da lista de permissões de IP.
DBInstanceWeights	Array of DBInstanceWeight		Detalhes do peso. Retornado apenas quando o recurso de divisão de leitura e escrita está ativado para a instância.
DBInstanceWeight
Availability	String	Unavailable	Disponibilidade da instância. Valores válidos: Unavailable Available
Weight	String	100	Peso da instância.
DBInstanceId	String	rm-uf6wjk5*****	ID da instância.
Role	String	N/A	Parâmetro obsoleto.
DBInstanceType	String	Master	Função da instância. Valores válidos: Master: instância primária Readonly: instância somente leitura

Exemplos

Solicitações de exemplo

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

Respostas de sucesso de exemplo

Formato XML

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

<DescribeDBInstanceNetInfoResponse>
    <dBInstanceNetInfos>
        <connectionString>rm-uf6wjk5*****.mysql.rds.aliyuncs.com</connectionString>
        <connectionStringType>Normal</connectionStringType>
        <iPAddress>192.168.XX.XX</iPAddress>
        <iPType>Public</iPType>
        <port>3306</port>
        <upgradeable>Disabled</upgradeable>
        <vPCId/>
    </dBInstanceNetInfos>
    <instanceNetworkType>Classic</instanceNetworkType>
    <requestId>777C4593-8053-427B-99E2-105593277CAB</requestId>
</DescribeDBInstanceNetInfoResponse>

Formato JSON

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

{
  "dBInstanceNetInfos" : {
    "connectionString" : "rm-uf6wjk5*****.mysql.rds.aliyuncs.com",
    "connectionStringType" : "Normal",
    "iPAddress" : "192.168.XX.XX",
    "iPType" : "Public",
    "port" : 3306,
    "upgradeable" : "Disabled",
    "vPCId" : ""
  },
  "instanceNetworkType" : "Classic",
  "requestId" : "777C4593-8053-427B-99E2-105593277CAB"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	IllegalParameter	Illegal parameter	Os parâmetros especificados são inválidos.

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