Spec-Zone.ru › AWS CLI v2

[ aws . synthetics ]

describe-canaries-last-run

Описание

Используйте эту операцию, чтобы увидеть информацию о последнем запуске каждого созданного вами канэри.

Эта операция поддерживает авторизацию на уровне ресурсов с помощью политики IAM и параметра Names. Если вы укажете параметр Names, операция будет успешной только в том случае, если у вас есть разрешение на просмотр всех канэри, указанных в вашем запросе. Если у вас нет разрешения на просмотр какого-либо канэри, запрос завершится с ответом 403.

Вам необходимо использовать параметр Names, если вы вошли в систему под пользователем или ролью, имеющей политику IAM, ограничивающую просматриваемые канэри. Дополнительную информацию см. в разделе Ограничение просмотра канэри определенным пользователям.

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

Синтаксис

  describe-canaries-last-run
[--next-token <value>]
[--max-results <value>]
[--names <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]

Параметры

--next-token (строка)

Маркер, указывающий на то, что доступны дополнительные данные. Этот маркер можно использовать в последующей операции DescribeCanariesLastRun для получения следующего набора результатов.

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

Укажите этот параметр, чтобы ограничить количество возвращаемых запусков при каждом использовании операции DescribeLastRun. Если этот параметр опущен, используется значение по умолчанию 100.

--names (список)

Используйте этот параметр, чтобы возвращать только канэри, имена которых соответствуют указанным здесь. Вы можете указать до пяти имён канэри.

Если вы укажете этот параметр, операция будет успешной только в том случае, если у вас есть разрешение на просмотр всех канэри, указанных в вашем запросе. Если у вас нет разрешения на просмотр какого-либо канэри, запрос завершится с ответом 403.

Вам необходимо использовать параметр Names, если вы вошли в систему под пользователем или ролью, имеющей политику IAM, ограничивающую просматриваемые канэри. Дополнительную информацию см. в разделе Ограничение просмотра канэри определенным пользователям.

(строка)

Синтаксис:

"string" "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
  • текст
  • таблица
  • 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 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.

Чтобы увидеть информацию о последнем запуске каждого канэри

Следующий пример describe-canaries-last-run возвращает последние запуски каждого канэри, который вы создали.

aws synthetics describe-canaries-last-run

Вывод:

{
    "CanariesLastRun": [
        {
            "CanaryName": "demo_canary",
            "LastRun": {
                "Id": "a1b2c3d4-5678-90ab-cdef-example11111",
                "Name": "demo_canary",
                "Status": {
                    "State": "PASSED",
                    "StateReason": "",
                    "StateReasonCode": ""
                },
                "Timeline": {
                    "Started": "2024-10-15T19:20:39.691000+05:30",
                    "Completed": "2024-10-15T19:20:58.211000+05:30"
                },
                "ArtifactS3Location": "cw-syn-results-123456789012-us-east-1/canary/us-east-1/demo_canary-abc-example1234/2024/10/15/13/50-39-690"
            }
        }
    ]
}

Дополнительную информацию см. в разделе Синтетическое мониторинг (канэри) в руководстве пользователя Amazon CloudWatch.

Вывод

CanariesLastRun -> (список)

Массив, содержащий информацию о последнем запуске каждого канэри.

(структура)

Эта структура содержит информацию о последнем запуске одного канэри.

CanaryName -> (строка)

Имя канэри.

LastRun -> (структура)

Результаты последнего запуска канэри.

Id -> (строка)

Уникальный идентификатор, определяющий этот запуск канэри.

ScheduledRunId -> (строка)

Идентификатор запланированного запуска канэри.

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

Количество попыток повторного запуска.

Name -> (строка)

Имя канэри.

Status -> (структура)

Статус этого запуска.

State -> (строка)

Текущее состояние запуска.

StateReason -> (строка)

Если запуск канэри завершился ошибкой, это поле содержит причину ошибки.

StateReasonCode -> (строка)

Если это значение равно CANARY_FAILURE, в коде канэри произошла ошибка. Если это значение равно EXECUTION_FAILURE, произошла ошибка в CloudWatch Synthetics.

Timeline -> (структура)

Структура, содержащая время начала и окончания этого запуска.

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

Время начала запуска.

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

Время окончания запуска.

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

Время, когда метрики будут сгенерированы для этого запуска или повторных попыток.

ArtifactS3Location -> (строка)

Местоположение, где канэри сохранил артефакты из запуска. Артефакты включают файл журнала, скриншоты и файлы HAR.

DryRunConfig -> (структура)

Возвращает конфигурации пробного запуска для канэри.

DryRunId -> (строка)

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

NextToken -> (строка)

Маркер, указывающий на то, что доступны дополнительные данные. Этот маркер можно использовать в последующей операции DescribeCanariesLastRun для получения следующего набора результатов.

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

Spec-Zone.ru

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