GetProxy - - Centre de documentation Alibaba Cloud

Consulte les détails d'un proxy d'accès sécurisé.

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.

dms:GetProxy

get

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
ProxyId	integer	Oui	L'identifiant du proxy d'accès sécurisé. Vous pouvez appeler l'opération ListProxies pour obtenir l'identifiant du proxy d'accès sécurisé.	4**
Tid	integer	Non	L'identifiant du locataire. Vous pouvez appeler l'opération GetUserActiveTenant pour obtenir l'identifiant du locataire.	3***

Éléments de réponse

Élément	Type	Description	Exemple
	object	Schéma de la réponse.
RequestId	string	L'identifiant de la requête.	F49D4598-2B3C-5723-865E-2CCB818E****
Success	boolean	Indique si la requête a réussi. Valeurs valides : true : la requête a réussi. false : la requête a échoué.	true
ErrorMessage	string	Le message d'erreur renvoyé si la requête a échoué.	La condition ne peut pas être vide !
ErrorCode	string	Le code d'erreur renvoyé si la requête a échoué.	UnknownError
ProxyId	integer	L'identifiant du proxy d'accès sécurisé.	4**
CreatorId	integer	L'identifiant de l'utilisateur qui a activé la fonctionnalité de proxy d'accès sécurisé.	12****
CreatorName	string	Le surnom de l'utilisateur qui a activé la fonctionnalité de proxy d'accès sécurisé.	test_name
InstanceId	integer	L'identifiant de l'instance.	183****
PrivateEnable	boolean	Indique si le point de terminaison interne a été activé. Valeur par défaut : true.	true
PrivateHost	string	Le point de terminaison interne.	dphzmy-5j8oimjsz6ze****.proxy.dms.aliyuncs.com
PublicEnable	boolean	Indique si le point de terminaison public a été activé. Valeurs valides : true : le point de terminaison public a été activé. false : le point de terminaison public a été désactivé.	true
PublicHost	string	Le point de terminaison public. Un point de terminaison public est renvoyé que le point de terminaison public soit activé ou désactivé. Remarque Si la valeur du paramètre PublicEnable est true, un point de terminaison public valide pouvant être résolu à l'aide d'Alibaba Cloud DNS est renvoyé. Si la valeur du paramètre PublicEnable est false, un point de terminaison public non valide qui ne peut pas être résolu à l'aide d'Alibaba Cloud DNS est renvoyé.	dphzmy-5j8oimjsz6zed7k****.proxy.dms.aliyuncs.com
HttpsPort	integer	Le numéro de port utilisé par le protocole HTTPS.	443
ProtocolType	string	Le type de protocole de la base de données. Exemple : MYSQL.	MYSQL
ProtocolPort	integer	Le numéro de port utilisé par le protocole.	3306
RegionId	string	L'identifiant de la région dans laquelle l'instance réside.	cn-hangzhou

Exemples

JSON format

{
  "RequestId": "F49D4598-2B3C-5723-865E-2CCB818E****",
  "Success": true,
  "ErrorMessage": "The condition cannot be empty!",
  "ErrorCode": "UnknownError",
  "ProxyId": 0,
  "CreatorId": 0,
  "CreatorName": "test_name",
  "InstanceId": 0,
  "PrivateEnable": true,
  "PrivateHost": "dphzmy-5j8oimjsz6ze****.proxy.dms.aliyuncs.com",
  "PublicEnable": true,
  "PublicHost": "dphzmy-5j8oimjsz6zed7k****.proxy.dms.aliyuncs.com",
  "HttpsPort": 443,
  "ProtocolType": "MYSQL",
  "ProtocolPort": 3306,
  "RegionId": "cn-hangzhou"
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.