Spec-Zone.ru › AWS CLI v2

[ aws . ec2 ]

describe-vpc-endpoints

Описание

Описывает ваши конечные точки VPC. По умолчанию описываются все ваши конечные точки VPC. В качестве альтернативы вы можете указать конкретные идентификаторы конечных точек VPC или отфильтровать результаты, чтобы включить только конечные точки VPC, соответствующие определенным критериям.

См. также: Документация AWS API

describe-vpc-endpoints является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничность, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в постраничном ответе, аргумент --query должен извлекать данные из результатов следующих выражений запроса: VpcEndpoints

Синтаксис

  describe-vpc-endpoints
[--dry-run | --no-dry-run]
[--vpc-endpoint-ids <value>]
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--dry-run | --no-dry-run (boolean)

Проверяет, имеете ли вы необходимые разрешения для действия, не выполняя фактический запрос, и предоставляет ответ об ошибке. Если у вас есть необходимые разрешения, ответ об ошибке DryRunOperation . В противном случае, это UnauthorizedOperation .

--vpc-endpoint-ids (list)

Идентификаторы конечных точек VPC.

(string)

Синтаксис:

"string" "string" ...

--filters (list)

Фильтры.

  • ip-address-type - Тип IP-адреса (ipv4 | ipv6 ).
  • service-name - Название сервиса.
  • service-region - Регион сервиса.
  • tag :<key> - Пара ключ/значение тега, назначенного ресурсу. Используйте ключ тега в имени фильтра и значение тега в качестве значения фильтра. Например, чтобы найти все ресурсы, имеющие тег с ключом Owner и значением TeamA , укажите tag:Owner для имени фильтра и TeamA для значения фильтра.
  • tag-key - Ключ тега, назначенного ресурсу. Используйте этот фильтр, чтобы найти все ресурсы, которым назначен тег с определенным ключом, независимо от значения тега.
  • vpc-id - Идентификатор VPC, в котором находится конечная точка.
  • vpc-endpoint-id - Идентификатор конечной точки.
  • vpc-endpoint-state - Состояние конечной точки (pendingAcceptance | pending | available | deleting | deleted | rejected | failed ).
  • vpc-endpoint-type - Тип конечной точки VPC (Interface | Gateway | GatewayLoadBalancer | Resource | ServiceNetwork ).

(structure)

Пара имени фильтра и значения, используемая для возврата более конкретного списка результатов операции describe. Фильтры могут использоваться для сопоставления набора ресурсов по определенным критериям, таким как теги, атрибуты или идентификаторы.

Если вы укажете несколько фильтров, фильтры соединяются с AND, и запрос возвращает только результаты, соответствующие всем указанным фильтрам.

Дополнительную информацию см. в разделе Список и фильтрация с помощью командной строки и API в Руководстве пользователя Amazon EC2 .

Name -> (string)

Имя фильтра. Имена фильтров чувствительны к регистру.

Values -> (list)

Значения фильтра. Значения фильтров чувствительны к регистру. Если вы укажете несколько значений для фильтра, значения соединяются с OR, и запрос возвращает все результаты, соответствующие любому из указанных значений.

(string)

Сокращенный синтаксис:

Name=string,Values=string,string ...

Синтаксис JSON:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Читает аргументы из предоставленной JSON-строки. JSON-строка следует формату, указанному в --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, предоставленные JSON. Передача произвольных двоичных значений с помощью значения, предоставленного JSON, невозможна, поскольку строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.

--starting-token (string)

Маркер для указания места начала постраничной обработки. Это NextToken из ранее усеченного ответа.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface .

--page-size (integer)

Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface .

--max-items (integer)

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Чтобы продолжить постраничную обработку, предоставьте значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface .

--generate-cli-skeleton (string) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если предоставлено без значения или со значением input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, он выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, он проверит входные данные команды и вернет пример выходного JSON для этой команды. Сгенерированный JSON-скелет не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (boolean)

Включить отладку логгирования.

--endpoint-url (string)

Переопределить URL по умолчанию команды на указанный URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого соединения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение по умолчанию по проверке сертификатов SSL.

--no-paginate (boolean)

Отключить автоматическую постраничную обработку. Если автоматическая постраничная обработка отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команды.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

