DescribeSslVpnServers - VPN Gateway - Centro de documentación de Alibaba Cloud

Consulta los servidores SSL que se han creado.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

vpc:DescribeSslVpnServers

list

SslVpnServer

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

SslVpnServer

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

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
RegionId	string	Sí	El ID de la región del servidor SSL. Puede llamar a la operación DescribeRegions para consultar los ID de región.	cn-hangzhou
SslVpnServerId	string	No	El ID del servidor SSL.	vss-bp15j3du13gq1dgey****
VpnGatewayId	string	No	El ID de la puerta de enlace VPN.	vpn-bp1on0xae9d771ggi****
Name	string	No	El nombre del servidor SSL. El nombre debe tener entre 1 y 100 caracteres de longitud y no puede comenzar con `http://` o `https://`.	test
PageNumber	integer	No	El número de página. Valor predeterminado: 1.	1
PageSize	integer	No	El número de entradas por página para la consulta paginada. Valor máximo: 50. Valor predeterminado: 10.	10
ResourceGroupId	string	No	El ID del grupo de recursos al que pertenece el servidor SSL. El servidor SSL pertenece al mismo grupo de recursos que la instancia de puerta de enlace VPN asociada. Puede llamar a la operación DescribeVpnGateway para consultar el ID del grupo de recursos de la instancia de puerta de enlace VPN.	rg-acfmzs372yg****

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los parámetros de respuesta.
PageSize	integer	El número de entradas por página para la consulta paginada.	10
RequestId	string	El ID de la solicitud.	D350187B-EA41-4577-950B-95434C8302E1
PageNumber	integer	El número de página.	1
TotalCount	integer	El número total de entradas devueltas.	1
SslVpnServers	object
SslVpnServer	array<object>	Los detalles del servidor SSL.
	object
InternetIp	string	La dirección IP pública de la puerta de enlace VPN.	47.5.XX.XX
IDaaSInstanceId	string	El ID de la instancia de IDaaS EIAM.	idaas-cn-hangzhou-****
CreateTime	integer	La marca de tiempo en la que se creó el servidor SSL.	1613800884000
VpnGatewayId	string	El ID de la puerta de enlace VPN.	vpn-bp1on0xae9d771ggi****
IDaaSRegionId	string	El ID de la región de la instancia de IDaaS EIAM.	cn-hangzhou
Compress	boolean	Indica si la comunicación está comprimida. Valores válidos: true: Comprimida. false (predeterminado): No comprimida.	false
Port	integer	El puerto utilizado por el servidor SSL.	1194
LocalSubnet	string	El bloque CIDR local.	192.168.0.0/24
RegionId	string	El ID de la región del servidor SSL.	cn-hangzhou
Cipher	string	El algoritmo de cifrado utilizado.	AES-128-CBC
Connections	integer	El número actual de conexiones.	0
SslVpnServerId	string	El ID del servidor SSL.	vss-bp15j3du13gq1dgey****
MaxConnections	integer	El número máximo de conexiones.	5
Name	string	El nombre del servidor SSL.	test
EnableMultiFactorAuth	boolean	Indica si la autenticación de identidad de dos factores está habilitada. Valores válidos: true: Habilitada. false (predeterminado): Deshabilitada.	true
ClientIpPool	string	El bloque CIDR del cliente.	10.10.1.0/24
Proto	string	El protocolo utilizado por el servidor SSL.	UDP
ResourceGroupId	string	El ID del grupo de recursos al que pertenece el servidor SSL. Puede llamar a la operación ListResourceGroups para consultar la información del grupo de recursos.	rg-acfmzs372yg****
IDaaSApplicationId	string	El ID de la aplicación IDaaS.	app_my6g4qmvnwxzj2f****
IDaaSInstanceVersion	string	La versión de la instancia de IDaaS EIAM. Este parámetro se devuelve solo cuando el servidor SSL está asociado con una instancia de IDaaS EIAM 2.0. El valor es EIAM 2.0. Si el servidor SSL está asociado con una instancia de IDaaS EIAM 1.0, este parámetro no se devuelve.	EIAM 2.0
DnsServers	string

Ejemplos

Respuesta exitosa

JSON Formato

{
  "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": ""
      }
    ]
  }
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
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.	You do not have the permissions to manage the specified resource. Apply for the permissions and try again.
404	InvalidRegionId.NotFound	The specified region is not found during access authentication.	The specified area is not found during authentication.

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.