ListIpsecServers - VPN Gateway - Centre de documentation Alibaba Cloud

Consulte les serveurs IPsec créés.

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.

vpc:ListIpsecServers

list

*All Resource.

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RegionId	string	Oui	L'identifiant de la région du serveur IPsec. Vous pouvez appeler l'opération DescribeRegions pour obtenir l'identifiant de la région.	cn-hangzhou
IpsecServerName	string	Non	Le nom du serveur IPsec. Le nom doit comporter de 1 à 100 caractères.	test
VpnGatewayId	string	Non	L'identifiant de la passerelle VPN.	vpn-bp1q8bgx4xnkm2ogj****
NextToken	string	Non	Le jeton de pagination. Valeurs valides : Vous n'avez pas besoin de spécifier ce paramètre pour la première requête ou s'il n'existe aucune requête ultérieure. S'il existe une requête ultérieure, définissez la valeur sur la valeur NextToken renvoyée par l'appel d'API précédent.	caeba0bbb2be03f84eb48b699f0a****
MaxResults	integer	Non	Le nombre d'entrées par page. Valeurs valides : 1 à 20. Valeur par défaut : 10.	10
IpsecServerId	array	Non	L'identifiant du serveur IPsec.	iss-bp1bo3xuvcxo7ixll****
	string	Non	L'identifiant du serveur IPsec. Valeurs valides de N : 1 à 20.	iss-bp1bo3xuvcxo7ixll****
ResourceGroupId	string	Non	L'identifiant du groupe de ressources auquel le serveur IPsec appartient. Le serveur IPsec appartient au même groupe de ressources que l'instance de passerelle VPN associée. Vous pouvez appeler l'opération DescribeVpnGateway pour obtenir l'identifiant du groupe de ressources de l'instance de passerelle VPN.	rg-acfmzs372yg****

Éléments de réponse

Élément	Type	Description	Exemple
	object
NextToken	string	Le jeton de pagination. Valeurs valides : Si NextToken est vide, il n'existe aucune requête ultérieure. Si NextToken est renvoyé, la valeur indique le jeton pour la requête suivante.	caeba0bbb2be03f84eb48b699f0a****
RequestId	string	L'identifiant de la requête.	54B48E3D-DF70-471B-AA93-08E683A1B457
TotalCount	integer	Le nombre total d'entrées renvoyées.	10
MaxResults	integer	Le nombre d'entrées par page.	1
IpsecServers	array<object>	La liste des serveurs IPsec.
	array<object>