Запрос JMESPath для использования при фильтрации данных ответа.

--profile (string)

Использовать определенный профиль из файла учетных данных.

--region (string)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (string)

Отобразить версию этого инструмента.

--color (string)

Включить/отключить цветной вывод.

  • on
  • off
  • auto

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (string)

Набор сертификатов CA для использования при проверке сертификатов SSL. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (string)

Стиль форматирования для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены в виде строки, закодированной в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, сопоставленного с двоичным блоком, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла напрямую, независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Отключить пейджер командной строки для вывода.

--cli-auto-prompt (boolean)

Автоматически запросить параметры ввода CLI.

--no-cli-auto-prompt (boolean)

Отключить автоматический запрос параметров ввода CLI.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в Руководстве пользователя AWS CLI .

Если не указано иное, все примеры используют правила цитирования, подобные Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. Использование кавычек со строками в Руководстве пользователя AWS CLI .

Для описания ваших конечных точек VPC

Следующий пример describe-vpc-endpoints отображает детали всех ваших конечных точек VPC.

aws ec2 describe-vpc-endpoints

Вывод:

{
    "VpcEndpoints": [
        {
            "PolicyDocument": "{\"Version\":\"2008-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":\"*\",\"Action\":\"*\",\"Resource\":\"*\"}]}",
            "VpcId": "vpc-aabb1122",
            "NetworkInterfaceIds": [],
            "SubnetIds": [],
            "PrivateDnsEnabled": true,
            "State": "available",
            "ServiceName": "com.amazonaws.us-east-1.dynamodb",
            "RouteTableIds": [
                "rtb-3d560345"
            ],
            "Groups": [],
            "VpcEndpointId": "vpce-032a826a",
            "VpcEndpointType": "Gateway",
            "CreationTimestamp": "2017-09-05T20:41:28Z",
            "DnsEntries": [],
            "OwnerId": "123456789012"
        },
        {
            "PolicyDocument": "{\n\"Statement\": [\n    {\n\"Action\": \"*\", \n\"Effect\": \"Allow\", \n\"Principal\": \"*\", \n\"Resource\": \"*\"\n    }\n  ]\n}",
            "VpcId": "vpc-1a2b3c4d",
            "NetworkInterfaceIds": [
                "eni-2ec2b084",
                "eni-1b4a65cf"
            ],
            "SubnetIds": [
                "subnet-d6fcaa8d",
                "subnet-7b16de0c"
            ],
            "PrivateDnsEnabled": false,
            "State": "available",
            "ServiceName": "com.amazonaws.us-east-1.elasticloadbalancing",
            "RouteTableIds": [],
            "Groups": [
                {
                    "GroupName": "default",
                    "GroupId": "sg-54e8bf31"
                }
            ],
            "VpcEndpointId": "vpce-0f89a33420c1931d7",
            "VpcEndpointType": "Interface",
            "CreationTimestamp": "2017-09-05T17:55:27.583Z",
            "DnsEntries": [
                {
                    "HostedZoneId": "Z7HUB22UULQXV",
                    "DnsName": "vpce-0f89a33420c1931d7-bluzidnv.elasticloadbalancing.us-east-1.vpce.amazonaws.com"
                },
                {
                    "HostedZoneId": "Z7HUB22UULQXV",
                    "DnsName": "vpce-0f89a33420c1931d7-bluzidnv-us-east-1b.elasticloadbalancing.us-east-1.vpce.amazonaws.com"
                },
                {
                    "HostedZoneId": "Z7HUB22UULQXV",
                    "DnsName": "vpce-0f89a33420c1931d7-bluzidnv-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com"
                }
            ],
            "OwnerId": "123456789012"
        },
        {
            "VpcEndpointId": "vpce-aabbaabbaabbaabba",
            "VpcEndpointType": "GatewayLoadBalancer",
            "VpcId": "vpc-111122223333aabbc",
            "ServiceName": "com.amazonaws.vpce.us-east-1.vpce-svc-123123a1c43abc123",
            "State": "available",
            "SubnetIds": [
                "subnet-0011aabbcc2233445"
            ],
            "RequesterManaged": false,
            "NetworkInterfaceIds": [
                "eni-01010120203030405"
            ],
            "CreationTimestamp": "2020-11-11T08:06:03.522Z",
            "Tags": [],
            "OwnerId": "123456789012"
        }
    ]
}

