DescribeSslVpnServers - VPN Gateway - Centre de documentation Alibaba Cloud

Consulte les serveurs SSL 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:DescribeSslVpnServers

list

Serveur VPN SSL.

acs:vpc:{#regionId}:{#accountId}:sslvpnserver/*

Serveur VPN SSL.

acs:vpc:{#regionId}:{#accountId}:sslvpnserver/{#SslVpnServerId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RegionId	string	Oui	L'identifiant de la région du serveur SSL. Vous pouvez appeler l'opération DescribeRegions pour obtenir les identifiants de région.	cn-hangzhou
SslVpnServerId	string	Non	L'identifiant du serveur SSL.	vss-bp15j3du13gq1dgey****
VpnGatewayId	string	Non	L'identifiant de la passerelle VPN.	vpn-bp1on0xae9d771ggi****
Name	string	Non	Le nom du serveur SSL. Le nom doit comporter de 1 à 100 caractères et ne peut pas commencer par `http://` ou `https://`.	test
PageNumber	integer	Non	Le numéro de page. Valeur par défaut : 1.	1
PageSize	integer	Non	Le nombre d'entrées par page pour la requête paginée. Valeur maximale : 50. Valeur par défaut : 10.	10
ResourceGroupId	string	Non	L'identifiant du groupe de ressources auquel le serveur SSL appartient. Le serveur SSL 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	Les paramètres de réponse.
PageSize	integer	Le nombre d'entrées par page pour la requête paginée.	10
RequestId	string	L'identifiant de la requête.	D350187B-EA41-4577-950B-95434C8302E1
PageNumber	integer	Le numéro de page.	1
TotalCount	integer	Le nombre total d'entrées retournées.	1
SslVpnServers	object
SslVpnServer	array<object>	Les détails du serveur SSL.
	object
InternetIp	string	L'adresse IP publique de la passerelle VPN.	47.5.XX.XX
IDaaSInstanceId	string	L'identifiant de l'instance IDaaS EIAM.	idaas-cn-hangzhou-****
CreateTime	integer	L'horodatage de création du serveur SSL.	1613800884000
VpnGatewayId	string	L'identifiant de la passerelle VPN.	vpn-bp1on0xae9d771ggi****
IDaaSRegionId	string	L'identifiant de la région de l'instance IDaaS EIAM.	cn-hangzhou
Compress	boolean	Indique si la communication est compressée. Valeurs valides : true false (par défaut)	false
Port	integer	Le port utilisé par le serveur SSL.	1194
LocalSubnet	string	Le bloc CIDR local.	192.168.0.0/24
RegionId	string	L'identifiant de la région du serveur SSL.	cn-hangzhou
Cipher	string	L'algorithme de chiffrement utilisé.	AES-128-CBC
Connections	integer	Le nombre actuel de connexions.	0
SslVpnServerId	string	L'identifiant du serveur SSL.	vss-bp15j3du13gq1dgey****
MaxConnections	integer	Le nombre maximal de connexions.	5
Name	string	Le nom du serveur SSL.	test
EnableMultiFactorAuth	boolean	Indique si l'authentification d'identité à deux facteurs est activée. Valeurs valides : true false (par défaut)	true
ClientIpPool	string	Le bloc CIDR client.	10.10.1.0/24
Proto	string	Le protocole utilisé par le serveur SSL.	UDP
ResourceGroupId	string	L'identifiant du groupe de ressources auquel le serveur SSL appartient. Vous pouvez appeler l'opération ListResourceGroups pour interroger les informations sur les groupes de ressources.	rg-acfmzs372yg****
IDaaSApplicationId	string	L'identifiant de l'application IDaaS.	app_my6g4qmvnwxzj2f****
IDaaSInstanceVersion	string	La version de l'instance IDaaS EIAM. Ce paramètre n'est retourné que lorsque le serveur SSL est associé à une instance IDaaS EIAM 2.0. La valeur est EIAM 2.0. Si le serveur SSL est associé à une instance IDaaS EIAM 1.0, ce paramètre n'est pas retourné.	EIAM 2.0
DnsServers	string

Exemples

JSON format

{
  "PageSize": 10,
  "RequestId": "D350187B-EA41-4577-950B-95434C8302E1",
  "PageNumber": 1,
  "TotalCount": 1,
  "SslVpnServers": {
    "SslVpnServer": [
      {
        "InternetIp": "47.5.XX.XX",
        "IDaaSInstanceId": "idaas-cn-hangzhou-****",
        "CreateTime": 1613800884000,
        "VpnGatewayId": "vpn-bp1on0xae9d771ggi****",
        "IDaaSRegionId": "cn-hangzhou",
        "Compress": false,
        "Port": 1194,
        "LocalSubnet": "192.168.0.0/24",
        "RegionId": "cn-hangzhou",
        "Cipher": "AES-128-CBC",
        "Connections": 0,
        "SslVpnServerId": "vss-bp15j3du13gq1dgey****",
        "MaxConnections": 5,
        "Name": "test",
        "EnableMultiFactorAuth": true,
        "ClientIpPool": "10.10.1.0/24",
        "Proto": "UDP",
        "ResourceGroupId": "rg-acfmzs372yg****",
        "IDaaSApplicationId": "app_my6g4qmvnwxzj2f****",
        "IDaaSInstanceVersion": "EIAM 2.0",
        "DnsServers": ""
      }
    ]
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
403	Forbbiden.SubUser	User not authorized to operate on the specified resource as your account is created by another user.
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.
404	InvalidRegionId.NotFound	The specified region is not found during access authentication.	Le paramètre n'est pas valide.

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

Notes de version

Consultez Notes de version pour la liste complète.