Spec-Zone.ru › AWS CLI v2

[ aws . ec2 ]

get-aws-network-performance-data

Описание

Получает данные о производительности сети.

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

get-aws-network-performance-data является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько API-вызовов. Вы можете отключить постраничность, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничностью, аргумент --query должен извлекать данные из результатов следующих выражений запроса: DataResponses

Синтаксис

  get-aws-network-performance-data
[--data-queries <value>]
[--start-time <value>]
[--end-time <value>]
[--dry-run | --no-dry-run]
[--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]

Параметры

--data-queries (список)

Список запросов к данным о производительности сети.

(структура)

Запрос для получения данных о состоянии сети.

Id -> (строка)

Определяемый пользователем идентификатор, связанный с запросом данных, который возвращается в dataResponse, идентифицирующем запрос. Например, если вы установите Id в MyQuery01 в запросе, dataResponse идентифицирует запрос как MyQuery01.

Source -> (строка)

Регион или зона доступности, являющиеся источником для запроса данных. Например, us-east-1.

Destination -> (строка)

Регион или зона доступности, являющиеся целью для запроса данных. Например, eu-north-1.

Metric -> (строка)

Метрика, используемая для запроса производительности сети.

Statistic -> (строка)

Период агрегирования данных метрики, p50, между указанными startDate и endDate. Например, метрика five_minutes — это медиана всех точек данных, собранных в течение этих пяти минут. p50 — единственная поддерживаемая метрика.

Period -> (строка)

Период агрегирования, используемый для запроса данных.

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

Id=string,Source=string,Destination=string,Metric=string,Statistic=string,Period=string ...

Синтаксис JSON:

[
  {
    "Id": "string",
    "Source": "string",
    "Destination": "string",
    "Metric": "aggregate-latency",
    "Statistic": "p50",
    "Period": "five-minutes"|"fifteen-minutes"|"one-hour"|"three-hours"|"one-day"|"one-week"
  }
  ...
]

--start-time (метка времени)

Начальная точка времени для запроса данных о производительности. Время начала должно быть отформатировано как yyyy-mm-ddThh:mm:ss. Например, 2022-06-10T12:00:00.000Z.

--end-time (метка времени)

Конечная точка времени для запроса данных о производительности. Время окончания должно быть отформатировано как yyyy-mm-ddThh:mm:ss. Например, 2022-06-12T12:00:00.000Z.

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

Проверяет, есть ли у вас необходимые разрешения для действия, не выполняя фактический запрос, и предоставляет ответ об ошибке. Если у вас есть необходимые разрешения, ответ об ошибке — это DryRunOperation. В противном случае — UnauthorizedOperation.

--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-auto-prompt (логическое значение)

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

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

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

Примеры

Примечание

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

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

Получение данных о производительности сети

Следующий пример get-aws-network-performance-data получает данные о производительности сети между указанными регионами в указанный период времени.

aws ec2 get-aws-network-performance-data \
    --start-time 2022-10-26T12:00:00.000Z \
    --end-time 2022-10-26T12:30:00.000Z \
    --data-queries Id=my-query,Source=us-east-1,Destination=eu-west-1,Metric=aggregate-latency,Statistic=p50,Period=five-minutes

Вывод:

{
    "DataResponses": [
        {
            "Id": "my-query",
            "Source": "us-east-1",
            "Destination": "eu-west-1",
            "Metric": "aggregate-latency",
            "Statistic": "p50",
            "Period": "five-minutes",
            "MetricPoints": [
                {
                    "StartDate": "2022-10-26T12:00:00+00:00",
                    "EndDate": "2022-10-26T12:05:00+00:00",
                    "Value": 62.44349,
                    "Status": "OK"
                },
                {
                    "StartDate": "2022-10-26T12:05:00+00:00",
                    "EndDate": "2022-10-26T12:10:00+00:00",
                    "Value": 62.483498,
                    "Status": "OK"
                },
                {
                    "StartDate": "2022-10-26T12:10:00+00:00",
                    "EndDate": "2022-10-26T12:15:00+00:00",
                    "Value": 62.51248,
                    "Status": "OK"
                },
                {
                    "StartDate": "2022-10-26T12:15:00+00:00",
                    "EndDate": "2022-10-26T12:20:00+00:00",
                    "Value": 62.635475,
                    "Status": "OK"
                },
                {
                    "StartDate": "2022-10-26T12:20:00+00:00",
                    "EndDate": "2022-10-26T12:25:00+00:00",
                    "Value": 62.733974,
                    "Status": "OK"
                },
                {
                    "StartDate": "2022-10-26T12:25:00+00:00",
                    "EndDate": "2022-10-26T12:30:00+00:00",
                    "Value": 62.773975,
                    "Status": "OK"
                },
                {
                    "StartDate": "2022-10-26T12:30:00+00:00",
                    "EndDate": "2022-10-26T12:35:00+00:00",
                    "Value": 62.75349,
                    "Status": "OK"
                }
            ]
        }
    ]
}

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

Вывод

DataResponses -> (список)

Список ответов данных.

(структура)

Ответ на DataQuery.

Id -> (строка)

Идентификатор, переданный в DataQuery.

Source -> (строка)

Регион или зона доступности, являющиеся источником для запроса данных. Например, us-east-1.

Destination -> (строка)

Регион или зона доступности, являющиеся целью для запроса данных. Например, eu-west-1.

Metric -> (строка)

Метрика, используемая для запроса производительности сети.

Statistic -> (строка)

Статистика, используемая для запроса производительности сети.

Period -> (строка)

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

MetricPoints -> (список)

Список объектов MetricPoint.

(структура)

Указывает, была ли сеть работоспособной или неисправной в определенный момент. Значение агрегируется из startDate в endDate. В настоящее время поддерживается только five_minutes.

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

Дата начала точки метрики. Дата начала точки метрики. Время начала должно быть отформатировано как yyyy-mm-ddThh:mm:ss. Например, 2022-06-10T12:00:00.000Z.

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

Дата окончания точки метрики. Время окончания должно быть отформатировано как yyyy-mm-ddThh:mm:ss. Например, 2022-06-12T12:00:00.000Z.

Value -> (вещественное число)

Status -> (строка)

Статус точки метрики.

NextToken -> (строка)

Токен для получения следующей страницы результатов. Это значение null, когда больше результатов не возвращается.

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

Spec-Zone.ru

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