start-query

Описание

Запускает запрос к одному или нескольким группам журналов с использованием CloudWatch Logs Insights. Вы указываете группы журналов, временной диапазон для запроса и строку запроса.

Дополнительную информацию см. в разделе Синтаксис запросов CloudWatch Logs Insights.

После выполнения запроса с помощью StartQuery результаты запроса хранятся в CloudWatch Logs. Вы можете использовать GetQueryResults для получения результатов запроса, используя queryId, которое StartQuery возвращает.

Примечание

Для указания групп журналов, к которым нужно обратиться, операция StartQuery должна включать одно из следующих:

Любой из следующих параметров: logGroupName , logGroupNames , или logGroupIdentifiers
Или операция queryString должна включать команду SOURCE для выбора групп журналов для запроса. Команда SOURCE может выбирать группы журналов на основе префикса имени группы журнала, идентификатора учетной записи и класса журнала. Дополнительную информацию о команде SOURCE см. в разделе SOURCE.

Если вы связали ключ KMS с результатами запроса в этой учетной записи, то StartQuery использует этот ключ для шифрования результатов при их хранении. Если ключ не связан с результатами запроса, результаты запроса шифруются с помощью стандартного метода шифрования CloudWatch Logs.

Запросы отключаются после 60 минут работы. Если ваши запросы отключаются, уменьшите временной диапазон поиска или разбейте свой запрос на несколько запросов.

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

Вы можете иметь до 30 одновременных запросов CloudWatch Logs insights, включая запросы, добавленные в панели.

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

Синтаксис

  start-query
[--query-language <value>]
[--log-group-name <value>]
[--log-group-names <value>]
[--log-group-identifiers <value>]
--start-time <value>
--end-time <value>
--query-string <value>
[--limit <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]

Параметры

--query-language (строка)

Укажите язык запросов, который будет использоваться для этого запроса. Доступные варианты: Logs Insights QL, OpenSearch PPL и OpenSearch SQL. Дополнительную информацию о языках запросов, поддерживаемых CloudWatch Logs, см. в разделе Поддерживаемые языки запросов.

Возможные значения:

CWLI
SQL
PPL

--log-group-name (строка)

Группа журналов, для которой будет выполнен запрос.

Примечание

Операция StartQuery должна включать ровно один из следующих параметров: logGroupName , logGroupNames или logGroupIdentifiers . Исключение составляют запросы, использующие язык запросов OpenSearch Service SQL, где имена групп журналов указываются внутри querystring, а не здесь.

--log-group-names (список)

Список групп журналов, которые будут запрошены. Вы можете включить до 50 групп журналов.

Примечание

(строка)

Синтаксис:

"string" "string" ...

--log-group-identifiers (список)

Список групп журналов для запроса. Вы можете включить до 50 групп журналов.

Вы можете указать их по имени или ARN группы журналов. Если группа журнала, которую вы запрашиваете, находится в другой учетной записи и вы используете учетную запись мониторинга, вы должны указать ARN группы журнала здесь. Определение запроса также должно быть определено в учетной записи мониторинга.

Если вы указываете ARN, используйте формат arn:aws:logs:region:account-id:log-group:log_group_name Не включайте * в конце.

(строка)

Синтаксис:

"string" "string" ...

--start-time (длинное целое число)

Начало временного диапазона для запроса. Диапазон включает указанное начальное время. Указывается как время эпохи, количество секунд с момента January 1, 1970, 00:00:00 UTC.

--end-time (длинное целое число)

Конец временного диапазона для запроса. Диапазон включает указанное конечное время. Указывается как время эпохи, количество секунд с момента January 1, 1970, 00:00:00 UTC.

--query-string (строка)

Строка запроса для использования. Дополнительную информацию см. в разделе Синтаксис запросов CloudWatch Logs Insights.

--limit (целое число)

Максимальное количество событий журнала, которые нужно вернуть в запросе. Если строка запроса использует команду fields, возвращаются только указанные поля и их значения. По умолчанию - 10 000.

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

Вывод

queryId -> (строка)

Уникальный идентификатор запроса.