describe-vpc-endpoint-service-configurations
Описание
Описывает конфигурации служб VPC-туннелей в вашем аккаунте (ваши службы).
См. также: Документация API AWS
describe-vpc-endpoint-service-configurations это постраничная операция. Для получения всего набора результатов могут потребоваться несколько вызовов API. Вы можете отключить постраничную обработку, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной обработкой, аргумент --query должен извлекать данные из результатов следующих выражений запроса: ServiceConfigurations
Синтаксис
describe-vpc-endpoint-service-configurations
[--dry-run | --no-dry-run]
[--service-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 .--service-ids (список)
Идентификаторы служб туннелей.
(строка)
Синтаксис:
"string" "string" ...
--filters (список)
Фильтры.
-
service-name- Название службы. -
service-id- Идентификатор службы. -
service-state- Состояние службы (Pending|Available|Deleting|Deleted|Failed). -
supported-ip-address-types- Тип IP-адреса (ipv4|ipv6). -
tag:<ключ> - Пара ключ/значение тега, назначенного ресурсу. Используйте ключ тега в имени фильтра и значение тега в качестве значения фильтра. Например, чтобы найти все ресурсы, имеющие тег с ключомOwnerи значениемTeamA, укажитеtag:Ownerдля имени фильтра иTeamAдля значения фильтра. -
tag-key- Ключ тега, назначенного ресурсу. Используйте этот фильтр для поиска всех ресурсов, которым назначен тег с указанным ключом, независимо от значения тега.
(структура)
Пара имя/значение фильтра, используемая для возврата более конкретного списка результатов из операции describe. Фильтры могут быть использованы для сопоставления набора ресурсов по определенным критериям, таким как теги, атрибуты или идентификаторы.
Если вы указываете несколько фильтров, фильтры соединяются с помощью AND , и запрос возвращает только результаты, соответствующие всем указанным фильтрам.
Дополнительную информацию см. в разделе Список и фильтрация с помощью CLI и API в Руководстве пользователя Amazon EC2.
Имя -> (строка)
Значения -> (список)
Значения фильтра. Значения фильтров чувствительны к регистру. Если вы указываете несколько значений для фильтра, значения соединяются с помощью OR , и запрос возвращает все результаты, соответствующие любому из указанных значений.
(строка)
Сокращенный синтаксис:
Name=string,Values=string,string ...
Синтаксис JSON:
[
{
"Name": "string",
"Values": ["string", ...]
}
...
]
--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет взята буквально. Это может не быть указано вместе с --cli-input-yaml.
--starting-token (строка)
Токен для указания места начала постраничной обработки. Это NextToken из ранее усеченного ответа.
Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS CLI.
--page-size (целое число)
Размер каждой страницы для получения вызова AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, извлекая меньше элементов в каждом вызове. Это может помочь предотвратить зависание вызовов AWS-сервиса.
Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface.
--max-items (целое число)
Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Для продолжения постраничной обработки укажите значение NextToken в аргументе starting-token последующей команды. **Не** используйте элемент ответа NextToken напрямую за пределами AWS CLI.
Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface.
--generate-cli-skeleton (строка) Выводит каркас JSON в стандартный вывод без отправки запроса API. Если предоставлено значение без значения или со значением input, выводит пример JSON-ввода, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, будет напечатан пример YAML-ввода, который можно использовать с --cli-input-yaml. Если предоставлено значение output, оно проверяет входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный каркас JSON не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном каркасе JSON.
Глобальные параметры
--debug (boolean)
Включить отладку логирования.
--endpoint-url (строка)
Переопределить стандартный URL команды указанным URL.
--no-verify-ssl (boolean)
По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого соединения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет стандартное поведение проверки сертификатов SSL.
--no-paginate (boolean)
Отключить автоматическую постраничную обработку. Если автоматическая постраничная обработка отключена, AWS CLI выполнит только один вызов для первой страницы результатов.
--output (строка)
Стиль форматирования вывода команды.
- json
- text
- table
- yaml
- yaml-stream
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использовать определенный профиль из файла учетных данных.
--region (строка)
Регион для использования. Переопределяет настройки конфигурации/среды.
--version (строка)
Отобразить версию этого инструмента.
--color (строка)
Включить/выключить цветной вывод.
- включено
- выключено
- автоматически
--no-sign-request (boolean)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент указан.
--ca-bundle (строка)
Набор сертификатов CA для использования при проверке сертификатов SSL. Переопределяет настройки конфигурации/среды.
--cli-read-timeout (целое число)
Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию - 60 секунд.
--cli-connect-timeout (целое число)
Максимальное время подключения к сокету в секундах. Если значение установлено в 0, подключение к сокету будет блокирующим и не будет иметь таймаута. Значение по умолчанию - 60 секунд.
--cli-binary-format (строка)
Стиль форматирования, используемый для двоичных блоков. По умолчанию используется формат 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.
Чтобы описать конфигурации служб туннелей
Следующий пример describe-vpc-endpoint-service-configurations описывает конфигурации ваших служб туннелей.
aws ec2 describe-vpc-endpoint-service-configurations
Вывод:
{
"ServiceConfigurations": [
{
"ServiceType": [
{
"ServiceType": "GatewayLoadBalancer"
}
],
"ServiceId": "vpce-svc-012d33a1c4321cabc",
"ServiceName": "com.amazonaws.vpce.us-east-1.vpce-svc-012d33a1c4321cabc",
"ServiceState": "Available",
"AvailabilityZones": [
"us-east-1d"
],
"AcceptanceRequired": false,
"ManagesVpcEndpoints": false,
"GatewayLoadBalancerArns": [
"arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/gwy/GWLBService/123210844e429123"
],
"Tags": []
},
{
"ServiceType": [
{
"ServiceType": "Interface"
}
],
"ServiceId": "vpce-svc-123cabc125efa123",
"ServiceName": "com.amazonaws.vpce.us-east-1.vpce-svc-123cabc125efa123",
"ServiceState": "Available",
"AvailabilityZones": [
"us-east-1a"
],
"AcceptanceRequired": true,
"ManagesVpcEndpoints": false,
"NetworkLoadBalancerArns": [
"arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/net/NLBforService/1238753950b25123"
],
"BaseEndpointDnsNames": [
"vpce-svc-123cabc125efa123.us-east-1.vpce.amazonaws.com"
],
"PrivateDnsName": "example.com",
"PrivateDnsNameConfiguration": {
"State": "failed",
"Type": "TXT",
"Value": "vpce:qUAth3FdeABCApUiXabc",
"Name": "_1d367jvbg34znqvyefrj"
},
"Tags": []
}
]
}
Дополнительную информацию см. в разделе Концепции в Руководстве пользователя AWS PrivateLink.
Вывод
ServiceConfigurations -> (список)
Информация о службах.
(структура)
Описывает конфигурацию службы для сервиса VPC-туннеля.
ServiceType -> (список)
Тип службы.
(структура)
Описывает тип службы для VPC-туннеля.
ServiceType -> (строка)
ServiceId -> (строка)
ServiceName -> (строка)
ServiceState -> (строка)
AvailabilityZones -> (список)
Доступные зоны размещения, в которых доступна служба.
(строка)
AcceptanceRequired -> (логическое)
ManagesVpcEndpoints -> (логическое)
NetworkLoadBalancerArns -> (список)
Имена ресурсов Amazon (ARN) сетевых балансировщиков для службы.
(строка)
GatewayLoadBalancerArns -> (список)
Имена ресурсов Amazon (ARN) балансировщиков шлюзов для службы.
(строка)
SupportedIpAddressTypes -> (список)
Поддерживаемые типы IP-адресов.
(строка)
BaseEndpointDnsNames -> (список)
Имена DNS для службы.
(строка)
PrivateDnsName -> (строка)
PrivateDnsNameConfiguration -> (структура)
Информация о конфигурации приватного имени DNS сервиса туннеля.
State -> (строка)
Состояние проверки службы VPC-туннеля.
>Клиенты службы туннеля могут использовать приватное имя только при состоянии verified .
Type -> (строка)
Value -> (строка)
Name -> (строка)
value к name .PayerResponsibility -> (строка)
Tags -> (список)
Теги, назначенные службе.
(структура)
Описание тега.
Key -> (строка)
Ключ тега.
Ограничения: Ключи тегов регистрозависимы и принимают не более 127 символов Юникода. Не должно начинаться с aws: .
Value -> (строка)
Значение тега.
Ограничения: Значения тегов регистрозависимы и принимают не более 256 символов Юникода.
SupportedRegions -> (список)
Поддерживаемые регионы.
(структура)
Описание поддерживаемого региона.
Region -> (строка)
ServiceState -> (строка)
Pending , Available , Deleting , Deleted , Failed и Closed .RemoteAccessEnabled -> (логическое)
NextToken -> (строка)
null, если больше результатов нет.
© Copyright 2025, Amazon Web Services. Created using Sphinx.