DescribeDBProxyEndpoint - ApsaraDB RDS - Centre de documentation Alibaba Cloud

Obtient le point de terminaison du proxy de base de données d'une instance RDS.

Description de l'opération

Moteurs pris en charge.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

rds:DescribeDBProxyEndpoint

get

*DBInstance.

acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

rds:ResourceTag
rds:ResourceTag
rds:ResourceTag
rds:ResourceTag

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
DBInstanceId	string	Oui	L'identifiant de l'instance. Vous pouvez appeler l'opération DescribeDBInstances pour obtenir les identifiants des instances.	rm-bp1ja4f56s7us****
DBProxyEndpointId	string	Non	L'identifiant du point de terminaison du proxy. Vous pouvez appeler l'opération DescribeDBProxy pour obtenir cet identifiant.	keaxncrjluwu0gue****
DBProxyConnectString	string	Non	La chaîne de connexion du proxy. Vous pouvez appeler l'opération DescribeDBProxy pour obtenir cette chaîne de connexion.	testproxy****.rwlb.rds.aliyuncs.com
RegionId	string	Non	L'identifiant de la région. Vous pouvez appeler l'opération DescribeRegions pour obtenir la liste des régions la plus récente.	cn-hangzhou
DBInstanceId	string	Oui	L'identifiant de l'instance. Vous pouvez appeler l'opération DescribeDBInstances pour obtenir les identifiants des instances.	rm-bp1ja4f56s7us****
DBProxyEngineType	string	Non	Ce paramètre est réservé et n'a pas besoin d'être spécifié.	normal

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les paramètres de réponse.
DBProxyConnectString	string	La chaîne de connexion du proxy.	testproxy****.rwlb.rds.aliyuncs.com
DBProxyConnectStringNetType	string	Le type de réseau de la chaîne de connexion du proxy. Valeurs valides : InnerString : Adresse interne. OuterString : Adresse publique.	InnerString
DBProxyConnectStringPort	string	Le port de la chaîne de connexion du proxy.	3306
DBProxyEndpointId	string	L'identifiant du point de terminaison du proxy.	keaxncrjluwu0gue****
DBProxyEngineType	string	Un paramètre réservé. Vous pouvez ignorer ce paramètre.	normal
DBProxyFeatures	string	Les paramètres de fonctionnalité du point de terminaison du proxy. La valeur est une chaîne de paires clé-valeur délimitées par des points-virgules. La chaîne contient les clés suivantes : TransactionReadSqlRouteOptimizeStatus : Indique si le fractionnement des transactions doit être activé. Valeurs valides : 0 (désactivé) et 1 (activé). ConnectionPersist : Indique le type de pool de connexions. Valeurs valides : 0 (désactivé), 1 (pool de connexions au niveau de la session) et 2 (pool de connexions au niveau de la transaction). ReadWriteSpliting : Indique si le fractionnement lecture/écriture doit être activé. Valeurs valides : 0 (désactivé) et 1 (activé). AZProximityAccess : La fonctionnalité d'accès de proximité. Valeurs valides : 0 (désactivé) et 1 (activé). CausalConsistRead : Indique le niveau de cohérence de lecture. Valeurs valides : 0 (cohérence à terme), 1 (cohérence de session) et 2 (cohérence globale). HtapFilter : Le routage automatique des requêtes HTAP. Valeurs valides : 0 (désactivé) et 1 (activé). PinPreparedStmt : un paramètre interne réservé qui n'est visible que pour les instances ApsaraDB RDS for PostgreSQL. Remarque Pour les instances ApsaraDB RDS for PostgreSQL, vous ne pouvez modifier que le paramètre ReadWriteSpliting. Les clés TransactionReadSqlRouteOptimizeStatus et PinPreparedStmt sont définies de manière permanente sur 1.	TransactionReadSqlRouteOptimizeStatus:1;ConnectionPersist:0;ReadWriteSpliting:1
DBProxyNodes	object
DBProxyNodes	array<object>	Les nœuds de proxy associés au point de terminaison du proxy.
	object	Les propriétés d'un nœud de proxy.
