DescribeDBProxy - ApsaraDB RDS - Centre de documentation Alibaba Cloud

Consulte les paramètres de PolarProxy 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

Aucune autorisation n'est requise pour cette opération. En cas de problème, contactez le support technique.

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 l'identifiant de l'instance.	rm-bp1ja4f56s7us****
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 l'identifiant de l'instance.	rm-bp1ja4f56s7us****
DBProxyEngineType	string	Non	Un paramètre obsolète. Vous n'avez pas besoin de spécifier ce paramètre.	normal
ResourceGroupId	string	Non	L'identifiant du groupe de ressources.	rg-acfmy****

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les paramètres de réponse.
DBProxyInstanceMinorVersions	object		2.25.9
DBProxyInstanceMinorVersions	array	La collection des versions mineures vers lesquelles l'instance proxy peut être mise à niveau.	2.25.9
	string	Les versions du proxy pouvant être mises à niveau.	2.25.9_20251028
DBProxyConnectStringItems	object
DBProxyConnectStringItems	array<object>	Un tableau contenant les informations sur le point de terminaison du proxy de base de données créé pour l'instance.
	object	Le point de terminaison du proxy créé pour l'instance.
DBProxyConnectString	string	Le point de terminaison du proxy de base de données.	gos787jog2wk0ye1****-rw4rm.rwlb.rds.aliyuncs.com
DBProxyConnectStringNetType	string	Le type de réseau du point de terminaison du proxy de base de données. Un point de terminaison de proxy de base de données était auparavant appelé terminal de proxy. Valeurs valides : OuterString : Internet InnerString : réseau interne	InnerString
DBProxyConnectStringNetWorkType	string	Le type de réseau du proxy de base de données. Valeurs valides : 0 : Internet 1 : réseau classique 2 : cloud privé virtuel (VPC)	2
DBProxyConnectStringPort	string	Le port associé au point de terminaison du proxy de base de données.	3306
DBProxyEndpointId	string	L'identifiant du point de terminaison backend du proxy de base de données.	20****
DBProxyEndpointName	string	Le nom du point de terminaison du proxy de base de données. Le nom peut être remplacé par l'identifiant du point de terminaison du proxy de base de données.	gos787jog2wk0ye1****
DBProxyVpcId	string	Le VPC du proxy de base de données.	vpc-uf6oobt****
DBProxyVpcInstanceId	string	L'identifiant de l'instance du proxy de base de données.	rm-bp145737x5**131161274792**
DBProxyVswitchId	string	Le vSwitch du proxy de base de données.	vsw-uf6l0pic17****
DBProxyEngineType	string	Un paramètre interne. Vous pouvez ignorer ce paramètre.	normal
DBProxyInstanceCurrentMinorVersion	string	La version de l'instance proxy.	1.13.11
DBProxyInstanceLatestMinorVersion	string	La dernière version disponible pour l'instance proxy.	1.13.12
DBProxyInstanceName	string	Le nom de l'instance proxy.	gos787jog2wk0ye1****
DBProxyInstanceNum	integer	Le nombre de proxys activés sur l'instance.	1
DBProxyInstanceSize	string	Ce paramètre est disponible uniquement pour les instances ApsaraDB RDS for PostgreSQL. Les spécifications de l'instance proxy activée. Format : `Nombre de cœurs/Capacité de mémoire`. Par exemple, une valeur de 4/8 indique que l'instance proxy dispose de 4 cœurs et de 8 Go de mémoire.	4/8
DBProxyInstanceStatus	string	L'état de l'instance de proxy. DBInstanceClassChanging : Les spécifications de l'instance de proxy sont en cours de modification. Creating : L'instance de proxy est en cours de création. Running : L'instance de proxy est en cours d'exécution. Deleting : L'instance de proxy est en cours de suppression.	Running
DBProxyInstanceType	string	Le type de proxy de base de données activé sur l'instance. Valeurs valides : 1 : proxy de base de données partagé 2 : proxy de base de données dédié 3 : proxy de base de données à usage général Remarque ApsaraDB RDS for PostgreSQL ne prend pas en charge les proxys de base de données partagés.	2
DBProxyKindCode	string	Un paramètre interne. Vous n'avez pas besoin de spécifier ce paramètre.	18
DBProxyNodes	object
DBProxyNodes	array<object>	Les nœuds proxy.
	object	Les détails de la liste des nœuds.
