DescribeNatGateways
In this article:
DescribeNatGateways#
Description#
Запрос на получение списка NAT-шлюзов и их описаний. Фильтрация по заданным критериям позволяет включить в вывод только нужные NAT-шлюзы.
Request Parameters#
Filter.N — Параметры фильтрации.
Тип: Список объектов Filter
Необходимо: Нет
NatGatewayId.N — Идентификаторы NAT-шлюзов. Если параметр не указан, то выводится информация о всех NAT-шлюзах проекта.
Тип: Array of strings
Необходимо: Нет
Supported Filters#
nat-gateway-id — Идентификатор NAT-шлюза.
state — Состояние NAT-шлюза (возможные значения —
available,deleting,failed,pending).tag-key — Ключ тега. Такой фильтр позволяет получить ресурсы с указанным ключом и любым значением.
tag:<tag-key> — Пара ключ/значение тега. Ключ тега передаётся в названии фильтра, значение тега — в значении фильтра.
vpc-id — Идентификатор VPC, в котором создан NAT-шлюз.
Response Elements#
natGatewaySet — Информация о NAT-шлюзах.
Тип: Список объектов NatGateway
requestId — Идентификатор запроса.
Тип: String
Examples#
c2-ec2 DescribeNatGateways
c2-ec2 DescribeNatGateways NatGatewayId.1 <natgw_id>
c2-ec2 DescribeNatGateways Filter.1.Name vpc-id Filter.1.Value <vpc_id>
c2-ec2 DescribeNatGateways Filter.1.Name tag:<tag-key> Filter.1.Value "tag-value"