Spec-Zone.ru › AWS CLI v2

[ aws . logs ]

put-log-events

Описание

Загружает пакет событий журналов в указанную стрим журнала.

Предупреждение

Маркер последовательности теперь игнорируется в действиях PutLogEvents. Действия PutLogEvents всегда принимаются и никогда не возвращают InvalidSequenceTokenException или DataAlreadyAcceptedException, даже если маркер последовательности недействителен. Вы можете использовать параллельные действия PutLogEvents на одной и той же стриме журнала.

Пакет событий должен удовлетворять следующим ограничениям:

  • Максимальный размер пакета — 1 048 576 байт. Этот размер вычисляется как сумма всех сообщений событий в формате UTF-8 плюс 26 байт для каждого события журнала.
  • Ни одно из событий журнала в пакете не может быть более чем на 2 часа в будущем.
  • Ни одно из событий журнала в пакете не может быть более чем на 14 дней в прошлом. Также ни одно из событий не может быть раньше периода хранения группы журналов.
  • События журнала в пакете должны быть упорядочены по времени в хронологическом порядке. Время — это время возникновения события, выраженное в количестве миллисекунд после Jan 1, 1970 00:00:00 UTC. (В инструментах Amazon Web Services для PowerShell и SDK Amazon Web Services для .NET время указывается в формате .NET: yyyy-mm-ddThh:mm:ss. Например, 2017-09-15T13:45:30.)
  • Пакет событий журнала в одном запросе не может охватывать более 24 часов. В противном случае операция завершается ошибкой.
  • Каждое событие журнала может быть не больше 1 МБ.
  • Максимальное количество событий журнала в пакете — 10 000.

Предупреждение

Квота в пять запросов в секунду на стрим журнала была удалена. Вместо этого действия PutLogEvents ограничиваются квотой на секунду на аккаунт. Вы можете запросить увеличение квоты на ограничение в секунду с помощью сервиса Service Quotas.

Если вызов PutLogEvents возвращает «UnrecognizedClientException», наиболее вероятной причиной является недействительный идентификатор ключа доступа Amazon Web Services или секретный ключ.

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

Синтаксис

  put-log-events
--log-group-name <value>
--log-stream-name <value>
--log-events <value>
[--sequence-token <value>]
[--entity <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]

Параметры

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

Имя группы журналов.

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

Имя стрима журнала.

--log-events (список)

События журнала.

(структура)

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

timestamp -> (длинное целое число)

Время возникновения события, выраженное в количестве миллисекунд после Jan 1, 1970 00:00:00 UTC.

message -> (строка)

Исходное сообщение события. Каждое событие журнала может быть не больше 1 МБ.

Сокращенный синтаксис:

timestamp=long,message=string ...

Синтаксис JSON:

[
  {
    "timestamp": long,
    "message": "string"
  }
  ...
]

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

Маркер последовательности, полученный из ответа предыдущего вызова PutLogEvents.

Предупреждение

Параметр sequenceToken теперь игнорируется в действиях PutLogEvents. Действия PutLogEvents теперь принимаются и никогда не возвращают InvalidSequenceTokenException или DataAlreadyAcceptedException, даже если маркер последовательности недействителен.

--entity (структура)

Сущность, связанная с событиями журнала.

keyAttributes -> (карта)

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

Разрешено пять атрибутов (имена ключей): Type , ResourceType , Identifier Name и Environment.

Подробности о том, как использовать атрибуты ключей, см. в разделе Как добавить связанную информацию в телеметрию в Руководстве пользователя CloudWatch.

key -> (строка)

value -> (строка)

attributes -> (карта)

Дополнительные атрибуты сущности, которые не используются для указания идентичности сущности. Список пар «ключ-значение».

Подробности о том, как использовать атрибуты, см. в разделе Как добавить связанную информацию в телеметрию в Руководстве пользователя CloudWatch.

key -> (строка)

value -> (строка)

Сокращенный синтаксис:

keyAttributes={KeyName1=string,KeyName2=string},attributes={KeyName1=string,KeyName2=string}

Синтаксис JSON:

{
  "keyAttributes": {"string": "string"
    ...},
  "attributes": {"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-auto-prompt (логическое значение)

Автоматически запрашивать параметры CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запросы параметров CLI.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в Руководстве пользователя AWS CLI.

Если не указано иное, во всех примерах используются правила цитирования, аналогичные правилам Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной программы. Подробности см. в разделе Использование кавычек со строками в Руководстве пользователя AWS CLI.

Следующая команда помещает события журнала в стрим журнала с именем 20150601 в группе журналов my-logs:

aws logs put-log-events --log-group-name my-logs --log-stream-name 20150601 --log-events file://events

Вывод:

{
    "nextSequenceToken": "49542672486831074009579604567656788214806863282469607346"
}

В приведенном выше примере считывается массив JSON событий из файла с именем events в текущем каталоге:

[
  {
    "timestamp": 1433190184356,
    "message": "Example Event 1"
  },
  {
    "timestamp": 1433190184358,
    "message": "Example Event 2"
  },
  {
    "timestamp": 1433190184360,
    "message": "Example Event 3"
  }
]

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

aws logs put-log-events --log-group-name my-logs --log-stream-name 20150601 --log-events file://events2 --sequence-token "49542672486831074009579604567656788214806863282469607346"

Вывод:

{
    "nextSequenceToken": "49542672486831074009579604567900991230369019956308219826"
}

Вывод

nextSequenceToken -> (строка)

Следующий маркер последовательности.

Предупреждение

Это поле устарело.

Маркер последовательности теперь игнорируется в действиях PutLogEvents. Действия PutLogEvents всегда принимаются, даже если маркер последовательности недействителен. Вы можете использовать параллельные действия PutLogEvents в одном и том же потоке журнала, и вам не нужно ждать ответа предыдущего действия PutLogEvents, чтобы получить значение nextSequenceToken.

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

Отклоненные события.

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

Индекс первого события журнала, которое слишком новое. Это поле включительно.

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

Индекс последнего события журнала, которое слишком старое. Это поле исключающее.

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

Истекшие события журнала.

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

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

Примечание

Когда сущность отклоняется, события все еще могут быть приняты.

errorType -> (строка)

Тип ошибки, которая привела к отклонению сущности при вызове PutLogEvents.

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

Spec-Zone.ru

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