cpuCores	string	Le nombre de cœurs de processeur du nœud.	2
nodeId	string	L'identifiant du nœud proxy.	pn-xxxxxxx01
zoneId	string	L'identifiant de la zone dans laquelle le nœud est déployé.	cn-hangzhou-c
DBProxyPersistentConnectionStatus	string	L'état des connexions persistantes. Valeurs valides : Enabled Disabled Unsupported	Disabled
DBProxyServiceStatus	string	L'état du proxy de base de données.	Startup
DbProxyEndpointItems	object
DbProxyEndpointItems	array<object>	Les points de terminaison du proxy de l'instance.
	object	Les informations sur le point de terminaison du proxy.
DbProxyEndpointAliases	string	La description du point de terminaison du proxy de base de données.	proxy-test
DbProxyEndpointName	string	L'identifiant du point de terminaison du proxy de base de données.	gos787jog2wk0ye1****
DbProxyEndpointType	string	Le type du point de terminaison du proxy de base de données. Valeurs valides : Custom : point de terminaison du proxy de base de données personnalisé RWSplit : point de terminaison du proxy de base de données par défaut	RWSplit
DbProxyReadWriteMode	string	Les attributs de lecture et d'écriture du point de terminaison du proxy de base de données. ReadOnly ReadWrite	ReadWrite
RequestId	string	L'identifiant de la requête.	909A69EE-71C8-4417-A0B9-FF085407E1E3
ResourceGroupId	string	L'identifiant du groupe de ressources.	rg-acfmy****
DBProxyAVZones	object
DBProxyAVZones	array	La liste des zones disponibles pour le proxy de base de données.
	string	La zone disponible pour le proxy de base de données.	cn-shanghai-e

Exemples

JSON format

{
  "DBProxyInstanceMinorVersions": {
    "DBProxyInstanceMinorVersions": [
      "2.25.9_20251028"
    ]
  },
  "DBProxyConnectStringItems": {
    "DBProxyConnectStringItems": [
      {
        "DBProxyConnectString": "gos787jog2wk0ye1****-rw4rm.rwlb.rds.aliyuncs.com",
        "DBProxyConnectStringNetType": "InnerString",
        "DBProxyConnectStringNetWorkType": "2",
        "DBProxyConnectStringPort": "3306",
        "DBProxyEndpointId": "20****",
        "DBProxyEndpointName": "gos787jog2wk0ye1****",
        "DBProxyVpcId": "vpc-uf6oobt****",
        "DBProxyVpcInstanceId": "rm-bp145737x5****131161274792****",
        "DBProxyVswitchId": "vsw-uf6l0pic17****"
      }
    ]
  },
  "DBProxyEngineType": "normal",
  "DBProxyInstanceCurrentMinorVersion": "1.13.11",
  "DBProxyInstanceLatestMinorVersion": "1.13.12",
  "DBProxyInstanceName": "gos787jog2wk0ye1****",
  "DBProxyInstanceNum": 1,
  "DBProxyInstanceSize": "4/8",
  "DBProxyInstanceStatus": "Running",
  "DBProxyInstanceType": "2",
  "DBProxyKindCode": "18",
  "DBProxyNodes": {
    "DBProxyNodes": [
      {
        "cpuCores": "2",
        "nodeId": "pn-xxxxxxx01",
        "zoneId": "cn-hangzhou-c"
      }
    ]
  },
  "DBProxyPersistentConnectionStatus": "Disabled",
  "DBProxyServiceStatus": "Startup",
  "DbProxyEndpointItems": {
    "DbProxyEndpointItems": [
      {
        "DbProxyEndpointAliases": "proxy-test",
        "DbProxyEndpointName": "gos787jog2wk0ye1****",
        "DbProxyEndpointType": "RWSplit",
        "DbProxyReadWriteMode": "ReadWrite"
      }
    ]
  },
  "RequestId": "909A69EE-71C8-4417-A0B9-FF085407E1E3",
  "ResourceGroupId": "rg-acfmy****",
  "DBProxyAVZones": {
    "DBProxyAVZones": [
      "cn-shanghai-e"
    ]
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	RWSplitNetTypeNotExists	Specified rw split net type is not eixsts.
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	InvalidInstanceLevelExtraInfo	Specified class code has error extra info.	Le code de classe spécifié contient des informations supplémentaires non valides.
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	Current custins kindCode does not support this 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 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.
404	InvalidDBInstanceName.NotFound	The database instance does not exist.	L'instance spécifiée n'existe pas ou n'est pas prise en charge.
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.