Дополнительную информацию см. в разделе Концепции в Руководстве пользователя AWS PrivateLink.

Вывод

VpcEndpoints -> (список)

Информация о конечных точках VPC.

(структура)

Описание конечной точки VPC.

VpcEndpointId -> (строка)

Идентификатор конечной точки.

VpcEndpointType -> (строка)

Тип конечной точки.

VpcId -> (строка)

Идентификатор VPC, к которому относится конечная точка.

ServiceName -> (строка)

Имя службы, к которой относится конечная точка.

State -> (строка)

Состояние конечной точки.

PolicyDocument -> (строка)

Документ политики, связанный с конечной точкой (применимо).

RouteTableIds -> (список)

(Конечная точка шлюза) Идентификаторы таблиц маршрутизации, связанных с конечной точкой.

(строка)

SubnetIds -> (список)

(Конечная точка интерфейса) Подсети для конечной точки.

(строка)

Groups -> (список)

(Конечная точка интерфейса) Информация о группах безопасности, связанных с сетевым интерфейсом.

(структура)

Описание группы безопасности.

GroupId -> (строка)

Идентификатор группы безопасности.

GroupName -> (строка)

Имя группы безопасности.

IpAddressType -> (строка)

Тип IP-адреса для конечной точки.

DnsOptions -> (структура)

Параметры DNS для конечной точки.

DnsRecordIpType -> (строка)

Записи DNS, созданные для конечной точки.

PrivateDnsOnlyForInboundResolverEndpoint -> (булево)

Указывает, следует ли включить только частный DNS для входящих конечных точек.

PrivateDnsEnabled -> (булево)

(Конечная точка интерфейса) Указывает, связано ли VPC с частной зоной DNS.

RequesterManaged -> (булево)

Указывает, управляет ли служба конечной точкой.

NetworkInterfaceIds -> (список)

(Конечная точка интерфейса) Сетевые интерфейсы для конечной точки.

(строка)

DnsEntries -> (список)

(Конечная точка интерфейса) Записи DNS для конечной точки.

(структура)

Описание записи DNS.

DnsName -> (строка)

Имя DNS.

HostedZoneId -> (строка)

Идентификатор частной зоны DNS.

CreationTimestamp -> (метка времени)

Дата и время создания конечной точки.

Tags -> (список)

Теги, назначенные конечной точке.

(структура)

Описание тега.

Key -> (строка)

Ключ тега.

Ограничения: Ключи тегов регистрозависимые и принимают максимум 127 символов Юникода. Не должно начинаться с aws: .

Value -> (строка)

Значение тега.

Ограничения: Значения тегов регистрозависимые и принимают максимум 256 символов Юникода.

OwnerId -> (строка)

Идентификатор учетной записи Amazon Web Services, владеющей конечной точкой.

LastError -> (структура)

Последняя ошибка, возникшая для конечной точки.

Message -> (строка)

Сообщение об ошибке для ошибки конечной точки VPC.

Code -> (строка)

Код ошибки для ошибки конечной точки VPC.

Ipv4Prefixes -> (список)

Массив префиксов IPv4.

(структура)

Префиксы IP-адреса подсети.

SubnetId -> (строка)

Идентификатор подсети.

IpPrefixes -> (список)

Массив объектов SubnetIpPrefixes.

(строка)

Ipv6Prefixes -> (список)

Массив префиксов IPv6.

(структура)

Префиксы IP-адреса подсети.

SubnetId -> (строка)

Идентификатор подсети.

IpPrefixes -> (список)

Массив объектов SubnetIpPrefixes.

(строка)

FailureReason -> (строка)

Причина отказа.

ServiceNetworkArn -> (строка)

Amazon Resource Name (ARN) сетевой службы.

ResourceConfigurationArn -> (строка)

Amazon Resource Name (ARN) конфигурации ресурса.

ServiceRegion -> (строка)

Регион, в котором размещена служба.

NextToken -> (строка)

Токен для запроса следующего набора элементов. Если дополнительных элементов нет, строка пустая.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API