Interroger les paramètres du proxy - - Centre de documentation Alibaba Cloud

Avant d'appeler l'opération DescribeDBProxy, 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'utiliser OpenAPI Explorer pour appeler cette opération. OpenAPI Explorer génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	DescribeDBProxy	Opération à effectuer. Définissez la valeur sur DescribeDBProxy.
DBInstanceId	String	Oui	rm-bp1ja4f56s7us****	ID de l'instance. Appelez l'opération DescribeDBInstances pour interroger l'ID de l'instance.
RegionId	String	Non	cn-hangzhou	ID de région de l'instance. Appelez l'opération DescribeRegions pour obtenir la liste des régions la plus récente.
DBProxyEngineType	String	Non	normal	Paramètre interne. Ne spécifiez pas ce paramètre.
ResourceGroupId	String	Non	rg-acfmy*	ID du groupe de ressources.

Paramètres de réponse

Paramètre	Type	Exemple	Description
DBProxyInstanceLatestMinorVersion	String	1.13.12	Dernière version de proxy disponible pour l'instance.
RequestId	String	909A69EE-71C8-4417-A0B9-FF085407E1E3	ID de la requête.
DBProxyInstanceCurrentMinorVersion	String	1.13.11	Version de proxy exécutée par l'instance.
DBProxyInstanceNum	Integer	1	Nombre de proxys activés sur l'instance.
DBProxyInstanceType	String	2	Type de proxy de base de données activé sur l'instance. Valeurs valides : 1 : proxy partagé 2 : proxy dédié Remarque Les instances ApsaraDB RDS for PostgreSQL prennent uniquement en charge les proxys dédiés.
DBProxyInstanceStatus	String	Running	État de l'instance de proxy. Valeurs valides : Creating : Création de l'instance de proxy en cours. Running : Instance de proxy en cours d'exécution. DBInstanceClassChanging : Modification des spécifications de l'instance de proxy en cours. Deleting : Suppression de l'instance de proxy en cours.
DBProxyServiceStatus	String	Startup	État de la fonctionnalité de proxy de base de données. Valeurs valides : Startup : activé Shutdown : désactivé
DBProxyInstanceName	String	gos787jog2wk0ye1****	Nom de l'instance de proxy.
DBProxyInstanceSize	String	4/8	Spécifications de l'instance de proxy. Ce paramètre est disponible uniquement pour les instances ApsaraDB RDS for PostgreSQL. Format : Nombre de cœurs/Capacité mémoire. Par exemple, la valeur 4/8 indique que l'instance de proxy dispose de 4 cœurs et de 8 Go de mémoire.
DBProxyEngineType	String	normal	Paramètre interne. Ne spécifiez pas ce paramètre.
DBProxyConnectStringItems	Array of DBProxyConnectStringItems		Tableau contenant les informations sur le point de terminaison de proxy créé pour l'instance.
DBProxyConnectStringItems
DBProxyConnectStringNetWorkType	String	2	Type de réseau du proxy de base de données. Valeurs valides : 0 : Internet 1 : réseau classique 2 : cloud privé virtuel (VPC)
DBProxyConnectStringNetType	String	InnerString	Type de réseau du point de terminaison de proxy. Valeurs valides : InnerString : réseau interne OuterString : Internet
DBProxyVpcInstanceId	String	rm-bp145737x5**131161274792**	ID de l'instance de proxy.
DBProxyEndpointName	String	gos787jog2wk0ye1****	Nom du terminal de proxy auquel appartient le point de terminaison de proxy.
DBProxyEndpointId	String	20****	ID du terminal de proxy auquel appartient le point de terminaison de proxy.
DBProxyConnectStringPort	String	3306	Numéro de port associé au point de terminaison de proxy.
DBProxyConnectString	String	gos787jog2wk0ye1****-rw4rm.rwlb.rds.aliyuncs.com	Point de terminaison du terminal de proxy.
DbProxyEndpointItems	Array of DbProxyEndpointItems		Tableau contenant les informations sur le terminal de proxy.
DbProxyEndpointItems
DbProxyEndpointAliases	String	proxy-test	Description du terminal de proxy.
DbProxyEndpointName	String	gos787jog2wk0ye1****	ID du terminal de proxy.
DbProxyEndpointType	String	RWSplit	Type de terminal de proxy. Valeurs valides : RWSplit : terminal de proxy par défaut Custom : terminal de proxy personnalisé
DbProxyReadWriteMode	String	ReadWrite	Attributs de lecture et d'écriture du terminal de proxy. ReadWrite : Le terminal de proxy prend en charge les requêtes de lecture et d'écriture. ReadOnly : Le terminal de proxy prend uniquement en charge les requêtes de lecture.
ResourceGroupId	String	rg-acfmy*****	ID du groupe de ressources.

