DescribeGateway - - Centre de documentation Alibaba Cloud

Consulte les détails d'une passerelle dédiée.

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.

eas:DescribeGateway

get

*Passerelle.

acs:eas:{#regionId}:{#accountId}:gateway/{#GatewayId}

Aucune

Syntaxe de la requête

GET /api/v2/gateways/{ClusterId}/{GatewayId} HTTP/1.1

Paramètres de chemin

Paramètre	Type	Requis	Description	Exemple
ClusterId	string	Oui	La région où se trouve la passerelle dédiée.	cn-wulanchabu
GatewayId	string	Oui	L'identifiant de la passerelle dédiée. Pour obtenir l'identifiant de la passerelle dédiée, reportez-vous au champ private_gateway_id dans la réponse de l'opération ListResources.	gw-1uhcqmsc7x22******

Paramètres de requête

Paramètre

Type

Requis

Description

Exemple

Éléments de réponse

Élément	Type	Description	Exemple
	object	La réponse.
RequestId	string	L'identifiant de la requête.	40325405-579C-4D82****
GatewayId	string	L'identifiant de la passerelle dédiée.	gw-1uhcqmsc7x22******
GatewayName	string	L'alias de la passerelle dédiée.	mygateway1
CreateTime	string	L'heure de création de la passerelle dédiée. L'heure est exprimée en UTC.	2020-05-19T14:19:42Z
UpdateTime	string	L'heure de la dernière mise à jour de la passerelle dédiée. L'heure est exprimée en UTC.	2021-02-24T11:52:17Z
IntranetDomain	string	Le nom de domaine d'accès interne.	gw-1uhcqmsc7x22****-1801786532****-vpc.cn-wulanchabu.pai-eas.aliyuncs.com
InternetEnabled	boolean	Indique si l'accès au réseau public est activé.	true
InternetDomain	string	Le nom de domaine d'accès au réseau public.	gw-1uhcqmsc7x22****-1801786532****.cn-wulanchabu.pai-eas.aliyuncs.com
InstanceType	string	Le type d'instance utilisé par la passerelle dédiée. Valeurs valides : 8c16g : 8c16g 4c8g : 4c8g 2c4g : 2c4g 16c32g : 16c32g	2c4g
Status	string	L'état de la passerelle dédiée. Valeurs valides : Valeurs valides : Creating : En cours de création. Stopped : Arrêtée. Failed : Échec. Running : En cours d'exécution. Deleted : Supprimée. Deleting : En cours de suppression. Waiting : En attente.	Running
ExternalClusterId	string	L'identifiant du cluster auto-géré.	c935eadf284c14c2da57a2a13ad6******
Replicas	integer	Le nombre de nœuds dans la passerelle dédiée.	2
IsDefault	boolean	Indique si la passerelle dédiée est la passerelle par défaut.	true
InternetStatus	string	L'état de l'accès au réseau public. Valeurs valides : Valeurs valides : Creating : L'accès au réseau public est en cours d'activation. Failed : L'activation ou la suppression de l'accès au réseau public a échoué. Running : L'accès au réseau public est opérationnel. Deleted : L'accès au réseau public est supprimé. Deleting : L'accès au réseau public est en cours de suppression.	Running
SSLRedirectionEnabled	boolean	Indique si la redirection de HTTP vers HTTPS est activée.	true
ChargeType	string	La méthode de facturation. Valeurs valides : Valeurs valides : PrePaid（预付费） : PrePaid (abonnement) PostPaid（后付费） : PostPaid (postpayé)	PrePaid
IntranetEnabled	boolean	Indique si l'accès au réseau interne est activé. La valeur true indique que l'accès au réseau interne est activé. La valeur false indique que l'accès au réseau interne n'est pas activé.	true
Labels	array<object>	La liste des étiquettes de la passerelle.
	object	L'objet d'étiquette de la passerelle.
LabelKey	string	La clé d'étiquette de la passerelle.	key1
LabelValue	string	La valeur d'étiquette de la passerelle.	value1

Exemples

JSON format

{
  "RequestId": "40325405-579C-4D82****",
  "GatewayId": "gw-1uhcqmsc7x22******",
  "GatewayName": "mygateway1",
  "CreateTime": "2020-05-19T14:19:42Z",
  "UpdateTime": "2021-02-24T11:52:17Z",
  "IntranetDomain": "gw-1uhcqmsc7x22******-1801786532******-vpc.cn-wulanchabu.pai-eas.aliyuncs.com",
  "InternetEnabled": true,
  "InternetDomain": "gw-1uhcqmsc7x22******-1801786532******.cn-wulanchabu.pai-eas.aliyuncs.com",
  "InstanceType": "2c4g",
  "Status": "Running",
  "ExternalClusterId": "c935eadf284c14c2da57a2a13ad6******",
  "Replicas": 2,
  "IsDefault": true,
  "InternetStatus": "Running",
  "SSLRedirectionEnabled": true,
  "ChargeType": "PrePaid",
  "IntranetEnabled": true,
  "Labels": [
    {
      "LabelKey": "key1",
      "LabelValue": "value1"
    }
  ]
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.