Interroger un endpoint de proxy - - Centre de documentation Alibaba Cloud

Avant d'appeler l'opération DescribeDBProxyEndpoint, assurez-vous d'avoir appelé l'opération ModifyDBProxy pour activer la fonctionnalité de proxy de base de données sur l'instance.

La fonctionnalité de proxy dédié d'ApsaraDB RDS for MySQL offre des capacités telles que la répartition lecture/écriture et l'optimisation des connexions éphémères. Pour plus d'informations, consultez la rubrique Présentation des proxys de base de données
La fonctionnalité de proxy de base de données d'ApsaraDB RDS for PostgreSQL prend en charge la répartition lecture/écriture. Pour plus d'informations, consultez la rubrique Présentation des proxys de base de données

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement l'exemple de code de l'opération pour différents SDK.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	DescribeDBProxyEndpoint	L'opération à effectuer. Définissez la valeur sur DescribeDBProxyEndpoint.
DBInstanceId	String	Oui	rm-bp1ja4f56s7us****	ID de l'instance. Appelez l'opération DescribeDBInstances pour interroger l'ID de l'instance.
DBProxyEndpointId	String	Non	keaxncrjluwu0gue****	Nom du terminal de proxy auquel appartient l'endpoint de proxy. Appelez l'opération DescribeDBProxy pour interroger le nom du terminal de proxy.
DBProxyConnectString	String	Non	testproxy****.rwlb.rds.aliyuncs.com	Endpoint de proxy à interroger. Appelez l'opération DescribeDBProxy pour interroger l'endpoint de proxy.
RegionId	String	Oui	cn-hangzhou	ID de région de l'instance. Appelez l'opération DescribeRegions pour interroger la liste des régions les plus récentes.
DBProxyEngineType	String	Non	normal	Paramètre interne. Il n'est pas nécessaire de spécifier ce paramètre.

Paramètres de réponse

