describe-instance-connect-endpoints
Описание
Описывает указанные конечные точки EC2 Instance Connect или все конечные точки EC2 Instance Connect.
См. также: Документация API AWS
describe-instance-connect-endpoints является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничность, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничностью, аргумент --query должен извлечь данные из результатов следующих выражений запроса: InstanceConnectEndpoints
Синтаксис
describe-instance-connect-endpoints
[--dry-run | --no-dry-run]
[--filters <value>]
[--instance-connect-endpoint-ids <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.--filters (список)
Один или несколько фильтров.
-
instance-connect-endpoint-id- Идентификатор конечной точки EC2 Instance Connect. -
state- Состояние конечной точки EC2 Instance Connect (create-in-progress|create-complete|create-failed|delete-in-progress|delete-complete|delete-failed). -
subnet-id- Идентификатор подсети, в которой была создана конечная точка EC2 Instance Connect. -
tag:<key> - Сочетание ключ/значение тега, назначенного ресурсу. Используйте ключ тега в имени фильтра и значение тега в качестве значения фильтра. Например, чтобы найти все ресурсы, имеющие тег с ключомOwnerи значениемTeamA, укажитеtag:Ownerв качестве имени фильтра иTeamAв качестве значения фильтра. -
tag-key- Ключ тега, назначенного ресурсу. Используйте этот фильтр, чтобы найти все ресурсы, которым назначен тег с указанным ключом, независимо от значения тега. -
tag-value- Значение тега, назначенного ресурсу. Используйте этот фильтр, чтобы найти все ресурсы, которые имеют тег с указанным значением, независимо от ключа тега. -
vpc-id- Идентификатор VPC, в котором была создана конечная точка EC2 Instance Connect.
(структура)
Пара ключ/значение фильтра, используемая для возврата более специфического списка результатов из операции describe. Фильтры могут быть использованы для сопоставления набора ресурсов по определенным критериям, таким как теги, атрибуты или идентификаторы.
Если вы указываете несколько фильтров, фильтры объединяются с AND, и запрос возвращает только результаты, соответствующие всем указанным фильтрам.
Для получения дополнительной информации см. Список и фильтрация с помощью командной строки и API в Руководстве пользователя Amazon EC2.
Имя -> (строка)
Значения -> (список)
Значения фильтра. Значения фильтров чувствительны к регистру. Если вы указываете несколько значений для фильтра, значения объединяются с OR, и запрос возвращает все результаты, соответствующие любому из указанных значений.
(строка)
Сокращенный синтаксис:
Name=string,Values=string,string ...
Синтаксис JSON:
[
{
"Name": "string",
"Values": ["string", ...]
}
...
]
--instance-connect-endpoint-ids (список)
Один или несколько идентификаторов конечных точек EC2 Instance Connect.
(строка)
Синтаксис:
"string" "string" ...
--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения перепишут значения, предоставленные в JSON. Невозможно передать произвольные двоичные значения с помощью предоставленного значения JSON, так как строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.
--starting-token (строка)
Токен для указания места начала постраничной обработки. Это NextToken из ранее усеченного ответа.
Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface.
--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 (строка)
Включить/отключить вывод цветного текста.
- on
- off
- auto
--no-sign-request (boolean)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.
--ca-bundle (строка)
Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.
--cli-read-timeout (int)
Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь ограничения по времени. Значение по умолчанию составляет 60 секунд.
--cli-connect-timeout (int)
Максимальное время подключения сокета в секундах. Если значение установлено в 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)
Автоматически запрашивать параметры ввода командной строки.
--no-cli-auto-prompt (boolean)
Отключить автоматическую запрос параметров ввода командной строки.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. Подробную информацию см. в руководстве по началу работы в Руководстве пользователя AWS CLI.
За исключением случаев, когда указано иное, все примеры используют правила цитирования Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной оболочки. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.
Для описания конечной точки EC2 Instance Connect
Следующий describe-instance-connect-endpoints пример описывает указанную конечную точку EC2 Instance Connect.
aws ec2 describe-instance-connect-endpoints \
--region us-east-1 \
--instance-connect-endpoint-ids eice-0123456789example
Вывод:
{
"InstanceConnectEndpoints": [
{
"OwnerId": "111111111111",
"InstanceConnectEndpointId": "eice-0123456789example",
"InstanceConnectEndpointArn": "arn:aws:ec2:us-east-1:111111111111:instance-connect-endpoint/eice-0123456789example",
"State": "create-complete",
"StateMessage": "",
"DnsName": "eice-0123456789example.b67b86ba.ec2-instance-connect-endpoint.us-east-1.amazonaws.com",
"NetworkInterfaceIds": [
"eni-0123456789example"
],
"VpcId": "vpc-0123abcd",
"AvailabilityZone": "us-east-1d",
"CreatedAt": "2023-02-07T12:05:37+00:00",
"SubnetId": "subnet-0123abcd",
"Tags": []
}
]
}
Дополнительную информацию см. в разделе Создание конечной точки EC2 Instance Connect в Руководстве пользователя Amazon EC2.
Вывод
InstanceConnectEndpoints -> (список)
Информация о конечных точках подключения EC2 Instance Connect.
(структура)
Конечная точка подключения EC2 Instance Connect.
OwnerId -> (строка)
InstanceConnectEndpointId -> (строка)
InstanceConnectEndpointArn -> (строка)
State -> (строка)
StateMessage -> (строка)
DnsName -> (строка)
FipsDnsName -> (строка)
NetworkInterfaceIds -> (список)
Идентификатор эластичного сетевого интерфейса, автоматически созданного Amazon EC2 при создании конечной точки EC2 Instance Connect.
(строка)
VpcId -> (строка)
AvailabilityZone -> (строка)
CreatedAt -> (временная метка)
SubnetId -> (строка)
PreserveClientIp -> (булево)
Указывает, сохраняется ли IP-адрес клиента в качестве источника. Значение равно true или false.
- Если
true, IP-адрес вашего клиента используется при подключении к ресурсу. - Если
false, IP-адрес эластичного сетевого интерфейса используется при подключении к ресурсу.
По умолчанию: true
SecurityGroupIds -> (список)
Безопасные группы, связанные с конечной точкой. Если вы не указали группу безопасности, с конечной точкой связывается группа безопасности по умолчанию для вашей VPC.
(строка)
Tags -> (список)
Теги, назначенные конечной точке EC2 Instance Connect.
(структура)
Описание тега.
Key -> (строка)
Ключ тега.
Ограничения: Ключи тегов чувствительны к регистру и принимают максимум 127 символов Unicode. Не должны начинаться с aws:.
Value -> (строка)
Значение тега.
Ограничения: Значения тегов чувствительны к регистру и принимают максимум 256 символов Unicode.
NextToken -> (строка)
null, если больше элементов не возвращается.
© Copyright 2025, Amazon Web Services. Created using Sphinx.