[ aws . synthetics ]
get-canary-runs
Описание
Получает список запусков для указанного кэнэри.
См. также: Документацию API AWS
Синтаксис
get-canary-runs
--name <value>
[--next-token <value>]
[--max-results <value>]
[--dry-run-id <value>]
[--run-type <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]
Параметры
--name (строка)
--next-token (строка)
Токен, указывающий на наличие дополнительных данных. Вы можете использовать этот токен в последующей операции GetCanaryRuns для получения следующего набора результатов.
--max-results (целое число)
GetCanaryRuns. Если вы опустите этот параметр, будет использоваться значение по умолчанию 100.--dry-run-id (строка)
--run-type (строка)
- При предоставлении
RunType=CANARY_RUNиdryRunId, произойдет ошибка - Если значение не предоставлено для
RunType, значение по умолчанию —CANARY_RUN - Если предоставлено значение
CANARY_RUN, возвращаются все запуски кэнэри, за исключением сухих запусков - Если предоставлено значение
DRY_RUN, возвращаются все сухие запуски, за исключением запусков кэнэри
Возможные значения:
CANARY_RUNDRY_RUN
--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 (boolean)
Включить отладочную запись журнала.
--endpoint-url (string)
Заменить стандартный URL команды на указанный URL.
--no-verify-ssl (boolean)
По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет стандартное поведение проверки SSL-сертификатов.
--no-paginate (boolean)
Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.
--output (string)
Стиль форматирования вывода команды.
- json
- text
- table
- yaml
- yaml-stream
--query (string)
Запрос JMESPath для фильтрации данных ответа.
--profile (string)
Использовать определённый профиль из файла с данными учетных данных.
--region (string)
Регион для использования. Переопределяет параметры из конфигурации/среды.
--version (string)
Показать версию этого инструмента.
--color (string)
Включить/отключить вывод в цвете.
- on
- off
- auto
--no-sign-request (boolean)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент указан.
--ca-bundle (string)
Файл с сертификатами CA для проверки SSL-сертификатов. Переопределяет параметры из конфигурации/среды.
--cli-read-timeout (int)
Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию — 60 секунд.
--cli-connect-timeout (int)
Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию — 60 секунд.
--cli-binary-format (string)
Стиль форматирования, используемый для двоичных блоков. По умолчанию используется формат 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 для вывода.
--cli-auto-prompt (boolean)
Автоматически запросить параметры ввода CLI.
--no-cli-auto-prompt (boolean)
Отключить автоматическое запросить параметров ввода CLI.
Примеры
Примечание
Для использования следующих примеров вам необходимо установить и настроить AWS CLI. Дополнительную информацию можно найти в руководстве по началу работы в руководстве пользователя AWS CLI.
Если не указано иное, во всех примерах используются правила цитирования, характерные для Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. Использование кавычек со строками в руководстве пользователя AWS CLI.
Получение списка запусков для указанного каниды
Следующий get-canary-runs пример получает список запусков для каниды с именем demo_canary.
aws synthetics get-canary-runs \
--name demo_canary
Вывод:
{
"CanaryRuns": [
{
"Id": "a1b2c3d4-5678-90ab-cdef-example11111",
"Name": "demo_canary",
"Status": {
"State": "PASSED",
"StateReason": "",
"StateReasonCode": ""
},
"Timeline": {
"Started": "2024-10-16T10:38:57.013000+05:30",
"Completed": "2024-10-16T10:39:25.793000+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.
Вывод
CanaryRuns -> (список)
Массив структур. Каждая структура содержит подробности об одном из полученных запусков канэри.
(структура)
Эта структура содержит подробности об одном запуске одного канэри.
Id -> (строка)
ScheduledRunId -> (строка)
RetryAttempt -> (целое число)
Name -> (строка)
Status -> (структура)
Статус этого запуска.
State -> (строка)
StateReason -> (строка)
StateReasonCode -> (строка)
CANARY_FAILURE, произошла ошибка в коде канэри. Если это значение равно EXECUTION_FAILURE, произошла ошибка в CloudWatch Synthetics.Timeline -> (структура)
Структура, содержащая начальное и конечное время этого запуска.
Started -> (временная метка)
Completed -> (временная метка)
MetricTimestampForRunAndRetries -> (временная метка)
ArtifactS3Location -> (строка)
DryRunConfig -> (структура)
Возвращает конфигурации сухих запусков для канэри.
DryRunId -> (строка)
NextToken -> (строка)
GetCanaryRuns для получения следующего набора результатов.
© Copyright 2025, Amazon Web Services. Created using Sphinx.