.. _DescribeVpnConnections:

######################
DescribeVpnConnections
######################

***********
Description
***********

Запрос на получение списка всех VPN-соединений.
С учётом фильтрации по заданным критериям можно запросить описание одного или нескольких VPN-соединений.

******************
Request Parameters
******************

- *Filter.N* — Параметры фильтрации.

  - Тип: Список объектов :ref:`Filter`
  - Необходимо: Нет

- *VpnConnectionId.N* — Идентификаторы VPN-соединений.

  - Тип: String
  - По умолчанию: Список всех VPN-соединений

Supported Filters
=================

- *customer-gateway-id* — Идентификатор клиентского шлюза VPN-соединения.
- *state* — Состояние VPN-соединения (``pending`` | ``available`` | ``deleting``).
- *tag-key* — Ключ тега. Такой фильтр позволяет получить ресурсы с указанным ключом и любым значением.
- *tag:<tag-key>* — Пара ключ/значение тега. Ключ тега передаётся в названии фильтра, значение тега — в значении фильтра.
- *type* — Тип VPN-соединения (``ipsec.1`` | ``ipsec.legacy``).
- *vpn-connection-id* — Идентификатор VPN-соединения.
- *vpn-gateway-id* — Идентификатор VPN-шлюза со стороны виртуального частного облака.

*****************
Response Elements
*****************

- *requestId* — Идентификатор запроса.

  - Тип: String

- *vpnConnectionSet* — Информация об одном или нескольких VPN-соединениях.

  - Тип: Список объектов :ref:`VpnConnection`

********
Examples
********

.. code-block:: bash

   c2-ec2 DescribeVpnConnections

   c2-ec2 DescribeVpnConnections VpnConnectionId.1 <vpn_id>

   c2-ec2 DescribeVpnConnections Filter.1.Name state Filter.1.Value.1 available

   c2-ec2 DescribeVpnConnections Filter.1.Name vpn-gateway-id Filter.1.Value.1 <vgw_id>

   c2-ec2 DescribeVpnConnections Filter.1.Name tag:<tag-key> Filter.1.Value <tag-value>

   c2-ec2 DescribeVpnConnections Filter.1.Name tag-key Filter.1.Value <tag-key>