Spec-Zone.ru › AWS CLI v2

[ aws . servicediscovery ]

list-operations

Описание

Отображает операции, соответствующие заданным критериям.

См. также: AWS API Documentation

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

Синтаксис

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

Параметры

--filters (list)

Сложный тип, содержащий спецификации операций, которые требуется отобразить, например, операции, начатые между указанными начальной и конечной датами.

Если задано несколько фильтров, операция должна соответствовать всем фильтрам, чтобы быть возвращённой ListOperations.

(структура)

Сложный тип, позволяющий выбрать операции для отображения.

Name -> (строка)

Укажите операции, которые вы хотите получить:

  • NAMESPACE_ID : Получает операции, относящиеся к указанным именованным пространствам.
  • SERVICE_ID : Получает операции, относящиеся к указанным сервисам.
  • STATUS : Получает операции на основе статуса операций: SUBMITTED, PENDING, SUCCEED или FAIL.
  • TYPE : Получает указанные типы операций.
  • UPDATE_DATE : Получает операции, изменившие статус в указанном диапазоне дат/времени.

Values -> (список)

Укажите значения, применимые к значению, которое вы указали для Name:

  • NAMESPACE_ID : Укажите один идентификатор именованного пространства.
  • SERVICE_ID : Укажите один идентификатор сервиса.
  • STATUS : Укажите один или несколько статусов: SUBMITTED, PENDING, SUCCEED или FAIL.
  • TYPE : Укажите один или несколько типов: CREATE_NAMESPACE, DELETE_NAMESPACE, UPDATE_SERVICE, REGISTER_INSTANCE или DEREGISTER_INSTANCE.
  • UPDATE_DATE : Укажите начальную и конечную даты в формате Unix с датой и временем и в формате Coordinated Universal Time (UTC). Начальная дата должна быть первым значением.

(строка)

Condition -> (строка)

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

  • EQ: Когда вы указываете EQ для условия, вы можете указать только одно значение. EQ поддерживается для NAMESPACE_ID, SERVICE_ID, STATUS и TYPE. EQ — это условие по умолчанию и может быть опущено.
  • IN: Когда вы указываете IN для условия, вы можете указать список из одного или нескольких значений. IN поддерживается для STATUS и TYPE. Операция должна соответствовать одному из указанных значений, чтобы быть возвращённой в ответе.
  • BETWEEN: Укажите начальную и конечную даты в формате Unix с датой и временем и в формате Coordinated Universal Time (UTC). Начальная дата должна быть первым значением. BETWEEN поддерживается для UPDATE_DATE.

Краткая запись:

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

Синтаксис JSON:

[
  {
    "Name": "NAMESPACE_ID"|"SERVICE_ID"|"STATUS"|"TYPE"|"UPDATE_DATE",
    "Values": ["string", ...],
    "Condition": "EQ"|"IN"|"BETWEEN"|"BEGINS_WITH"
  }
  ...
]

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

Включает отладочную запись.

--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-operations отображаются операции со статусом PENDING или SUCCESS.

aws servicediscovery list-operations \
    --service-id srv-e4anhexample0004 \
    --filters Name=STATUS,Condition=IN,Values=PENDING,SUCCESS

Вывод:

{
    "Operations": [
        {
            "Id": "76yy8ovhpdz0plmjzbsnqgnrqvpv2qdt-kexample",
            "Status": "SUCCESS"
        },
        {
            "Id": "prysnyzpji3u2ciy45nke83x2zanl7yk-dexample",
            "Status": "SUCCESS"
        },
        {
            "Id": "ko4ekftir7kzlbechsh7xvcdgcpk66gh-7example",
            "Status": "PENDING"
        }
    ]
}

Дополнительную информацию см. в разделе Что такое AWS Cloud Map? в Руководстве разработчика AWS Cloud Map.

Вывод

Операции -> (список)

Сводная информация об операциях, соответствующих заданным критериям.

(структура)

Сложный тип, содержащий информацию об операции, соответствующей критериям, указанным в запросе ListOperations.

Id -> (строка)

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

Состояние -> (строка)

Состояние операции. Значения включают:

  • ОТПРАВЛЕН : Начальное состояние сразу после отправки запроса.
  • В ОЖИДАНИИ : Cloud Map выполняет операцию.
  • УСПЕШНО : Операция выполнена успешно.
  • НЕУДАЧА : Операция завершилась неудачно. Причину неудачи см. в ErrorMessage .

NextToken -> (строка)

Если ответ содержит NextToken , отправьте другой запрос ListOperations, чтобы получить следующую группу результатов. Укажите значение NextToken из предыдущего ответа в следующем запросе.

Примечание

Cloud Map получает MaxResults операций и затем фильтрует их на основе заданных критериев. Возможно, что ни одна из первых MaxResults операций не соответствует заданным критериям, но последующие группы из MaxResults операций могут содержать операции, соответствующие этим критериям.

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

Spec-Zone.ru

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