cpuCores	string	Le nombre de cœurs de processeur pour le nœud.	2
nodeId	string	L'identifiant du nœud de proxy.	pn-xxxxxxx01
zoneId	string	L'identifiant de la zone de disponibilité où se trouve le nœud.	cn-hangzhou-c
DbProxyEndpointAliases	string	L'alias du point de terminaison du proxy.	proxyterminal-test
DbProxyEndpointReadWriteMode	string	Le mode lecture/écriture du point de terminaison du proxy. Valeurs valides : ReadWrite : mode lecture/écriture. ReadOnly : mode lecture seule.	ReadWrite
DbProxyEndpointVswitchId	string	L'identifiant du VSwitch du point de terminaison du proxy.	vsw-****
DbProxyEndpointVpcId	string	L'identifiant du VPC du point de terminaison du proxy.	vpc-****
DbProxyEndpointZoneId	string	L'identifiant de la zone de disponibilité dans laquelle le point de terminaison du proxy est créé.	cn-hangzhou-c
EndpointConnectItems	object
EndpointConnectItems	array<object>	Une liste des détails des chaînes de connexion du proxy.
	object	Les détails d'une chaîne de connexion du proxy.
DbProxyEndpointConnectString	string	L'adresse de connexion du proxy.	testproxy****.rwlb.rds.aliyuncs.com
DbProxyEndpointNetType	string	Le type de réseau. Valeurs valides : 0 : réseau public 1 : réseau classique 2 : VPC	2
DbProxyEndpointPort	string	Le numéro de port. Valeur par défaut : 3306.	3306
ReadOnlyInstanceDistributionType	string	Le mode de répartition des poids de lecture. Pour plus d'informations, consultez Répartition des poids de lecture. Valeurs valides : Standard : le système attribue automatiquement les poids de lecture aux instances en fonction de leurs spécifications. Custom : vous spécifiez des poids de lecture personnalisés pour les instances.	Standard
ReadOnlyInstanceMaxDelayTime	string	Le seuil de latence pour la répartition lecture/écriture. Si la latence de réplication sur une instance en lecture seule dépasse ce seuil, les requêtes de lecture ne sont pas acheminées vers l'instance. Unité : secondes.	30
CausalConsistReadTimeout	string	Le délai d'expiration pour une lecture cohérente, en millisecondes. Valeurs valides : 0 à 60000. Valeur par défaut : 10.	10
ReadOnlyInstanceWeight	string	La distribution des poids de lecture. La valeur est une chaîne JSON qui spécifie les poids de lecture des instances principales et en lecture seule. Elle contient les champs suivants : DBInstanceId : L'identifiant de l'instance. DBInstanceType : Le type d'instance. Valeurs valides : Master (instance principale) et ReadOnly (instance en lecture seule). NodeID : L'identifiant du nœud principal ou secondaire de l'instance principale si l'instance exécute RDS Cluster Edition. NodeType : Le type de nœud d'une instance qui exécute RDS Cluster Edition. Valeurs valides : Primary (nœud principal) et Secondary (nœud secondaire). Weight : Le poids de lecture de l'instance. La valeur augmente par incréments de 100, avec une valeur maximale de 10000.	[{\"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}]]
RequestId	string	L'identifiant de la requête.	847BA085-B377-4BFA-8267-F82345ECE1D2
DBProxyEndpointCostThresholdForDuckdb	string
DBProxyEndpointMinSlaveCount	string	Le nombre minimum d'instances en lecture seule à conserver.	2

Exemples

JSON format

{
  "DBProxyConnectString": "testproxy****.rwlb.rds.aliyuncs.com",
  "DBProxyConnectStringNetType": "InnerString",
  "DBProxyConnectStringPort": "3306",
  "DBProxyEndpointId": "keaxncrjluwu0gue****",
  "DBProxyEngineType": "normal",
  "DBProxyFeatures": "TransactionReadSqlRouteOptimizeStatus:1;ConnectionPersist:0;ReadWriteSpliting:1",
  "DBProxyNodes": {
    "DBProxyNodes": [
      {
        "cpuCores": "2",
        "nodeId": "pn-xxxxxxx01",
        "zoneId": "cn-hangzhou-c"
      }
    ]
  },
  "DbProxyEndpointAliases": "proxyterminal-test",
  "DbProxyEndpointReadWriteMode": "ReadWrite",
  "DbProxyEndpointVswitchId": "vsw-****",
  "DbProxyEndpointVpcId": "vpc-****",
  "DbProxyEndpointZoneId": "cn-hangzhou-c",
  "EndpointConnectItems": {
    "EndpointConnectItems": [
      {
        "DbProxyEndpointConnectString": "testproxy****.rwlb.rds.aliyuncs.com",
        "DbProxyEndpointNetType": "2",
        "DbProxyEndpointPort": "3306"
      }
    ]
  },
  "ReadOnlyInstanceDistributionType": "Standard",
  "ReadOnlyInstanceMaxDelayTime": "30",
  "CausalConsistReadTimeout": "10",
  "ReadOnlyInstanceWeight": "[{\\\"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}]]",
  "RequestId": "847BA085-B377-4BFA-8267-F82345ECE1D2",
  "DBProxyEndpointCostThresholdForDuckdb": "",
  "DBProxyEndpointMinSlaveCount": "2"
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	MaxscaleNotSupport	Current custins can not support Maxscale.	Cette opération n'est pas prise en charge pour les instances avec MaxScale.
400	InvalidEndPoint.Format	The specified EndPoint is not valid.	L'identifiant de l'adresse de connexion du proxy dédié (DBProxyEndpointId) n'est pas spécifié ou n'existe pas. Vérifiez le paramètre Endpoint.
400	InvalidDBInstanceName	Specified parameter DBInstanceName is not valid.	La valeur du paramètre DBInstanceName spécifié est nulle, ou aucune instance correspondante n'a été trouvée. Vérifiez le paramètre DBInstanceName.
400	Endpoint.NotFound	The specified EndPoint is not valid.	Le point de terminaison cible n'existe pas.
400	InvalidParameter	The specified parameter is invalid.	Paramètre non valide.
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.	Les opérations individuelles ne sont pas autorisées pour les instances de forfait.
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.	Le résultat de tarification du plan de prix est introuvable.
400	Order.NoRealNameAuthentication	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.	Vous n'avez pas effectué la vérification de votre identité et n'êtes pas éligible pour effectuer des achats. Connectez-vous à la console Dépenses et Coûts pour effectuer la vérification de votre identité.
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.	Le crédit disponible de votre compte est inférieur à 0. Rechargez votre compte avant de tenter un achat.
400	CommodityServiceCalling.Exception	Failed to call commodity service.	L'appel au service des produits a échoué.
400	RegionDissolvedEOM	Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.	Alibaba Cloud prévoit d'optimiser et d'ajuster la région actuelle. Les services cloud dans cette région seront interrompus. Pour assurer la continuité de vos activités et une migration fluide des données, vous ne pouvez pas passer de nouvelles commandes d'achat pour le moment. Merci de votre compréhension et de votre soutien.
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.	Le module que vous avez acheté n'est pas valide. Achetez un module valide.
400	RegionEndTimeDissolvedAustralia	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.	La région a été mise hors service.
400	Price.CommoditySys	Commodity system call exception.	Une exception s'est produite lors de l'appel au système de produits.
400	Pay.InsufficientBalance	Insufficient available balance.
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.	La période d'abonnement que vous avez sélectionnée n'est pas valide. Sélectionnez une période valide.
400	pay.noCreditCard	Account not bound to credit card.	Aucune carte de crédit n'est disponible.
400	Order.InstHasUnpaidOrder	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.	Une commande impayée existe pour le service que vous avez sélectionné. Payez ou annulez la commande existante avant d'en passer une nouvelle.
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.	Aucun mode de paiement n'est spécifié pour le compte. Ajoutez un mode de paiement.
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.	Vos informations de base sont incomplètes. Complétez vos informations de base avant d'effectuer cette opération.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.	Une exception s'est produite sur votre compte. Contactez le service client pour plus de détails.
400	Api.NotSupport	Specified api is not supported.	L'opération d'API actuelle n'est pas prise en charge.
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.	Une balise de blocage de commande existe. Contactez votre distributeur pour résoudre ce problème.
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.	Le DBInstanceId spécifié n'existe pas.
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type	La spécification actuelle de l'instance ne prend pas en charge ce type de stockage.
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.	Le paramètre d'entrée n'est pas valide.
400	KmsApiError	User secret key invalid.	La clé utilisateur n'est pas valide.
400	System.SaleValidateFailed	Sales expression validation system error.
400	Abs.InvalidAccount.NotFound	account is not found.	Votre compte Alibaba Cloud n'existe pas, ou votre AccessKey a expiré.
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.	L'exécution de la commande SQL a échoué ou a expiré.
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.	La version actuelle du moteur de base de données de l'instance ne prend pas en charge l'archivage des données froides.
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.	La version actuelle du noyau ne prend pas en charge l'archivage des données froides.
400	IncorrectTargetClasscode	The current instance type does not support this operation.	La spécification de l'instance actuelle ne prend pas en charge cette opération.
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.	Le nom de l'adresse de connexion est en double. Définissez à nouveau la chaîne de connexion.
400	RequiredParam.NotFound	Required input param is not found.	Des paramètres requis sont manquants.
400	Parameters.Invalid	Parameter error, please check the parameters.	Le paramètre est incorrect. Vérifiez le paramètre.
400	BackupPolicyNotSupport	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.	La stratégie de sauvegarde actuelle ne prend pas en charge cette opération.
400	InvalideStatus.Format	The instance status does not support this operation.	L'état de l'instance ne prend pas en charge cette opération.
400	InvalidReleasedKeepPolicy.Format	Specified Released Keep Policy is not valid.	La stratégie de conservation des données de sauvegarde archivées après la libération de l'instance n'est pas valide.
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.	Le type de moteur de base de données de l'instance ne prend pas en charge cette opération.
400	Pay.NoCreditCard	No credit cards.
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.	Cette opération n'est pas prise en charge pour les instances de type réseau VPC.
400	MirrorInsExists	Specified DB instance mirror ins already existed.	L'image de l'instance de base de données existe déjà.
400	UnsupportedClassCode	The specified DB instance class stops selling.	Le type d'instance n'est plus disponible à l'achat.
400	InvalidBackupSet	The specified database does not exist in the backup set.	La base de données spécifiée n'existe pas dans le jeu de sauvegarde.
400	OrdTCommodityQueryError	Failed to query for product.	Échec de l'interrogation du produit.
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.	L'instance a été libérée. Vérifiez l'instance avant de passer la commande.
400	RegionEndTimeDissolvedIndia	The region is no longer supported.	La région spécifiée n'est pas valide.
500	ExternalFailure	The request processing has failed due to external service failure.	La requête adressée au service a échoué. Réessayez plus tard.
500	RequestMetaDataFailed	The service request failed. Please try again later or contact service personnel.	La demande de service a échoué. Réessayez plus tard ou contactez le support.
500	InvokeProxyFailure	The request processing has failed due to service failure of rds api.	Le traitement de la requête a échoué en raison d'une défaillance du service API RDS.
403	IncorrectKindCode	The current KindCode of the custins does not support the operation.	L'opération a échoué. Le type d'environnement de l'instance actuelle n'est pas pris en charge. Vérifiez les types d'instances pris en charge par l'opération d'API.
403	IncorrectDBInstanceType	The current database instance type does not support the operation.	L'opération a échoué. Cette opération n'est pas prise en charge dans l'état actuel de l'instance.
403	IncorrectDBInstanceEngine	Current DB Instance engine does not support this operation.	L'opération a échoué. Le moteur de base de données n'est pas pris en charge.
403	OrderStatus.UnPaid	The specified db instance has unpaid order.	Une commande impayée existe pour l'instance actuelle. Payez la commande et réessayez.
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.	La capacité cible pour la réduction de capacité ne peut pas être inférieure à l'utilisation actuelle du stockage.
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.	Les disques cloud SSD ne prennent pas en charge cette opération. Effectuez une mise à niveau vers ESSD.
403	InvalidUserOperatorPermission	The user permission does not support this operation.	Les autorisations de l'utilisateur ne prennent pas en charge cette opération.
403	InvalidVswitchId	Specified conn vswitch id is not valid.	Le VSwitchId spécifié a un format incorrect ou est vide.
403	IncorrectMinorVersion	Current engine minor version does not support operations.	La version mineure actuelle du moteur ne prend pas en charge cette opération.
403	OperationDenied.ZoneResource	There is no available zone for inventory.	Aucune région d'inventaire n'est disponible.
403	NotInFlowController	Sorry,no permission.	Cette fonctionnalité n'est pas disponible. Vous n'avez pas l'autorisation de l'utiliser car vous n'êtes pas un utilisateur du cloud d'entreprise.
403	InvalidKmsKey	Kms key is disabled.	La clé KMS est désactivée.
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.	Le niveau actuel de l'instance de base de données ne prend pas en charge cette opération.
403	InvalidVpcInfo.NotFound	Specified VPC info does not exist.	Les informations VPC spécifiées n'existent pas.
404	Endpoint.NotFound	Specified endpoint is not found.	Le point de terminaison cible n'existe pas.
404	Maxscale.NotFound	The relative maxscale instance is not found.	L'opération a échoué. L'instance MaxScale associée est introuvable.
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.	L'instance actuelle n'est pas autorisée à accéder à Key Management Service.
404	Request.NotFound	The requested resource is not available.	La ressource demandée n'est pas disponible.
404	HostInfo.NotFound	The specified host info is not found.	Les informations d'hôte spécifiées n'existent pas.

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.