Exemples

Exemples de requêtes

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

Exemples de réponses réussies

XML format

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

<DescribeDBProxyResponse>
    <DBProxyInstanceName>gos787jog2wk0ye1****</DBProxyInstanceName>
    <DBProxyInstanceCurrentMinorVersion>1.13.11</DBProxyInstanceCurrentMinorVersion>
    <DBProxyServiceStatus>Startup</DBProxyServiceStatus>
    <DBProxyInstanceNum>1</DBProxyInstanceNum>
    <DBProxyInstanceLatestMinorVersion>1.13.12</DBProxyInstanceLatestMinorVersion>
    <RequestId>909A69EE-71C8-4417-A0B9-FF085407E1E3</RequestId>
    <DbProxyEndpointItems>
        <DbProxyEndpointItems>
            <DbProxyEndpointName>gos787jog2wk0ye1****</DbProxyEndpointName>
            <DbProxyEndpointAliases>proxy-test</DbProxyEndpointAliases>
            <DbProxyEndpointType>RWSplit</DbProxyEndpointType>
            <DbProxyReadWriteMode>ReadWrite</DbProxyReadWriteMode>
        </DbProxyEndpointItems>
    </DbProxyEndpointItems>
    <DBProxyConnectStringItems>
        <DBProxyConnectStringItems>
            <DBProxyConnectString>gos787jog2wk0ye1****-rw4rm.rwlb.rds.aliyuncs.com</DBProxyConnectString>
            <DBProxyEndpointId>209090</DBProxyEndpointId>
            <DBProxyEndpointName>gos787jog2wk0ye1****</DBProxyEndpointName>
            <DBProxyConnectStringNetWorkType>2</DBProxyConnectStringNetWorkType>
            <DBProxyConnectStringNetType>InnerString</DBProxyConnectStringNetType>
            <DBProxyConnectStringPort>3306</DBProxyConnectStringPort>
            <DBProxyVpcInstanceId>rm-bp145737x5****131161274792****</DBProxyVpcInstanceId>
        </DBProxyConnectStringItems>
    </DBProxyConnectStringItems>
    <DBProxyInstanceStatus>Running</DBProxyInstanceStatus>
    <DBProxyInstanceType>2</DBProxyInstanceType>
</DescribeDBProxyResponse>

JSON format

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

{
  "DBProxyInstanceName" : "gos787jog2wk0ye1****",
  "DBProxyInstanceCurrentMinorVersion" : "1.13.11",
  "DBProxyServiceStatus" : "Startup",
  "DBProxyInstanceNum" : 1,
  "DBProxyInstanceLatestMinorVersion" : "1.13.12",
  "RequestId" : "909A69EE-71C8-4417-A0B9-FF085407E1E3",
  "DbProxyEndpointItems" : {
    "DbProxyEndpointItems" : [ {
      "DbProxyEndpointName" : "gos787jog2wk0ye1****",
      "DbProxyEndpointAliases" : "proxy-test",
      "DbProxyEndpointType" : "RWSplit",
      "DbProxyReadWriteMode" : "ReadWrite"
    } ]
  },
  "DBProxyConnectStringItems" : {
    "DBProxyConnectStringItems" : [ {
      "DBProxyConnectString" : "gos787jog2wk0ye1****-rw4rm.rwlb.rds.aliyuncs.com",
      "DBProxyEndpointId" : 209090,
      "DBProxyEndpointName" : "gos787jog2wk0ye1****",
      "DBProxyConnectStringNetWorkType" : 2,
      "DBProxyConnectStringNetType" : "InnerString",
      "DBProxyConnectStringPort" : "3306",
      "DBProxyVpcInstanceId" : "rm-bp145737x5****131161274792****"
    } ]
  },
  "DBProxyInstanceStatus" : "Running",
  "DBProxyInstanceType" : "2"
}

Codes d'erreur

Code d'état HTTP	Code d'erreur	Message d'erreur	Description
400	InvalidDBInstanceName	Specified parameter DBInstanceName is not valid.	La valeur du paramètre DBInstanceName n'est pas valide. Vérifiez si la valeur est nulle ou une chaîne vide.
403	IncorrectKindCode	Current custins kindCode does not support this operation.	La configuration de l'instance ne prend pas en charge cette opération. Vérifiez la configuration de l'instance.
403	IncorrectDBInstanceType	The database instance type does not support the operation.	Cette opération n'est pas prise en charge par le moteur de base de données exécuté sur l'instance.

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