Spec-Zone.ru › AWS CLI v2

[ aws . xray ]

get-retrieved-traces-graph

Описание

Получает график сервисов для трассировок на основе указанного RetrievalToken из группы журналов CloudWatch, сгенерированной поиском транзакций. Этот API не запускает задачу извлечения. Сначала необходимо выполнить StartTraceRetrieval, чтобы получить необходимые RetrievalToken.

График трассировки описывает сервисы, которые обрабатывают входящие запросы и любые сервисы нижнего уровня, которые они вызывают, что может включать ресурсы Amazon Web Services, внешние API или базы данных.

Ответ пуст до тех пор, пока RetrievalStatus не станет COMPLETE. Повторите запрос после изменения статуса с RUNNING или SCHEDULED на COMPLETE, чтобы получить полный график сервисов.

При использовании CloudWatch в качестве назначения этот API может поддерживать межсчётную наблюдаемость и извлечение графиков сервисов в связанных счетах.

Для получения графиков непосредственно из X-Ray, а не из группы журналов Transaction-Search, см. GetTraceGraph.

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

Синтаксис

  get-retrieved-traces-graph
--retrieval-token <value>
[--next-token <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]

Параметры

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

Маркер извлечения.

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

Укажите маркер постраничной навигации, возвращённый предыдущим запросом для получения следующей страницы индексов.

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

Вывод

RetrievalStatus -> (строка)

Статус извлечения.

Services -> (список)

Извлеченные сервисы.

(структура)

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

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

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

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

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

Name -> (строка)

Каноническое имя сервиса.

Names -> (список)

Список имён сервиса, включая каноническое имя.

(строка)

Root -> (логическое значение)

Указывает, что сервис был первым сервисом, обработтавшим запрос.

AccountId -> (строка)

Идентификатор учетной записи Amazon Web Services, в которой работает сервис.

Type -> (строка)

Тип сервиса.

  • Amazon Web Services Resource - Тип ресурса Amazon Web Services. Например, AWS::EC2::Instance для приложения, выполняющегося на Amazon EC2, или AWS::DynamoDB::Table для таблицы Amazon DynamoDB, которую использовало приложение.
  • Amazon Web Services Service - Тип сервиса Amazon Web Services. Например, AWS::DynamoDB для вызовов дочерних сервисов Amazon DynamoDB, которые не были нацелены на конкретную таблицу.
  • client - Представляет клиентов, которые отправляли запросы к корневому сервису.
  • remote - Дочерний сервис неопределённого типа.

State -> (строка)

Состояние сервиса.

StartTime -> (метка времени)

Время начала первого сегмента, сгенерированного сервисом.

EndTime -> (метка времени)

Время окончания последнего сегмента, сгенерированного сервисом.

Edges -> (список)

Соединения с дочерними сервисами.

(структура)

Информация о соединении между двумя сервисами. Связь может быть синхронной, например, типичный вызов между клиентом и сервисом, или асинхронной, например, функция Lambda, которая извлекает событие из очереди SNS.

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

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

StartTime -> (метка времени)

Время начала первого сегмента на связи.

EndTime -> (метка времени)

Время окончания последнего сегмента на связи.

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

Статистические данные ответов для сегментов на связи.

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

Количество запросов, завершенных со статусом 2xx (Успех).

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

Информация о запросах, завершившихся со статусом 4xx (Ошибка клиента).

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

Количество запросов, завершившихся со статусом 429 (ограничение).

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

Количество запросов, завершившихся с другими кодами ошибок 4xx (Ошибка клиента).

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

Общее количество запросов, завершившихся с кодами ошибок 4xx (Ошибка клиента).

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

Информация о запросах, завершившихся со статусом 5xx (Ошибка сервера).

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

Количество запросов, завершившихся с другими кодами ошибок 5xx (Ошибка сервера).

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

Общее количество запросов, завершившихся с кодами ошибок 5xx (Ошибка сервера).

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

Общее количество завершенных запросов.

TotalResponseTime -> (двойное число)

Среднее время ответа завершенных запросов.

ResponseTimeHistogram -> (список)

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

(структура)

Элемент гистограммы для статистики. Гистограмма отображает диапазон наблюдаемых значений по оси X и частоту каждого значения по оси Y.

Value -> (двойное число)

Значение элемента.

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

Частота элемента.

Aliases -> (список)

Псевдонимы связи.

(структура)

Псевдоним связи.

Name -> (строка)

Каноническое имя псевдонима.

Names -> (список)

Список имён псевдонима, включая каноническое имя.

(строка)

Type -> (строка)

Тип псевдонима.

EdgeType -> (строка)

Описывает асинхронное соединение со значением link.

ReceivedEventAgeHistogram -> (список)

Гистограмма, отображающая распределение возраста события при получении потребителями. Возраст вычисляется каждый раз при получении события. Заполняется только при EdgeType является link.

(структура)

Элемент гистограммы для статистики. Гистограмма отображает диапазон наблюдаемых значений по оси X и частоту каждого значения по оси Y.

Value -> (двойное число)

Значение элемента.

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

Частота элемента.

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

Агрегированные статистические данные для сервиса.

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

Количество запросов, завершенных со статусом 2xx (Успех).

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

Информация о запросах, завершившихся со статусом 4xx (Ошибка клиента).

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

Количество запросов, завершившихся со статусом 429 (ограничение).

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

Количество запросов, завершившихся с другими кодами ошибок 4xx (Ошибка клиента).

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

Общее количество запросов, завершившихся с кодами ошибок 4xx (Ошибка клиента).

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

Информация о запросах, завершившихся со статусом 5xx (Ошибка сервера).

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

Количество запросов, завершившихся с другими кодами ошибок 5xx (Ошибка сервера).

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

Общее количество запросов, завершившихся с кодами ошибок 5xx (Ошибка сервера).

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

Общее количество завершенных запросов.

TotalResponseTime -> (двойное число)

Среднее время ответа завершенных запросов.

DurationHistogram -> (список)

Гистограмма, отображающая распределение длительностей работы сервиса.

(структура)

Элемент гистограммы для статистики. Гистограмма отображает диапазон наблюдаемых значений по оси X и частоту каждого значения по оси Y.

Value -> (двойное число)

Значение элемента.

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

Частота элемента.

ResponseTimeHistogram -> (список)

Гистограмма, отображающая распределение времени ответа сервиса.

(структура)

Элемент гистограммы для статистики. Гистограмма отображает диапазон наблюдаемых значений по оси X и частоту каждого значения по оси Y.

Value -> (двойное число)

Значение элемента.

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

Частота элемента.

Links -> (список)

Связь между двумя сервисами.

(структура)

Связь между двумя сервисами.

ReferenceType -> (строка)

Связь трассировки с соответствующим сервисом.

SourceTraceId -> (строка)

Исходная трассировка связи.

DestinationTraceIds -> (список)

Целевые трассировки связи.

(строка)

NextToken -> (строка)

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

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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