Spec-Zone.ru › AWS CLI v2

[ aws . logs ]

describe-log-streams

Описание

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

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

Данная операция имеет ограничение в 25 транзакций в секунду, после чего транзакции будут ограничены.

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

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

describe-log-streams — это постраничная операция. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничный вывод, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничным выводом, аргумент --query должен извлекать данные из результатов следующих выражений запроса: logStreams

Синтаксис

  describe-log-streams
[--log-group-name <value>]
[--log-group-identifier <value>]
[--log-stream-name-prefix <value>]
[--order-by <value>]
[--descending | --no-descending]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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 (строка)

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

Примечание

Вы должны указать либо logGroupIdentifier, либо logGroupName, но не оба.

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

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

Примечание

Вы должны указать либо logGroupIdentifier, либо logGroupName, но не оба.

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

Префикс для сопоставления.

Если orderBy является LastEventTime, этот параметр нельзя указать.

--order-by (строка)

Если значение равно LogStreamName, результаты упорядочиваются по имени потока лога. Если значение равно LastEventTime, результаты упорядочиваются по времени события. Значение по умолчанию — LogStreamName.

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

lastEventTimestamp представляет время последнего события лога в потоке лога в CloudWatch Logs. Это число выражается в миллисекундах после Jan 1, 1970 00:00:00 UTC. lastEventTimestamp обновляется на основе несинхронной согласованности. Обычно он обновляется менее чем за час с момента поступления, но в редких случаях может занимать больше времени.

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

  • LogStreamName
  • LastEventTime

--descending | --no-descending (логическое значение)

Если значение равно true, результаты возвращаются в обратном порядке. Если значение равно false, результаты возвращаются в прямом порядке. Значение по умолчанию — false.

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

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

Токен для указания места начала постраничного вывода. Это NextToken из ранее урезанного ответа.

Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

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

Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS Command Line Interface.

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

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Для возобновления постраничного вывода предоставьте значение NextToken в аргументе starting-token последующей команды. **Не** используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS Command Line Interface.

--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
  • table
  • yaml
  • yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

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

Следующая команда показывает все потоки логов, начинающиеся с префикса 2015 в группе логов my-logs:

aws logs describe-log-streams --log-group-name my-logs --log-stream-name-prefix 2015

Вывод:

{
    "logStreams": [
        {
            "creationTime": 1433189871774,
            "arn": "arn:aws:logs:us-west-2:0123456789012:log-group:my-logs:log-stream:20150531",
            "logStreamName": "20150531",
            "storedBytes": 0
        },
        {
            "creationTime": 1433189873898,
            "arn": "arn:aws:logs:us-west-2:0123456789012:log-group:my-logs:log-stream:20150601",
            "logStreamName": "20150601",
            "storedBytes": 0
        }
    ]
}

Вывод

logStreams -> (список)

Потоки журналов.

(структура)

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

logStreamName -> (строка)

Имя потока журнала.

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

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

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

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

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

Время последнего события журнала в потоке журнала в CloudWatch Logs. Это число выражается в миллисекундах после Jan 1, 1970 00:00:00 UTC . Значение lastEventTime обновляется по принципу конечной согласованности. Как правило, обновление происходит в течение часа после загрузки, но в редких случаях может занять больше времени.

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

Время загрузки, выраженное в миллисекундах после Jan 1, 1970 00:00:00 UTC. Значение lastIngestionTime обновляется по принципу конечной согласованности. Как правило, обновление происходит в течение часа после загрузки, но в редких случаях может занять больше времени.

uploadSequenceToken -> (строка)

Маркер последовательности.

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

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

arn -> (строка)

Amazon Resource Name (ARN) потока журнала.

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

Количество сохранённых байтов.

Важно: Начиная с 17 июня 2019 года, этот параметр больше не поддерживается для потоков журналов и всегда сообщается как ноль. Это изменение относится только к потокам журналов. Параметр storedBytes для групп журналов не затронут.

nextToken -> (строка)

Маркер для следующего набора элементов для возврата. Маркер действует 24 часа.

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

Spec-Zone.ru

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