DescribeCustomerGateways#

Description#

Запрос на получение списка всех зарегистрированных клиентских шлюзов и их описаний. Возможно применение одного или нескольких фильтров по параметрам клиентских шлюзов.

Request Parameters#

  • CustomerGatewayId — Идентификатор клиентского шлюза.

    • Тип: String

    • Необходимо: Нет

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

    • Тип: Список объектов Filter

    • Необходимо: Нет

Supported Filters#

  • bgp-asn — Номер автономной системы.

  • customer-gateway-id — Идентификатор клиентского шлюза.

  • ip-address — Адрес клиентского шлюза.

  • state — Состояние клиентского шлюза.

  • tag-key — Ключ тега. Такой фильтр позволяет получить ресурсы с указанным ключом и любым значением.

  • tag:<tag-key> — Пара ключ/значение тега. Ключ тега передаётся в названии фильтра, значение тега — в значении фильтра.

  • type — Тип клиентского шлюза.

Response Elements#

  • customerGatewaySet — Информация о клиентских шлюзах.

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

    • Тип: String

Examples#

c2-ec2 DescribeCustomerGateways

c2-ec2 DescribeCustomerGateways CustomerGatewayId.1 <cgw_id>

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

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

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