Spec-Zone.ru › AWS CLI v2

[ aws . swf ]

подсчёт-открытых-потоков-выполнений

Описание

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

Примечание

Данная операция использует принцип eventual consistency. Результаты являются приблизительными и могут не точно отражать последние обновления и изменения.

Контроль доступа

Вы можете использовать политики IAM для управления доступом к этому действию к ресурсам Amazon SWF следующим образом:

  • Используйте элемент Resource с именем домена, чтобы ограничить действие только указанными доменами.
  • Используйте элемент Action, чтобы разрешить или запретить разрешение на вызов этого действия.
  • Ограничьте следующие параметры, используя элемент Condition с соответствующими ключами.
    • tagFilter.tag : строковое ограничение. Ключ — swf:tagFilter.tag .
    • typeFilter.name : строковое ограничение. Ключ — swf:typeFilter.name .
    • typeFilter.version : строковое ограничение. Ключ — swf:typeFilter.version .

Если у вызывающего пользователя недостаточно разрешений для вызова действия или значения параметров выходят за пределы указанных ограничений, действие завершается ошибкой. Соответствующий атрибут события параметр cause устанавливается в значение OPERATION_NOT_PERMITTED . Подробную информацию и примеры политик IAM см. в разделе Использование IAM для управления доступом к рабочим потокам Amazon SWF в руководстве Amazon SWF Developer Guide .

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

Синтаксис

  count-open-workflow-executions
--domain <value>
--start-time-filter <value>
[--type-filter <value>]
[--tag-filter <value>]
[--execution-filter <value>]
[--cli-input-json | --cli-input-yaml]
[--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]

Параметры

--domain (строка)

Имя домена, содержащего потоки выполнения задач для подсчёта.

--start-time-filter (структура)

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

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

Указывает самую старую дату и время начала или закрытия для возврата.

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

Указывает самую позднюю дату и время начала или закрытия для возврата.

Краткая форма синтаксиса:

oldestDate=timestamp,latestDate=timestamp

Синтаксис JSON:

{
  "oldestDate": timestamp,
  "latestDate": timestamp
}

--type-filter (структура)

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

Примечание

executionFilter, typeFilter и tagFilter взаимоисключающие. Вы можете указать не более одного из них в запросе.

name -> (строка)

Имя типа рабочего потока.

version -> (строка)

Версия типа рабочего потока.

Краткая форма синтаксиса:

name=string,version=string

Синтаксис JSON:

{
  "name": "string",
  "version": "string"
}

--tag-filter (структура)

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

Примечание

executionFilter, typeFilter и tagFilter взаимоисключающие. Вы можете указать не более одного из них в запросе.

tag -> (строка)

Указывает тег, который должен быть связан с выполнением, чтобы оно соответствовало критериям фильтра.

Теги могут содержать только буквы, цифры, пробелы или следующие символы: _ . : / = + - @ .

Краткая форма синтаксиса:

tag=string

Синтаксис JSON:

{
  "tag": "string"
}

--execution-filter (структура)

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

Примечание

executionFilter, typeFilter и tagFilter взаимоисключающие. Вы можете указать не более одного из них в запросе.

workflowId -> (строка)

Идентификатор рабочего потока для соответствия критериям фильтра.

Краткая форма синтаксиса:

workflowId=string

Синтаксис JSON:

{
  "workflowId": "string"
}

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

--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
  • таблица
  • yaml
  • yaml-поток

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • включено
  • выключено
  • автоматически

--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 версии 1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, 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 .

Подсчёт открытых потоков выполнения задач

Вы можете использовать swf count-open-workflow-executions для получения количества открытых потоков выполнения задач для заданного домена. Вы можете указать фильтры для подсчёта определённых типов выполнения.

Аргументы --domain и --start-time-filter обязательны. Все остальные аргументы необязательны.

aws swf count-open-workflow-executions \
    --domain DataFrobtzz \
    --start-time-filter "{ \"latestDate\" : 1377129600, \"oldestDate\" : 1370044800 }"

Вывод:

{
    "count": 4,
    "truncated": false
}

Если «truncated» равно true, то «count» представляет максимальное количество, которое может быть возвращено Amazon SWF. Все последующие результаты обрезаются.

Для уменьшения количества возвращаемых результатов можно:

  • изменить значения --start-time-filter, чтобы сузить диапазон времени, который ищется.
  • использовать аргументы --close-status-filter, --execution-filter, --tag-filter или --type-filter для дальнейшей
    фильтрации результатов. Каждый из них взаимоисключающий: можно указать только один из них в запросе.

Для получения дополнительной информации см. CountOpenWorkflowExecutions в Справочнике по API Amazon Simple Workflow Service

Вывод

count -> (целое число)

Количество потоков выполнения задач.

truncated -> (булево)

Если установлено в значение true, указывает, что фактическое количество превысило максимальное значение, поддерживаемое данным API, и возвращаемое значение count — это обрезанное значение.

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

Spec-Zone.ru

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