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

Llama a la API DescribeVpnGateway para consultar los detalles de una puerta de enlace VPN especificada.

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

get

*VpnGateway

acs:vpc:{#regionId}:{#accountId}:vpngateway/{#VpnGatewayId}

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
RegionId	string	Sí	El ID de región de la puerta de enlace VPN. Puede llamar a la API DescribeRegions para obtener el ID de región.	cn-hangzhou
VpnGatewayId	string	Sí	El ID de la instancia de la puerta de enlace VPN.	vpn-bp1r3v1xqkl0w519g****
IncludeReservationData	boolean	No	Especifica si se deben incluir los datos de pedidos pendientes. Valores válidos: false (predeterminado): No incluye los datos de pedidos pendientes. true: Incluye los datos de pedidos pendientes.	true

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los parámetros de respuesta.
VpnType	string	El tipo de la puerta de enlace VPN. Valor: Normal, que indica un tipo estándar.	Normal
Status	string	El estado de la puerta de enlace VPN. Valores válidos: init: Inicializando. provisioning: Preparando. active: Normal. updating: Actualizando. deleting: Eliminando.	init
VpcId	string	El ID de la VPC a la que pertenece la puerta de enlace VPN.	vpc-bp19m2yx1m5q0avyq****
SslMaxConnections	integer	El número máximo de conexiones SSL-VPN simultáneas.	5
Spec	string	La especificación de ancho de banda de la puerta de enlace VPN. Unidad: Mbps.	5
InternetIp	string	En escenarios donde la instancia de la puerta de enlace VPN admite la creación de conexiones IPsec-VPN en modo de túnel único, esta dirección es la dirección IP de la instancia de la puerta de enlace VPN y se puede utilizar para crear conexiones IPsec-VPN o conexiones SSL-VPN. En escenarios donde la instancia de la puerta de enlace VPN admite la creación de conexiones IPsec-VPN en modo de túnel dual, esta dirección es la primera dirección IP utilizada para crear conexiones IPsec-VPN y no se puede utilizar para crear conexiones SSL-VPN. En escenarios donde la instancia de la puerta de enlace VPN admite la creación de conexiones IPsec-VPN en modo de túnel dual, el sistema asigna dos direcciones IPsec a la instancia de la puerta de enlace VPN para crear conexiones IPsec-VPN en modo de túnel dual.	47.22.XX.XX
CreateTime	integer	La marca de tiempo cuando se creó la puerta de enlace VPN. Unidad: milisegundos. La marca de tiempo está en formato Unix y representa el número total de milisegundos transcurridos desde el 1 de enero de 1970, 00:00:00 UTC hasta la hora de creación de la puerta de enlace VPN.	1495382400000
AutoPropagate	boolean	Indica si la función de propagación automática de rutas está habilitada para la puerta de enlace VPN. Valores válidos: true: Habilitado. false: Deshabilitado.	true
ChargeType	string	El método de facturación. Valores válidos: POSTPAY: Pago por uso.	Valor de ejemplo del sitio de China: Prepay, valor de ejemplo del sitio internacional: POSTPAY
VpnGatewayId	string	El ID de la instancia de la puerta de enlace VPN.	vpn-bp1r3v1xqkl0w519g****
Tag	string	Las etiquetas generadas por el sistema de la puerta de enlace VPN. VpnEnableBgp: Indica si la puerta de enlace VPN admite la función BGP. true: Admitido. false: No admitido. VisuallySsl: Indica si la puerta de enlace VPN admite la visualización de información de conexión de clientes SSL. true: Admitido. false: No admitido. PbrPriority: Indica si la puerta de enlace VPN admite la configuración de prioridades de política para rutas basadas en políticas. true: Admitido. false: No admitido. VpnNewImage: Indica si la puerta de enlace VPN es una puerta de enlace VPN de nueva generación. true: Sí. false: No. description: La descripción de la puerta de enlace VPN, utilizada únicamente para fines internos del sistema. VpnVersion: El número de versión de la puerta de enlace VPN. IDaaSNewVersion: Indica si la puerta de enlace VPN admite la vinculación con instancias de EIAM 2.0. true: Admitido. false: No admitido.	{\"VpnEnableBgp\":\"true\",\"VisuallySsl\":\"true\",\"PbrPriority\":\"true\",\"VpnNewImage\":\"true\",\"description\":\"转发1.3.24\",\"VpnVersion\":\"v1.2.4\",\"IDaaSNewVersion\":\"true\"}
IpsecVpn	string	Indica si la función IPsec-VPN está habilitada. Valores válidos: enable: Habilitado. disable: Deshabilitado.	enable
EndTime	integer	La marca de tiempo de vencimiento de la puerta de enlace VPN. Unidad: milisegundos. La marca de tiempo está en formato Unix y representa el número total de milisegundos transcurridos desde el 1 de enero de 1970, 00:00:00 UTC hasta la hora de vencimiento de la puerta de enlace VPN.	1544666102000
VSwitchId	string	El ID del vSwitch al que pertenece la puerta de enlace VPN.	vsw-bp1dmzugdikc6hdgx****
RequestId	string	El ID de la solicitud.	27E4E088-8DE0-4672-BF5C-0A412389DB9E
Description	string	La descripción de la puerta de enlace VPN.	vpngatewaydescription
EnableBgp	boolean	El estado de la función BGP de la puerta de enlace VPN. Valores válidos: true: Habilitado. false: Deshabilitado.	true
BusinessStatus	string	El estado de facturación de la puerta de enlace VPN. Valores válidos: Normal: Normal. FinancialLocked: Bloqueado por pago pendiente.	Normal
SslVpn	string	El estado de la función SSL-VPN. Valores válidos: enable: Habilitado. disable: Deshabilitado.	enable
Name	string	El nombre de la puerta de enlace VPN.	vpngatewayname
ReservationData	object	Los datos del pedido pendiente. Nota Este parámetro se devuelve solo cuando IncludeReservationData se establece en true.
Status	string	El estado del pedido pendiente. Valores válidos: 1: Indica que la orden de renovación o renovación con cambio de especificación no ha entrado en vigor. 2: Indica que la orden de actualización temporal ha entrado en vigor. Una vez alcanzada la hora de restauración, el sistema restaurará la especificación de la puerta de enlace VPN a la especificación anterior a la actualización temporal. En este caso, ReservationIpsec, ReservationMaxConnections, ReservationSpec y ReservationSsl representan las especificaciones anteriores a la actualización temporal de la puerta de enlace VPN.	1
ReservationOrderType	string	El tipo del pedido pendiente. Valores válidos: RENEWCHANGE: Renovación con cambio de especificación. TEMP_UPGRADE: Actualización temporal. RENEW: Renovación.	TEMP_UPGRADE
ReservationIpsec	string	El estado de la función IPsec-VPN del pedido pendiente. Valores válidos: enable: Habilitado. disable: Deshabilitado.	enable
ReservationSpec	string	La especificación de ancho de banda del pedido pendiente. Unidad: Mbps.	5
ReservationSsl	string	El estado de la función SSL-VPN del pedido pendiente. Valores válidos: enable: Habilitado. disable: Deshabilitado.	enable
ReservationMaxConnections	integer	El número máximo de conexiones SSL-VPN simultáneas para el pedido pendiente.	5
ReservationEndTime	string	Si el tipo de pedido pendiente es TEMP_UPGRADE (actualización temporal), este parámetro indica la hora de restauración de la actualización temporal. Si el tipo de pedido pendiente es RENEWCHANGE (renovación con cambio de especificación) o RENEW (renovación), este parámetro indica la hora en que entra en vigor la renovación o la renovación con cambio de especificación.	2020-07-20T16:00:00Z
Tags	object
Tag	array<object>	La lista de etiquetas vinculadas a la instancia de la puerta de enlace VPN.
	object	La lista de etiquetas vinculadas a la instancia de la puerta de enlace VPN.
Key	string	La clave de la etiqueta.	aaa
Value	string	El valor de la etiqueta.	bbb
NetworkType	string	El tipo de red de la puerta de enlace VPN. public: Puerta de enlace VPN pública. private: Puerta de enlace VPN privada.	public
DisasterRecoveryInternetIp	string	La segunda dirección IP asignada por el sistema a la instancia de la puerta de enlace VPN para crear conexiones IPsec-VPN. Este parámetro se devuelve solo para instancias de puertas de enlace VPN que admiten la creación de conexiones IPsec-VPN en modo de túnel dual.	47.91.XX.XX
DisasterRecoveryVSwitchId	string	El ID del segundo vSwitch asociado con la instancia de la puerta de enlace VPN. Este parámetro se devuelve solo para instancias de puertas de enlace VPN que admiten la creación de conexiones IPsec-VPN en modo de túnel dual.	vsw-p0w95ql6tmr2ludkt****
SslVpnInternetIp	string	La dirección IP para conexiones SSL-VPN. Este parámetro se devuelve solo cuando SSL-VPN está habilitado en una instancia de puerta de enlace VPN de red pública que admite la creación de conexiones IPsec-VPN en modo de túnel dual.	47.74.XX.XX
ResourceGroupId	string	El ID del grupo de recursos al que pertenece la puerta de enlace VPN. Puede llamar a la API ListResourceGroups para consultar información sobre grupos de recursos.	rg-acfmzs372yg****
EniInstanceIds	object
EniInstanceId	array	La lista de interfaces de red elásticas (ENI) creadas por el sistema para la instancia de la puerta de enlace VPN.
	string	El ID de la ENI. Este parámetro se devuelve solo para instancias de puertas de enlace VPN que admiten la creación de conexiones IPsec-VPN en modo de túnel dual.	eni-7xvcxgmd4y2ypibn****
GatewayType	string	El tipo de puerta de enlace VPN. Valores válidos: Traditional: Puerta de enlace VPN tradicional, que abarca tanto funciones IPsec como SSL. Enhanced.SiteToSite: VPN mejorada de sitio a nube, que abarca solo funciones IPsec.	Enhanced.SiteToSite

Ejemplos

Respuesta exitosa

JSON Formato

{
  "VpnType": "Normal",
  "Status": "init",
  "VpcId": "vpc-bp19m2yx1m5q0avyq****",
  "SslMaxConnections": 5,
  "Spec": "5",
  "InternetIp": "47.22.XX.XX",
  "CreateTime": 1495382400000,
  "AutoPropagate": true,
  "ChargeType": "中国站示例值：Prepay，国际站示例值：POSTPAY",
  "VpnGatewayId": "vpn-bp1r3v1xqkl0w519g****",
  "Tag": "{\\\"VpnEnableBgp\\\":\\\"true\\\",\\\"VisuallySsl\\\":\\\"true\\\",\\\"PbrPriority\\\":\\\"true\\\",\\\"VpnNewImage\\\":\\\"true\\\",\\\"description\\\":\\\"转发1.3.24\\\",\\\"VpnVersion\\\":\\\"v1.2.4\\\",\\\"IDaaSNewVersion\\\":\\\"true\\\"}",
  "IpsecVpn": "enable",
  "EndTime": 1544666102000,
  "VSwitchId": "vsw-bp1dmzugdikc6hdgx****",
  "RequestId": "27E4E088-8DE0-4672-BF5C-0A412389DB9E",
  "Description": "vpngatewaydescription",
  "EnableBgp": true,
  "BusinessStatus": "Normal",
  "SslVpn": "enable",
  "Name": "vpngatewayname",
  "ReservationData": {
    "Status": "1",
    "ReservationOrderType": "TEMP_UPGRADE",
    "ReservationIpsec": "enable",
    "ReservationSpec": "5",
    "ReservationSsl": "enable",
    "ReservationMaxConnections": 5,
    "ReservationEndTime": "2020-07-20T16:00:00Z"
  },
  "Tags": {
    "Tag": [
      {
        "Key": "aaa",
        "Value": "bbb"
      }
    ]
  },
  "NetworkType": "public",
  "DisasterRecoveryInternetIp": "47.91.XX.XX",
  "DisasterRecoveryVSwitchId": "vsw-p0w95ql6tmr2ludkt****",
  "SslVpnInternetIp": "47.74.XX.XX",
  "ResourceGroupId": "rg-acfmzs372yg****",
  "EniInstanceIds": {
    "EniInstanceId": [
      "eni-7xvcxgmd4y2ypibn****"
    ]
  },
  "GatewayType": "Enhanced.SiteToSite"
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	InvalidVpnGatewayInstanceId.NotFound	The specified vpn gateway instance id does not exist.	El gateway VPN especificado no existe. Verifique si el gateway VPN es correcto.
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.	No tiene el permiso para operar sobre el recurso especificado. Solicite el permiso requerido e inténtelo de nuevo.
404	InvalidVpnGatewayInstanceId.NotFound	The specified vpn gateway instance id does not exist.

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.