GetProxy - - Centre de documentation Alibaba Cloud

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour plus de commodité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. 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	GetProxy	Opération à effectuer. Définissez la valeur sur GetProxy.
InstanceId	Long	Non	183****	ID de l'instance de base de données. Appelez l'opération ListInstances ou GetInstance pour obtenir l'ID de l'instance.
ProxyId	Long	Non	4**	ID du proxy d'accès sécurisé. Appelez l'opération ListProxies pour obtenir l'ID du proxy.
Tid	Long	Non	3***	ID du locataire. Appelez l'opération GetUserActiveTenant pour obtenir l'ID du locataire.
RegionId	String	Non	cn-hangzhou	Région où DMS est activé. Pour plus d'informations, consultez la rubrique Paramètre RegionID .

Paramètres de réponse

Paramètre	Type	Exemple	Description
RequestId	String	F49D4598-2B3C-5723-865E-2CCB818E****	ID de la requête.
Success	Boolean	true	Indique si la requête a abouti. Valeurs possibles : true : La requête a abouti. false : La requête a échoué.
ErrorMessage	String	The condition cannot be empty!	Message d'erreur renvoyé.
ErrorCode	String	UnknownError	Code d'erreur renvoyé.
ProxyId	Long	4**	ID du proxy d'accès sécurisé.
CreatorId	Long	12****	ID de l'utilisateur ayant activé le proxy d'accès sécurisé.
CreatorName	String	test_name	Pseudonyme de l'utilisateur ayant activé le proxy d'accès sécurisé.
InstanceId	Long	183****	ID de l'instance de base de données.
PrivateEnable	Boolean	true	Indique si le point de terminaison interne est activé. Valeur par défaut : true.
PrivateHost	String	dphzmy-5j8oimjsz6ze****.proxy.dms.aliyuncs.com	Point de terminaison interne.
PublicEnable	Boolean	true	Indique si le point de terminaison public est activé. Valeurs possibles : true : Le point de terminaison public est activé. false : Le point de terminaison public est désactivé.
PublicHost	String	dphzmy-5j8oimjsz6zed7k****.proxy.dms.aliyuncs.com	Point de terminaison public. Un point de terminaison public est renvoyé, qu'il soit activé ou non. Remarque Si la valeur du paramètre PublicEnable est true, un point de terminaison public valide, résolvable via Alibaba Cloud DNS (DNS), est renvoyé. Si la valeur du paramètre PublicEnable est false, un point de terminaison public invalide, non résolvable via DNS, est renvoyé.
MysqlPort	Integer	3306	Port utilisé par les clients MySQL pour se connecter à l'instance de base de données.
HttpsPort	Integer	443	Port utilisé par les clients HTTPS pour se connecter à l'instance de base de données.

Exemples

Exemples de requêtes

http(s)://dms-enterprise.aliyuncs.com/?Action=GetProxy
&InstanceId=183****
&ProxyId=4**
&Tid=3***
&Common request parameter

Exemples de réponses réussies

Format XML

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

<GetProxyResponse>
    <PublicHost>dphzmy-5j8oimjsz6zed7k****.proxy.dms.aliyuncs.com</PublicHost>
    <PrivateHost>dphzmy-5j8oimjsz6ze****.proxy.dms.aliyuncs.com</PrivateHost>
    <RequestId>F49D4598-2B3C-5723-865E-2CCB818E****</RequestId>
    <InstanceId>183****</InstanceId>
    <ProxyId>4**</ProxyId>
    <CreatorId>12****</CreatorId>
    <Success>true</Success>
    <MysqlPort>3306</MysqlPort>
    <CreatorName>test_name</CreatorName>
    <HttpsPort>443</HttpsPort>
</GetProxyResponse>

Format JSON

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

{
  "PublicHost" : "dphzmy-5j8oimjsz6zed7k****.proxy.dms.aliyuncs.com",
  "PrivateHost" : "dphzmy-5j8oimjsz6ze****.proxy.dms.aliyuncs.com",
  "RequestId" : "F49D4598-2B3C-5723-865E-2CCB818E****",
  "InstanceId" : "183****",
  "ProxyId" : "4**",
  "CreatorId" : "12****",
  "Success" : true,
  "MysqlPort" : 3306,
  "CreatorName" : "test_name",
  "HttpsPort" : 443
}

Codes d'erreur

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