Spec-Zone.ru › AWS CLI v2

[ aws . xray ]

получение-целей-выборки

Описание

Запрашивает квоту выборки для правил, которые служба использует для выборки запросов.

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

Синтаксис

  get-sampling-targets
--sampling-statistics-documents <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]

Параметры

--sampling-statistics-documents (список)

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

(структура)

Результаты выборки запросов для одного правила от службы. Результаты действительны для последних 10 секунд, если службе не был назначен более длительный интервал отчёта после предыдущего вызова GetSamplingTargets.

RuleName -> (строка)

Имя правила выборки.

ClientID -> (строка)

Уникальный идентификатор службы в шестнадцатеричном формате.

Timestamp -> (временная метка)

Текущее время.

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

Количество запросов, соответствующих правилу.

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

Количество зарегистрированных запросов.

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

Количество запросов, зарегистрированных с заимствованной квотой резервуара.

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

RuleName=string,ClientID=string,Timestamp=timestamp,RequestCount=integer,SampledCount=integer,BorrowCount=integer ...

Синтаксис JSON:

[
  {
    "RuleName": "string",
    "ClientID": "string",
    "Timestamp": timestamp,
    "RequestCount": integer,
    "SampledCount": integer,
    "BorrowCount": integer
  }
  ...
]

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

Примеры

Примечание

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

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

Запрос квоты выборки

Следующий get-sampling-targets пример запрашивает квоту выборки для правил, которые служба использует для выборки запросов. Ответ от AWS X-Ray включает квоту, которую можно использовать вместо взятия из резервуара.

aws xray get-sampling-targets \
    --sampling-statistics-documents '[ { "RuleName": "base-scorekeep", "ClientID": "ABCDEF1234567890ABCDEF10", "Timestamp": "2018-07-07T00:20:06, "RequestCount": 110, "SampledCount": 20, "BorrowCount": 10 }, { "RuleName": "polling-scorekeep", 31, "BorrowCount": 0 } ]'

Вывод:

{
    "SamplingTargetDocuments": [
        {
            "RuleName": "base-scorekeep",
            "FixedRate": 0.1,
            "ReservoirQuota": 2,
            "ReservoirQuotaTTL": 1530923107.0,
            "Interval": 10
        },
        {
            "RuleName": "polling-scorekeep",
            "FixedRate": 0.003,
            "ReservoirQuota": 0,
            "ReservoirQuotaTTL": 1530923107.0,
            "Interval": 10
        }
    ],
    "LastRuleModification": 1530920505.0,
    "UnprocessedStatistics": []
}

Для получения дополнительной информации см. Использование правил выборки с API X-Ray в Руководстве разработчика AWS X-Ray.

Вывод

SamplingTargetDocuments -> (список)

Обновлённые правила, которые служба должна использовать для выборки запросов.

(структура)

Временные изменения в конфигурации правила выборки. Для достижения глобальной цели выборки для правила X-Ray вычисляет новый резервуар для каждой службы, основываясь на недавних результатах выборки всех служб, которые вызвали GetSamplingTargets.

RuleName -> (строка)

Имя правила выборки.

FixedRate -> (двойное)

Процент соответствия запросов для измерения после исчерпания резервуара.

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

Количество запросов в секунду, выделенных X-Ray для этой службы.

ReservoirQuotaTTL -> (временная метка)

Время истечения квоты резервуара.

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

Количество секунд, которое служба должна ждать, прежде чем снова получить цели выборки.

LastRuleModification -> (временная метка)

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

UnprocessedStatistics -> (список)

Информация о SamplingStatisticsDocument, которые X-Ray не смог обработать.

(структура)

Статистика выборки из вызова GetSamplingTargets, которую X-Ray не смог обработать.

RuleName -> (строка)

Имя правила выборки.

ErrorCode -> (строка)

Код ошибки.

Message -> (строка)

Сообщение об ошибке.

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

Spec-Zone.ru

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