Spec-Zone.ru › AWS CLI v2

[ aws . xray ]

изменение-правила-выборки

Описание

Изменяет конфигурацию правила выборки.

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

Синтаксис

  update-sampling-rule
--sampling-rule-update <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-rule-update (структура)

Правило и поля для изменения.

RuleName -> (строка)

Имя правила выборки. Укажите правило по имени или ARN, но не по обоим.

RuleARN -> (строка)

ARN правила выборки. Укажите правило по имени или ARN, но не по обоим.

ResourceARN -> (строка)

Сопоставляется с ARN ресурса Amazon Web Services, на котором работает служба.

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

Приоритет правила выборки.

FixedRate -> (дробное число)

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

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

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

Host -> (строка)

Сопоставляется с именем хоста из URL-адреса запроса.

ServiceName -> (строка)

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

ServiceType -> (строка)

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

HTTPMethod -> (строка)

Сопоставляется с методом HTTP запроса.

URLPath -> (строка)

Сопоставляется с путем из URL-адреса запроса.

Attributes -> (массив)

Сопоставляется с атрибутами, полученными из запроса.

key -> (строка)

value -> (строка)

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

RuleName=string,RuleARN=string,ResourceARN=string,Priority=integer,FixedRate=double,ReservoirSize=integer,Host=string,ServiceName=string,ServiceType=string,HTTPMethod=string,URLPath=string,Attributes={KeyName1=string,KeyName2=string}

Синтаксис JSON:

{
  "RuleName": "string",
  "RuleARN": "string",
  "ResourceARN": "string",
  "Priority": integer,
  "FixedRate": double,
  "ReservoirSize": integer,
  "Host": "string",
  "ServiceName": "string",
  "ServiceType": "string",
  "HTTPMethod": "string",
  "URLPath": "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.

Для обновления правила выборки

Следующий update-sampling-rule пример изменяет конфигурацию правила выборки. Правила потребляются из файла JSON. Требуются только изменяемые поля.

aws xray update-sampling-rule \
   --cli-input-json file://1000-default.json

Содержимое 1000-default.json:

{
    "SamplingRuleUpdate": {
        "RuleName": "Default",
        "FixedRate": 0.01,
        "ReservoirSize": 0
    }
}

Вывод:

{
    "SamplingRuleRecords": [
        {
            "SamplingRule": {
                "RuleName": "Default",
                "RuleARN": "arn:aws:xray:us-west-2:123456789012:sampling-rule/Default",
                "ResourceARN": "*",
                "Priority": 10000,
                "FixedRate": 0.01,
                "ReservoirSize": 0,
                "ServiceName": "*",
                "ServiceType": "*",
                "Host": "*",
                "HTTPMethod": "*",
                "URLPath": "*",
                "Version": 1,
                "Attributes": {}
            },
            "CreatedAt": 0.0,
            "ModifiedAt": 1529959993.0
        }
   ]
}

Дополнительная информация доступна в разделе «Настройка параметров выборки, групп и шифрования с помощью API AWS X-Ray» в «Руководстве разработчика AWS X-Ray».

Вывод

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

Обновленное определение и метаданные правила.

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

Правило выборки.

RuleName -> (строка)

Имя правила выборки. Укажите правило по имени или ARN, но не по обоим.

RuleARN -> (строка)

ARN правила выборки. Укажите правило по имени или ARN, но не по обоим.

ResourceARN -> (строка)

Сопоставляется с ARN ресурса Amazon Web Services, на котором работает служба.

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

Приоритет правила выборки.

FixedRate -> (дробное число)

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

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

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

ServiceName -> (строка)

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

ServiceType -> (строка)

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

Host -> (строка)

Сопоставляется с именем хоста из URL-адреса запроса.

HTTPMethod -> (строка)

Сопоставляется с методом HTTP запроса.

URLPath -> (строка)

Сопоставляется с путем из URL-адреса запроса.

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

Версия формата правила выборки (1).

Attributes -> (массив)

Сопоставляется с атрибутами, полученными из запроса.

key -> (строка)

value -> (строка)

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

Когда правило было создано.

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

Когда правило было в последний раз изменено.

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

Spec-Zone.ru

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