Consulta de un endpoint de proxy - - Centro de documentación de Alibaba Cloud

Puede llamar a la operación DescribeDBProxyEndpoint para consultar los detalles de un endpoint de proxy utilizado para conectarse al proxy de base de datos de una instancia.

Antes de llamar a la operación DescribeDBProxyEndpoint, asegúrese de haber llamado a la operación ModifyDBProxy para habilitar la función de proxy de base de datos en la instancia.

La función de proxy dedicado de ApsaraDB RDS for MySQL ofrece capacidades como la división de lectura/escritura y la optimización de conexiones de corta duración. Para obtener más información, consulte ¿Qué son los proxies de base de datos?
La función de proxy de base de datos de ApsaraDB RDS for PostgreSQL admite la división de lectura/escritura. Para obtener más información, consulte ¿Qué son los proxies de base de datos?

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, le recomendamos llamar a esta operación desde OpenAPI Explorer. Esta herramienta genera dinámicamente el código de ejemplo de la operación para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	DescribeDBProxyEndpoint	La operación que desea ejecutar. Establezca el valor en DescribeDBProxyEndpoint.
DBInstanceId	String	Sí	rm-bp1ja4f56s7us****	El ID de la instancia. Puede llamar a la operación DescribeDBInstances para consultar el ID de la instancia.
DBProxyEndpointId	String	No	keaxncrjluwu0gue****	El nombre del terminal de proxy al que pertenece el endpoint de proxy. Puede llamar a la operación DescribeDBProxy para consultar el nombre del terminal de proxy.
DBProxyConnectString	String	No	testproxy****.rwlb.rds.aliyuncs.com	El endpoint de proxy que desea consultar. Puede llamar a la operación DescribeDBProxy para consultar el endpoint de proxy.
RegionId	String	Sí	cn-hangzhou	El ID de región de la instancia. Puede llamar a la operación DescribeRegions para consultar la lista de regiones más reciente.
DBProxyEngineType	String	No	normal	Un parámetro interno. No es necesario especificar este parámetro.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
DBProxyConnectStringNetType	String	InnerString	El tipo de red del endpoint de proxy. Valores válidos: InnerString: red interna OuterString: Internet
DBProxyFeatures	String	TransactionReadSqlRouteOptimizeStatus:1;ConnectionPersist:0;ReadWriteSpliting:1	La configuración del terminal de proxy. El valor de este parámetro es una cadena JSON que consta de los siguientes campos: TransactionReadSqlRouteOptimizeStatus: el estado de la función de división de transacciones. Valores válidos: 0 y 1. El valor 0 indica que la función está deshabilitada. El valor 1 indica que la función está habilitada. ConnectionPersist: el estado de la función de agrupación de conexiones. Valores válidos: 0, 1 y 2. El valor 0 indica que la función de agrupación de conexiones está deshabilitada. El valor 1 indica que la agrupación de conexiones de sesión está habilitada. El valor 2 indica que la agrupación de conexiones de transacción está habilitada. ReadWriteSpliting: el estado de la función de división de lectura/escritura. Valores válidos: 0 y 1. El valor 0 indica que la función está deshabilitada. El valor 1 indica que la función está habilitada. PinPreparedStmt: un campo interno disponible solo para instancias de ApsaraDB RDS for PostgreSQL. Nota Si la instancia ejecuta PostgreSQL, solo puede modificar el valor del campo ReadWriteSpliting. Los campos TransactionReadSqlRouteOptimizeStatus y PinPreparedStmt se establecen en sus valores predeterminados de 1.
RequestId	String	847BA085-B377-4BFA-8267-F82345ECE1D2	El ID de la solicitud.
ReadOnlyInstanceWeight	String	[{\"Availability\":\"Available\",\"DBInstanceId\":\"rm-2z**\",\"DBInstanceType\":\"Master\",\"NodeId\":\"rn-t2\",\"NodeType\":\"Primary\",\"Weight\":0}, {\"Availability\":\"Available\",\"DBInstanceId\":\"rm-2z\",\"DBInstanceType\":\"Master\",\"NodeId\":\"rn-z9\",\"NodeType\":\"Secondary\",\"Weight\":400}, {\"Availability\":\"Available\",,\"DBInstanceId\":\"rm-2z\",\"DBInstanceType\":\"Master\",\"NodeId\":\"rn-1c**\",\"NodeType\":\"Secondary\",\"Weight\":400}]]	Los pesos de lectura de la instancia y sus instancias de solo lectura. El valor de este parámetro es una cadena JSON que consta de los siguientes campos: DBInstanceId: el ID de la instancia. DBInstanceType: el rol de la instancia. Valores válidos: Master y ReadOnly. NodeID: los ID de los nodos primario y secundario en la instancia principal si la instancia ejecuta RDS Cluster Edition. NodeType: el tipo de nodo si la instancia ejecuta RDS Cluster Edition. Valores válidos: Primary y Secondary. El valor Primary indica el nodo primario en la instancia principal. El valor Secondary indica el nodo secundario en la instancia principal. Weight: el peso de lectura de la instancia. El peso de lectura aumenta en incrementos de 100 y no puede exceder 10000.
ReadOnlyInstanceDistributionType	String	Standard	El método utilizado para asignar pesos de lectura. Para obtener más información, consulte Modificar el umbral de latencia y los pesos de lectura de instancias de ApsaraDB RDS for MySQL. Valores válidos: Standard: ApsaraDB RDS asigna automáticamente pesos de lectura a la instancia y a sus instancias de solo lectura según las especificaciones de las instancias. Custom: Debe asignar manualmente los pesos de lectura a la instancia y a sus instancias de solo lectura.
ReadOnlyInstanceMaxDelayTime	String	30	El umbral de latencia permitido para la división de lectura/escritura. Si la latencia en una instancia de solo lectura supera el umbral especificado, ApsaraDB RDS deja de reenviar solicitudes de lectura a dicha instancia.
DbProxyEndpointReadWriteMode	String	ReadWrite	Los atributos de lectura y escritura del terminal de proxy. Valores válidos: ReadWrite: El terminal de proxy admite solicitudes de lectura y escritura. ReadOnly: El terminal de proxy solo admite solicitudes de lectura.
DbProxyEndpointAliases	String	proxyterminal-test	La descripción del terminal de proxy.
DBProxyEndpointId	String	keaxncrjluwu0gue****	El ID del endpoint de proxy.
DBProxyConnectStringPort	String	3306	El número de puerto asociado con el endpoint de proxy.
DBProxyConnectString	String	testproxy****.rwlb.rds.aliyuncs.com	El endpoint de proxy consultado.
DBProxyEngineType	String	normal	Un parámetro interno. Puede ignorar este parámetro.
EndpointConnectItems	Array of EndpointConnectItems		Una matriz que contiene la información sobre el endpoint de proxy.
EndpointConnectItems
DbProxyEndpointPort	String	3306	El número de puerto asociado con el endpoint de proxy. Valor predeterminado: 3306.
DbProxyEndpointConnectString	String	testproxy****.rwlb.rds.aliyuncs.com	El endpoint de proxy consultado.
DbProxyEndpointNetType	String	2	El tipo de red del endpoint de proxy. Valores válidos: 0: Internet 1: red clásica 2: virtual private cloud (VPC)

Ejemplos

Solicitudes de ejemplo

http(s)://rds.aliyuncs.com/?Action=DescribeDBProxyEndpoint
&DBInstanceId=rm-bp1ja4f56s7us****
&RegionId=cn-hangzhou
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

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

<DescribeDBProxyEndpointResponse>
    <DBProxyConnectStringNetType>InnerString</DBProxyConnectStringNetType>
    <DBProxyFeatures>TransactionReadSqlRouteOptimizeStatus:1;ConnectionPersist:0;ReadWriteSpliting:1</DBProxyFeatures>
    <RequestId>847BA085-B377-4BFA-8267-F82345ECE1D2</RequestId>
    <ReadOnlyInstanceWeight>[{\"Availability\":\"Available\",\"DBInstanceId\":\"rr-bp****\",\"DBInstanceType\":\"ReadOnly\",\"NodeId\":\"rr-bp****\",\"NodeType\":\"ReadOnly\",\"Weight\":400}, {\"Availability\":\"Available\",\"DBInstanceId\":\"rm-2z****\",\"DBInstanceType\":\"Master\",\"NodeId\":\"rm-2z****-instance-2\",\"NodeType\":\"Secondary\",\"Weight\":400}, {\"Availability\":\"Available\",\"DBInstanceId\":\"rm-2z****\",\"DBInstanceType\":\"Master\",\"NodeId\":\"rm-2z****-instance-3\",\"NodeType\":\"Secondary\",\"Weight\":400}, {\"Availability\":\"Available\",,\"DBInstanceId\":\"rm-2z****\",\"DBInstanceType\":\"Master\",\"NodeId\":\"rm-2z****-instance-1\",\"NodeType\":\"Primary\",\"Weight\":0}]]</ReadOnlyInstanceWeight>
    <ReadOnlyInstanceDistributionType>Standard</ReadOnlyInstanceDistributionType>
    <ReadOnlyInstanceMaxDelayTime>30</ReadOnlyInstanceMaxDelayTime>
    <DbProxyEndpointReadWriteMode>ReadWrite</DbProxyEndpointReadWriteMode>
    <DbProxyEndpointAliases>proxyterminal-test</DbProxyEndpointAliases>
    <DBProxyEndpointId>keaxncrjluwu0gue****</DBProxyEndpointId>
    <DBProxyConnectStringPort>3306</DBProxyConnectStringPort>
    <DBProxyConnectString>testproxy****.rwlb.rds.aliyuncs.com</DBProxyConnectString>
    <DBProxyEngineType>normal</DBProxyEngineType>
    <EndpointConnectItems>
        <DbProxyEndpointPort>3306</DbProxyEndpointPort>
        <DbProxyEndpointConnectString>testproxy****.rwlb.rds.aliyuncs.com</DbProxyEndpointConnectString>
        <DbProxyEndpointNetType>2</DbProxyEndpointNetType>
    </EndpointConnectItems>
</DescribeDBProxyEndpointResponse>

Formato JSON

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

{
  "DBProxyConnectStringNetType" : "InnerString",
  "DBProxyFeatures" : "TransactionReadSqlRouteOptimizeStatus:1;ConnectionPersist:0;ReadWriteSpliting:1",
  "RequestId" : "847BA085-B377-4BFA-8267-F82345ECE1D2",
  "ReadOnlyInstanceWeight" : "[{\\\"Availability\\\":\\\"Available\\\",\\\"DBInstanceId\\\":\\\"rr-bp****\\\",\\\"DBInstanceType\\\":\\\"ReadOnly\\\",\\\"NodeId\\\":\\\"rr-bp****\\\",\\\"NodeType\\\":\\\"ReadOnly\\\",\\\"Weight\\\":400}, {\\\"Availability\\\":\\\"Available\\\",\\\"DBInstanceId\\\":\\\"rm-2z****\\\",\\\"DBInstanceType\\\":\\\"Master\\\",\\\"NodeId\\\":\\\"rm-2z****-instance-2\\\",\\\"NodeType\\\":\\\"Secondary\\\",\\\"Weight\\\":400}, {\\\"Availability\\\":\\\"Available\\\",\\\"DBInstanceId\\\":\\\"rm-2z****\\\",\\\"DBInstanceType\\\":\\\"Master\\\",\\\"NodeId\\\":\\\"rm-2z****-instance-3\\\",\\\"NodeType\\\":\\\"Secondary\\\",\\\"Weight\\\":400}, {\\\"Availability\\\":\\\"Available\\\",,\\\"DBInstanceId\\\":\\\"rm-2z****\\\",\\\"DBInstanceType\\\":\\\"Master\\\",\\\"NodeId\\\":\\\"rm-2z****-instance-1\\\",\\\"NodeType\\\":\\\"Primary\\\",\\\"Weight\\\":0}]]",
  "ReadOnlyInstanceDistributionType" : "Standard",
  "ReadOnlyInstanceMaxDelayTime" : "30",
  "DbProxyEndpointReadWriteMode" : "ReadWrite",
  "DbProxyEndpointAliases" : "proxyterminal-test",
  "DBProxyEndpointId" : "keaxncrjluwu0gue****",
  "DBProxyConnectStringPort" : "3306",
  "DBProxyConnectString" : "testproxy****.rwlb.rds.aliyuncs.com",
  "DBProxyEngineType" : "normal",
  "EndpointConnectItems" : [ {
    "DbProxyEndpointPort" : "3306",
    "DbProxyEndpointConnectString" : "testproxy****.rwlb.rds.aliyuncs.com",
    "DbProxyEndpointNetType" : "2"
  } ]
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	InvalidEndPoint.Format	The specified EndPoint is not valid.	El mensaje de error devuelto porque no se especificó el parámetro DBProxyEndpointId o no se encuentra el ID especificado por dicho parámetro.
400	InvalidDBInstanceName	Specified parameter DBInstanceName is not valid.	El mensaje de error devuelto porque el valor del parámetro DBInstanceName no es válido. Compruebe si el valor es nulo o una cadena vacía.
400	Endpoint.NotFound	The specified EndPoint is not valid.	El mensaje de error devuelto porque el terminal de proxy especificado no existe.
403	IncorrectKindCode	The current KindCode of the custins does not support the operation.	El mensaje de error devuelto porque la configuración de la instancia no es compatible con esta operación. Verifique la configuración de la instancia principal.
403	IncorrectDBInstanceType	The current database instance type does not support the operation.	El mensaje de error devuelto porque la configuración de la instancia no es compatible con esta operación.
404	Endpoint.NotFound	Specified endpoint is not found.	El mensaje de error devuelto porque no se encuentra el número de puerto especificado.

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