ListGateway - - Centre de documentation Alibaba Cloud

Répertorie les passerelles privées.

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:ListGateway

list

*All Resource

*

Aucune

Syntaxe de la requête

GET /api/v2/gateways HTTP/1.1

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
GatewayId	string	Non	L'identifiant de la passerelle privée. Vous pouvez obtenir cet identifiant à partir du champ private_gateway_id dans la réponse de l'opération ListResources.	gw-1uhcqmsc7x22******
PageNumber	integer	Non	Le numéro de page de la liste des passerelles à renvoyer. La valeur par défaut est 1.	1
PageSize	integer	Non	Le nombre de passerelles à renvoyer sur chaque page. La valeur par défaut est 100.	100
GatewayName	string	Non	L'alias de la passerelle privée.	mygateway1
ResourceName	string	Non	L'identifiant du groupe de ressources. Vous pouvez obtenir cet identifiant à partir du champ ResourceId dans la réponse de l'opération ListResources.	eas-r-4gt8twzwllfo******
InternetEnabled	boolean	Non	Indique si l'accès via le réseau public doit être activé.	true
Status	string	Non	L'état de la passerelle.	Running
ChargeType	string	Non	La méthode de facturation. Valeurs valides : PostPaid : Paiement à l'usage. PrePaid : Abonnement.	PrePaid
Sort	string	Non	Le champ selon lequel trier. Valeurs valides : Status : État. ChargeType : Méthode de facturation. CreateTime : Heure de création. UpdateTime : Heure de mise à jour. InternetEnabled : Accès au réseau public. GatewayType : Type de passerelle. GatewayName : Nom de la passerelle.	CreateTime
Order	string	Non	L'ordre de tri. Valeurs valides : asc : Croissant. desc : Décroissant.	asc
GatewayType	string	Non	Le type de la passerelle. Valeurs valides : FullyManaged : Passerelle dédiée entièrement gérée. Application : Passerelle dédiée aux applications.	Application
Label	object	Non	Filtrer par balise.
	string	Non	La balise par laquelle filtrer, au format {"key":"value"}. Vous pouvez définir la valeur sur null ou une chaîne vide pour filtrer uniquement par clé.	{"key1":"value1","key2":null}

Éléments de réponse

Élément	Type	Description	Exemple
	object	Le résultat renvoyé.
RequestId	string	L'identifiant de la requête.	40325405-579C-4D82****
Gateways	array<object>	La liste des passerelles privées.
	array<object>	Les détails de la passerelle privée.
GatewayId	string	L'identifiant de la passerelle privée.	gw-1uhcqmsc7x22******
GatewayName	string	L'alias de la passerelle privée.	mygateway1
InstanceType	string	Le type d'instance utilisé par la passerelle privée.	2c4g
IntranetDomain	string	Le point de terminaison du réseau 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 point de terminaison du réseau public.	gw-1uhcqmsc7x22****-1801786532****.cn-wulanchabu.pai-eas.aliyuncs.com
CreateTime	string	L'heure de création de la passerelle privée. L'heure est au format UTC.	2020-05-19T14:19:42Z
UpdateTime	string	L'heure de la dernière mise à jour de la passerelle privée. L'heure est au format UTC.	2021-02-24T11:52:17Z
Status	string	L'état de la passerelle privée. Valeurs valides : Creating : La passerelle est en cours de création. Stopped : La passerelle est arrêtée. Failed : La passerelle est en échec. Running : La passerelle est en cours d'exécution. Deleted : La passerelle est supprimée. Deleting : La passerelle est en cours de suppression. Waiting : La passerelle est en attente.	Running
Replicas	integer	Le nombre de nœuds pour la passerelle privée.	2
IsDefault	boolean	Indique s'il s'agit de la passerelle privée par défaut.	true
ChargeType	string	La méthode de facturation. Valeurs valides :	PostPaid
SSLRedirectionEnabled	boolean	Indique si la redirection de HTTP vers HTTPS est activée.	true
IntranetEnabled	boolean	Indique si l'accès au réseau interne est activé.
Labels	array<object>	La liste des balises de la passerelle.
	object	L'objet balise de la passerelle.
LabelKey	string	The key of the gateway tag.	key1
LabelValue	string	The value of the gateway tag.	value1
PageNumber	integer	Le numéro de la page renvoyée.	1
PageSize	integer	Le nombre d'entrées renvoyées par page.	100
TotalCount	integer	Le nombre total de passerelles.	5

Exemples

JSON format

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

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.