Paramètre	Type	Exemple	Description
DBProxyConnectStringNetType	String	InnerString	Type de réseau de l'endpoint de proxy. Valeurs possibles : InnerString : réseau interne OuterString : Internet
DBProxyFeatures	String	TransactionReadSqlRouteOptimizeStatus:1;ConnectionPersist:0;ReadWriteSpliting:1	Configuration du terminal de proxy. La valeur de ce paramètre est une chaîne JSON composée des champs suivants : TransactionReadSqlRouteOptimizeStatus : statut de la fonctionnalité de fractionnement des transactions. Valeurs possibles : 0 et 1. La valeur 0 indique que la fonctionnalité est désactivée. La valeur 1 indique que la fonctionnalité est activée. ConnectionPersist : statut de la fonctionnalité de regroupement de connexions. Valeurs possibles : 0, 1 et 2. La valeur 0 indique que la fonctionnalité de regroupement de connexions est désactivée. La valeur 1 indique que la fonctionnalité de regroupement de connexions de session est activée. La valeur 2 indique que la fonctionnalité de regroupement de connexions de transaction est activée. ReadWriteSpliting : statut de la fonctionnalité de répartition lecture/écriture. Valeurs possibles : 0 et 1. La valeur 0 indique que la fonctionnalité est désactivée. La valeur 1 indique que la fonctionnalité est activée. PinPreparedStmt : champ interne disponible uniquement pour les instances ApsaraDB RDS for PostgrSQL. Remarque Si l'instance exécute PostgreSQL, vous ne pouvez modifier que la valeur du champ ReadWriteSpliting. Les champs TransactionReadSqlRouteOptimizeStatus et PinPreparedStmt sont définis sur leurs valeurs par défaut 1.
RequestId	String	847BA085-B377-4BFA-8267-F82345ECE1D2	ID de la requête.
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}]]	Poids de lecture de l'instance et de ses instances en lecture seule. La valeur de ce paramètre est une chaîne JSON composée des champs suivants : DBInstanceId : ID de l'instance. DBInstanceType : rôle de l'instance. Valeurs possibles : Master et ReadOnly. NodeID : ID des nœuds primaire et secondaire sur l'instance principale si l'instance exécute l'édition Cluster RDS. NodeType : type de nœud si l'instance exécute l'édition Cluster RDS. Valeurs possibles : Primary et Secondary. La valeur Primary indique le nœud primaire sur l'instance principale. La valeur Secondary indique le nœud secondaire sur l'instance principale. Weight : poids de lecture de l'instance. Le poids de lecture augmente par incréments de 100 et ne peut pas dépasser 10000.
ReadOnlyInstanceDistributionType	String	Standard	Méthode utilisée pour attribuer les poids de lecture. Pour plus d'informations, consultez la rubrique Modifier le seuil de latence et les poids de lecture des instances ApsaraDB RDS for MySQL. Valeurs possibles : Standard : ApsaraDB RDS alloue automatiquement les poids de lecture à l'instance et à ses instances en lecture seule en fonction des spécifications des instances. Custom : Vous devez attribuer manuellement les poids de lecture à l'instance et à ses instances en lecture seule.
ReadOnlyInstanceMaxDelayTime	String	30	Seuil de latence autorisé pour la répartition lecture/écriture. Si la latence sur une instance en lecture seule dépasse le seuil spécifié, ApsaraDB RDS ne transfère plus les requêtes de lecture vers l'instance en lecture seule.
DbProxyEndpointReadWriteMode	String	ReadWrite	Attributs de lecture et d'écriture du terminal de proxy. Valeurs possibles : ReadWrite : Le terminal de proxy prend en charge les requêtes de lecture et d'écriture. ReadOnly : Le terminal de proxy prend en charge uniquement les requêtes de lecture.
DbProxyEndpointAliases	String	proxyterminal-test	Description du terminal de proxy.
DBProxyEndpointId	String	keaxncrjluwu0gue****	ID de l'endpoint de proxy.
DBProxyConnectStringPort	String	3306	Numéro de port associé à l'endpoint de proxy.
DBProxyConnectString	String	testproxy****.rwlb.rds.aliyuncs.com	Endpoint de proxy interrogé.
DBProxyEngineType	String	normal	Paramètre interne. Vous pouvez ignorer ce paramètre.
EndpointConnectItems	Array of EndpointConnectItems		Tableau composé des informations relatives à l'endpoint de proxy.
EndpointConnectItems
DbProxyEndpointPort	String	3306	Numéro de port associé à l'endpoint de proxy. Valeur par défaut : 3306.
DbProxyEndpointConnectString	String	testproxy****.rwlb.rds.aliyuncs.com	Endpoint de proxy interrogé.
DbProxyEndpointNetType	String	2	Type de réseau de l'endpoint de proxy. Valeurs possibles : 0 : Internet 1 : réseau classique 2 : cloud privé virtuel (VPC)

Exemples

Exemple de requête

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

Exemple de réponse réussie

XML format

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>

JSON format

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"
  } ]
}

Codes d'erreur

Code d'état HTTP	Code d'erreur	Message d'erreur	Description
400	InvalidEndPoint.Format	The specified EndPoint is not valid.	Le message d'erreur renvoyé car le paramètre DBProxyEndpointId n'est pas spécifié ou l'ID spécifié par le paramètre DBProxyEndpointId est introuvable.
400	InvalidDBInstanceName	Specified parameter DBInstanceName is not valid.	Le message d'erreur renvoyé car la valeur du paramètre DBInstanceName n'est pas valide. Vérifiez si la valeur est nulle ou une chaîne vide.
400	Endpoint.NotFound	The specified EndPoint is not valid.	Le message d'erreur renvoyé car le terminal de proxy spécifié n'existe pas.
403	IncorrectKindCode	The current KindCode of the custins does not support the operation.	Le message d'erreur renvoyé car la configuration de l'instance ne prend pas en charge cette opération. Vérifiez la configuration de l'instance principale.
403	IncorrectDBInstanceType	The current database instance type does not support the operation.	Le message d'erreur renvoyé car la configuration de l'instance ne prend pas en charge cette opération.
404	Endpoint.NotFound	Specified endpoint is not found.	Le message d'erreur renvoyé car le numéro de port que vous avez spécifié est introuvable.

Pour obtenir la liste des codes d'erreur, consultez le Centre d'erreurs de l'API.