Consulta de endpoints - - Centro de documentación de Alibaba Cloud

Puede llamar a la operación DescribeDBInstanceNetInfo para consultar los endpoints de una instancia de ApsaraDB RDS.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, le recomendamos que llame a esta operación en OpenAPI Explorer. OpenAPI Explorer genera dinámicamente el código de ejemplo de la operación para diferentes SDKs.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	DescribeDBInstanceNetInfo	La operación que desea ejecutar. Establezca el valor en DescribeDBInstanceNetInfo.
ClientToken	String	No	ETnLKlblzczshOTUbOC*****	El token de cliente que se utiliza para garantizar la idempotencia de la solicitud. Puede usar el cliente para generar el token, pero debe asegurarse de que sea único entre las distintas solicitudes. El token solo puede contener caracteres ASCII y no debe exceder los 64 caracteres de longitud.
DBInstanceId	String	Sí	rm-uf6wjk5*****	El ID de la instancia.
Flag	Integer	No	N/A	Un parámetro reservado.
DBInstanceNetRWSplitType	String	No	Normal	El tipo de endpoint. Valores válidos: Normal: endpoint estándar ReadWriteSplitting: endpoint con separación de lectura/escritura Nota De forma predeterminada, el sistema devuelve ambos tipos de endpoints.
GeneralGroupName	String	No	rgc-2ze*****	El nombre del clúster dedicado al que pertenece la instancia. Este parámetro solo surte efecto cuando la instancia ejecuta MySQL en RDS Standard Edition y se creó en un clúster dedicado.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
SecurityIPMode	String	safety	El modo de lista blanca de la instancia. Valores válidos: normal: modo de lista blanca estándar safety: modo de lista blanca mejorado
RequestId	String	777C4593-8053-427B-99E2-105593277CAB	El ID de la solicitud.
InstanceNetworkType	String	VPC	El tipo de red de la instancia. Valores válidos: Classic VPC
DBInstanceNetInfos	Array of DBInstanceNetInfo		Detalles de los endpoints de la instancia.
DBInstanceNetInfo
VSwitchId	String	vsw-uf6adz52c2p*****	El ID del vSwitch.
ConnectionStringType	String	Normal	El tipo de endpoint. Valores válidos: Normal: endpoint estándar ReadWriteSplitting: endpoint con separación de lectura/escritura
ConnectionString	String	rm-uf6w*****.mysql.rds.aliyuncs.com	El endpoint de la instancia.
ExpiredTime	String	1,209,534	El periodo de validez restante de la instancia de red clásica en modo de acceso híbrido. Unidad: segundos.
Upgradeable	String	Disabled	Indica si se puede actualizar la versión de IP. Valores válidos: Enable: La versión de IP se puede actualizar. Disabled: La versión de IP no se puede actualizar. Nota La versión de IP se puede actualizar de IPv4 a IPv6.
MaxDelayTime	String	12	El umbral de latencia. Este parámetro solo se devuelve para un endpoint con separación de lectura/escritura. Unidad: segundos. Nota Si la latencia en una instancia de solo lectura supera el umbral especificado, ApsaraDB RDS deja de reenviar solicitudes de lectura a dicha instancia.
IPType	String	Public	El tipo de red. Valores válidos cuando la instancia reside en la red clásica: Inner:: red interna Public: Internet Valores válidos cuando la instancia reside en una nube privada virtual (VPC): Private: red interna Public: Internet
Port	String	3306	El puerto que se usa para conectarse a la instancia.
BabelfishPort	String	1433	El puerto Tabular Data Stream (TDS) de la instancia con Babelfish habilitado. Nota Este parámetro solo aplica a instancias de ApsaraDB RDS for PostgreSQL. Para obtener más información sobre Babelfish para ApsaraDB RDS for PostgreSQL, consulte Introducción a Babelfish.
VPCId	String	vpc-uf6f7l4fg90*****	El ID de la VPC a la que pertenece la instancia.
DistributionType	String	Standard	La política que se usa para asignar pesos de lectura. Este parámetro solo se devuelve para un endpoint con separación de lectura/escritura. Valores válidos: Standard: ApsaraDB RDS asigna automáticamente pesos de lectura a la instancia y a sus instancias de solo lectura según sus especificaciones. Custom: Debe asignar manualmente los pesos de lectura a la instancia y a sus instancias de solo lectura.
IPAddress	String	192.168.XX.XX	La dirección IP de la instancia.
SecurityIPGroups	Array of securityIPGroup		Detalles sobre las listas blancas de IP de la instancia.
securityIPGroup
SecurityIPs	String	127.0.XX.XX	Las direcciones IP incluidas en la lista blanca de direcciones IP.
SecurityIPGroupName	String	Default	El nombre de la lista blanca de direcciones IP.
DBInstanceWeights	Array of DBInstanceWeight		Detalles del peso. Este parámetro solo se devuelve cuando la función de separación de lectura/escritura está habilitada para la instancia.
DBInstanceWeight
Availability	String	Unavailable	La disponibilidad de la instancia. Valores válidos: Unavailable Available
Weight	String	100	El peso de la instancia.
DBInstanceId	String	rm-uf6wjk5*****	El ID de la instancia.
Role	String	N/A	Un parámetro obsoleto.
DBInstanceType	String	Master	El rol de la instancia. Valores válidos: Master: instancia principal Readonly: instancia de solo lectura

Ejemplos

Solicitudes de ejemplo

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

Respuestas exitosas de ejemplo

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 error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	IllegalParameter	Illegal parameter	El mensaje de error devuelto porque los parámetros especificados no son válidos.

Para obtener una lista de códigos de error, visite el Centro de errores de API.