Spec-Zone.ru › AWS CLI v2

[ aws . globalaccelerator ]

list-accelerators

Описание

Список ускорителей для учётной записи Amazon Web Services.

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

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

Синтаксис

  list-accelerators
[--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]

Параметры

--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 CLI.

--max-items (целое число)

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

Примеры использования см. в разделе «Постраничный вывод» в руководстве пользователя AWS CLI.

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

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

--debug (логическое значение)

Включить отладку.

--endpoint-url (строка)

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

--no-verify-ssl (логическое значение)

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

--no-paginate (логическое значение)

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

--output (строка)

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

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

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

--no-sign-request (логическое значение)

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

--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 (логическое значение)

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

--cli-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Примеры

Примечание

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

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

Для получения списка ваших ускорителей

Следующий пример list-accelerators отображает ускорители в вашей учётной записи AWS. В этой учётной записи два ускорителя.

aws globalaccelerator list-accelerators

Вывод:

{
    "Accelerators": [
        {
            "AcceleratorArn": "arn:aws:globalaccelerator::012345678901:accelerator/5555abcd-abcd-5555-abcd-5555EXAMPLE1",
            "Name": "TestAccelerator",
            "IpAddressType": "IPV4",
            "Enabled": true,
            "IpSets": [
                {
                    "IpFamily": "IPv4",
                    "IpAddresses": [
                        "192.0.2.250",
                        "198.51.100.52"
                    ]
                }
            ],
            "DnsName": "5a5a5a5a5a5a5a5a.awsglobalaccelerator.com",
            "Status": "DEPLOYED",
            "CreatedTime": 1552424416.0,
            "LastModifiedTime": 1569375641.0
        },
        {
            "AcceleratorArn": "arn:aws:globalaccelerator::888888888888:accelerator/8888abcd-abcd-8888-abcd-8888EXAMPLE2",
            "Name": "ExampleAccelerator",
            "IpAddressType": "IPV4",
            "Enabled": true,
            "IpSets": [
                {
                    "IpFamily": "IPv4",
                    "IpAddresses": [
                        "192.0.2.100",
                        "198.51.100.10"
                    ]
                }
            ],
            "DnsName": "6a6a6a6a6a6a6a.awsglobalaccelerator.com",
            "Status": "DEPLOYED",
            "CreatedTime": 1575585564.0,
            "LastModifiedTime": 1579809243.0
        },
    ]
}

Дополнительная информация приведена в разделе «Ускорители» в руководстве разработчика AWS Global Accelerator.

Выходные данные

Ускорители -> (список)

Список ускорителей для учетной записи клиента.

(структура)

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

AcceleratorArn -> (строка)

Amazon Resource Name (ARN) ускорителя.

Name -> (строка)

Имя ускорителя. Имя должно содержать только буквенно-цифровые символы или дефисы (-) и не должно начинаться или заканчиваться дефисом.

IpAddressType -> (строка)

Тип IP-адреса, который поддерживает ускоритель. Для стандартного ускорителя значение может быть IPV4 или DUAL_STACK.

Enabled -> (булево)

Указывает, включен ли ускоритель. Значение — true или false. Значение по умолчанию — true.

Если значение установлено в true, ускоритель не может быть удален. Если установлено в false, ускоритель может быть удален.

IpSets -> (список)

Статические IP-адреса, которые Global Accelerator связывает с ускорителем.

(структура)

Сложный тип для набора IP-адресов ускорителя.

IpFamily -> (строка)

IpFamily устарел и был заменен на IpAddressFamily.

IpAddresses -> (список)

Массив IP-адресов в наборе IP-адресов. Набор IP-адресов может содержать не более двух IP-адресов.

(строка)

IpAddressFamily -> (строка)

Типы IP-адресов, включенных в этот набор IP-адресов.

DnsName -> (строка)

Имя доменной системы (DNS), которое Global Accelerator создает и которое указывает на статические IPv4-адреса ускорителя.

Конвенция именования имени DNS для ускорителя следующая: строчная буква «a», за которой следует 16-битная случайная шестнадцатеричная строка, за которой следует .awsglobalaccelerator.com. Например: a1234567890abcdef.awsglobalaccelerator.com.

Если у вас есть ускоритель с двойной стековой адресацией, у вас также есть второе имя DNS, DualStackDnsName, которое указывает как на запись A, так и на запись AAAA для всех четырёх статических адресов ускорителя: два IPv4-адреса и два IPv6-адреса.

Дополнительную информацию об имени DNS по умолчанию см. в разделе Поддержка адресации DNS в Global Accelerator в Руководстве разработчика Global Accelerator.

Status -> (строка)

Описание статуса развертывания ускорителя.

CreatedTime -> (временная метка)

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

LastModifiedTime -> (временная метка)

Дата и время последнего изменения ускорителя.

DualStackDnsName -> (строка)

Имя доменной системы (DNS), которое Global Accelerator создаёт, указывающее на четыре статических IP-адреса ускорителя с двойной стековой адресацией: два IPv4-адреса и два IPv6-адреса.

Конвенция именования имени DNS для двойной стековой адресации следующая: строчная буква «a», за которой следует 16-битная случайная шестнадцатеричная строка, за которой следует .dualstack.awsglobalaccelerator.com. Например: a1234567890abcdef.dualstack.awsglobalaccelerator.com.

Примечание: Global Accelerator также назначает имя DNS по умолчанию, DnsName, вашему ускорителю, которое указывает только на статические IPv4-адреса.

Дополнительную информацию см. в разделе Поддержка адресации DNS в Global Accelerator в Руководстве разработчика Global Accelerator.

Events -> (список)

История изменений, которые вы вносите в ускоритель в Global Accelerator.

(структура)

Сложный тип, содержащий значение Timestamp и Message для изменений, которые вы вносите в ускоритель в Global Accelerator. Сообщения, хранящиеся здесь, предоставляют информацию о прогрессе или ошибках при обновлении ускорителя с IPv4 на двойную стековую адресацию или с двойной стековой адресации на IPv4. Global Accelerator хранит не более десяти сообщений событий.

Message -> (строка)

Строка, содержащая сообщение Event, описывающее изменения или ошибки при обновлении ускорителя в Global Accelerator с IPv4 на двойную стековую адресацию или с двойной стековой адресации на IPv4.

Timestamp -> (временная метка)

Временная метка для обновления ускорителя в Global Accelerator с IPv4 на двойную стековую адресацию или с двойной стековой адресации на IPv4.

NextToken -> (строка)

Маркер для следующего набора результатов. Вы получаете этот маркер из предыдущего вызова.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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