CreationTime	string	L'heure à laquelle le serveur IPsec a été créé. T est le délimiteur. Z indique l'heure UTC.	2018-12-03T10:11:55Z
OnlineClientCount	integer	Le nombre de clients connectés au serveur IPsec.	1
InternetIp	string	L'adresse IP publique de la passerelle VPN.	47.22.XX.XX
IpsecServerName	string	Le nom du serveur IPsec.	test
IDaaSInstanceId	string	L'identifiant de l'instance IDaaS.	idaas-cn-hangzhou-****
EffectImmediately	boolean	Indique si le tunnel IPsec actuel est supprimé et si les négociations sont relancées. true : les négociations sont relancées une fois la configuration terminée. false : les négociations sont relancées lorsqu'un trafic est détecté.	false
VpnGatewayId	string	L'identifiant de la passerelle VPN.	vpn-bp1q8bgx4xnkm2ogj****
LocalSubnet	string	Le bloc CIDR local, qui est le bloc CIDR côté VPC qui doit communiquer avec le bloc CIDR client.	192.168.0.0/16,172.17.0.0/16
Psk	string	La clé prépartagée.	pgw6dy7d****
RegionId	string	L'identifiant de la région du serveur IPsec.	cn-hangzhou
PskEnabled	boolean	Indique si l'authentification par clé prépartagée est activée. La valeur est true, ce qui indique que l'authentification par clé prépartagée est activée.	true
IpsecServerId	string	L'identifiant du serveur IPsec.	iss-bp1bo3xuvcxo7ixll****
MultiFactorAuthEnabled	boolean	Indique si l'authentification à deux facteurs est activée. true : l'authentification à deux facteurs est activée. false : l'authentification à deux facteurs est désactivée.	true
MaxConnections	integer	Le nombre maximal de connexions SSL-VPN prises en charge par la passerelle VPN. Remarque SSL-VPN et le serveur IPsec partagent les connexions SSL-VPN. Par exemple, si le nombre maximal de connexions SSL-VPN est de 5 et que trois clients SSL sont connectés à SSL-VPN, seuls deux clients supplémentaires peuvent se connecter au serveur IPsec.	5
ClientIpPool	string	Le bloc CIDR client, qui est le bloc CIDR à partir duquel les adresses IP sont attribuées aux contrôleurs d'interface réseau virtuels des clients.	10.0.0.0/24
IkeConfig	object	Les configurations des négociations de phase 1.
RemoteId	string	L'identifiant du pair. Les formats FQDN et adresse IP sont pris en charge. La valeur par défaut est vide.	139.67.XX.XX
IkeLifetime	integer	La durée de vie IKE. Unité : secondes.	86400
IkeEncAlg	string	L'algorithme de chiffrement IKE.	aes
LocalId	string	L'identifiant du serveur IPsec. Les formats FQDN et adresse IP sont pris en charge. La valeur par défaut est l'adresse IP publique de la passerelle VPN sélectionnée.	116.64.XX.XX
IkeMode	string	Le mode de négociation IKE. Valeurs valides : main : mode principal. Les négociations sont hautement sécurisées.	main
IkeVersion	string	La version IKE.	ikev2
IkePfs	string	L'algorithme d'échange de clés Diffie-Hellman.	group2
IkeAuthAlg	string	L'algorithme d'authentification IKE.	sha1
IpsecConfig	object	Les configurations des négociations de phase 2.
IpsecAuthAlg	string	L'algorithme d'authentification IPsec.	sha1
IpsecLifetime	integer	La durée de vie IPsec. Unité : secondes.	86400
IpsecEncAlg	string	L'algorithme de chiffrement IPsec.	aes
IpsecPfs	string	L'algorithme d'échange de clés Diffie-Hellman.	group2
ResourceGroupId	string	L'identifiant du groupe de ressources auquel le serveur IPsec appartient. Vous pouvez appeler l'opération ListResourceGroups pour obtenir les informations sur le groupe de ressources.	rg-acfmzs372yg****

Exemples

JSON format

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B457",
  "TotalCount": 10,
  "MaxResults": 1,
  "IpsecServers": [
    {
      "CreationTime": "2018-12-03T10:11:55Z",
      "OnlineClientCount": 1,
      "InternetIp": "47.22.XX.XX",
      "IpsecServerName": "test",
      "IDaaSInstanceId": "idaas-cn-hangzhou-****",
      "EffectImmediately": false,
      "VpnGatewayId": "vpn-bp1q8bgx4xnkm2ogj****",
      "LocalSubnet": "192.168.0.0/16,172.17.0.0/16",
      "Psk": "pgw6dy7d****",
      "RegionId": "cn-hangzhou",
      "PskEnabled": true,
      "IpsecServerId": "iss-bp1bo3xuvcxo7ixll****",
      "MultiFactorAuthEnabled": true,
      "MaxConnections": 5,
      "ClientIpPool": "10.0.0.0/24",
      "IkeConfig": {
        "RemoteId": "139.67.XX.XX",
        "IkeLifetime": 86400,
        "IkeEncAlg": "aes",
        "LocalId": "116.64.XX.XX",
        "IkeMode": "main",
        "IkeVersion": "ikev2",
        "IkePfs": "group2",
        "IkeAuthAlg": "sha1"
      },
      "IpsecConfig": {
        "IpsecAuthAlg": "sha1",
        "IpsecLifetime": 86400,
        "IpsecEncAlg": "aes",
        "IpsecPfs": "group2"
      },
      "ResourceGroupId": "rg-acfmzs372yg****"
    }
  ]
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	IllegalParam.NextToken	The specified NextToken is invalid.	Le paramètre NextToken est invalide.
403	Forbidden	User not authorized to operate on the specified resource.	L'EIP n'appartient pas à l'appelant actuel. Vérifiez si vous disposez de l'autorisation d'utiliser cette EIP.

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

Notes de version

Consultez Notes de version pour la liste complète.