Spec-Zone.ru › AWS CLI v2

[ aws . meteringmarketplace ]

batch-meter-usage

Описание

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

Параметр CustomerIdentifier запланирован к устареванию. Используйте CustomerAWSAccountID вместо него.

Эти параметры взаимоисключающие. Вы не можете указать и CustomerIdentifier, и CustomerAWSAccountID в одном запросе.

Для отправки данных об измерении для клиентов, SaaS-приложения вызывают BatchMeterUsage, которое используется для измерения гибкой ценовой модели потребления SaaS (FCP). Идентичные запросы идемпотентны и могут быть повторены с теми же данными или подмножеством данных. Каждый запрос BatchMeterUsage предназначен только для одного продукта. Если вы хотите измерить использование для нескольких продуктов, необходимо выполнить несколько вызовов BatchMeterUsage.

Записи об использовании следует отправлять вскоре после зафиксированного события. Записи об использовании не принимаются через 6 часов и более после события.

BatchMeterUsage может обработать до 25 UsageRecords за раз, и каждый запрос должен быть меньше 1 МБ. По желанию вы можете иметь несколько распределений использования для данных об использовании, разделенных на корзины в соответствии с предварительно определенными тегами.

BatchMeterUsage возвращает список объектов UsageRecordResult, каждый из которых содержит UsageRecord. Он также возвращает список UnprocessedRecords, указывающий на ошибки на стороне сервиса, которые следует повторить.

Для регионов Amazon Web Services, поддерживающих BatchMeterUsage, см. Поддержка регионов BatchMeterUsage.

Примечание

Пример использования BatchMeterUsage см. в примере кода BatchMeterUsage в Руководстве для продавцов Amazon Web Services Marketplace.

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

Синтаксис

  batch-meter-usage
--usage-records <value>
--product-code <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]

Параметры

--usage-records (список)

Набор UsageRecords для отправки. BatchMeterUsage принимает до 25 UsageRecords за раз.

(структура)

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

Несколько запросов с одинаковым UsageRecords в качестве входных данных будут объединены, чтобы предотвратить двойное взимание.

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

Метка времени в формате UTC, для которой сообщается использование.

Ваше приложение может измерить использование до одного часа в прошлом. Убедитесь, что значение timestamp не находится до начала использования программного обеспечения.

CustomerIdentifier -> (строка)

CustomerIdentifier получаются с помощью операции ResolveCustomer и представляют собой отдельного покупателя в вашем приложении.

Dimension -> (строка)

При регистрации продукта в Amazon Web Services Marketplace задаются измерения. Они представляют собой различные единицы значения в вашем приложении.

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

Количество использования, потребленного клиентом для данного измерения и времени. По умолчанию равно 0, если не указано иное.

UsageAllocations -> (список)

Набор UsageAllocations для отправки. Сумма всех UsageAllocation должна быть равна значению Quantity UsageRecord.

(структура)

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

Каждое UsageAllocation указывает количество использования для конкретного набора тегов.

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

Общее количество, выделенное для этой корзины использования.

Tags -> (список)

Набор тегов, определяющих корзину использования. Для корзины элементов без тегов этот параметр можно опустить.

(структура)

Метаданные, назначенные распределению. Каждый тег состоит из key и value.

Key -> (строка)

Одна часть пары «ключ-значение», составляющей tag. key — это метка, которая действует как категория для определенных значений тегов.

Value -> (строка)

Одна часть пары «ключ-значение», составляющей tag. value действует как описатель в категории тегов (ключ). Значение может быть пустым или нулевым.

CustomerAWSAccountId -> (строка)

Параметр CustomerAWSAccountID указывает идентификатор учетной записи AWS покупателя.

Синтаксис JSON:

[
  {
    "Timestamp": timestamp,
    "CustomerIdentifier": "string",
    "Dimension": "string",
    "Quantity": integer,
    "UsageAllocations": [
      {
        "AllocatedUsageQuantity": integer,
        "Tags": [
          {
            "Key": "string",
            "Value": "string"
          }
          ...
        ]
      }
      ...
    ],
    "CustomerAWSAccountId": "string"
  }
  ...
]

--product-code (строка)

Код продукта используется для уникальной идентификации продукта в Amazon Web Services Marketplace. Код продукта должен быть таким же, как и код, используемый при публикации нового продукта.

--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 для вывода.

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

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

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

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

Вывод

Результаты -> (список)

Содержит все UsageRecords, обработанные BatchMeterUsage. Эти записи были приняты службой измерения расхода Amazon Web Services Marketplace или были неверными. Неверные записи следует исправить перед повторной отправкой.

(структура)

UsageRecordResult указывает состояние заданной UsageRecord, обработанной BatchMeterUsage.

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

UsageRecord, которая была частью запроса BatchMeterUsage.

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

Метка времени в формате UTC, для которой сообщается использование.

Ваше приложение может измерять использование за последние один час. Убедитесь, что значение timestamp не предшествует началу использования программного обеспечения.

CustomerIdentifier -> (строка)

CustomerIdentifier получается с помощью операции ResolveCustomer и представляет собой отдельного покупателя в вашем приложении.

Dimension -> (строка)

При регистрации продукта на Amazon Web Services Marketplace указываются размеры. Они представляют собой разные единицы измерения в вашем приложении.

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

Количество использования, потребленное клиентом для заданного измерения и времени. По умолчанию устанавливается в значение 0, если не указано иное.

UsageAllocations -> (список)

Набор UsageAllocations для отправки. Сумма всех UsageAllocation количеств должна быть равна количеству UsageRecord.

(структура)

Распределения использования позволяют разделить использование по меткам.

Каждая UsageAllocation указывает количество использования для определенного набора меток.

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

Общее количество, выделенное для этого объема использования.

Tags -> (список)

Набор меток, определяющих объем использования. Для объема элементов без меток этот параметр можно опустить.

(структура)

Метаданные, назначенные распределению. Каждая метка состоит из key и value.

Key -> (строка)

Одна часть пары «ключ-значение», составляющей tag. key — это метка, которая действует как категория для конкретных значений меток.

Value -> (строка)

Одна часть пары «ключ-значение», составляющей tag. value выступает в качестве описателя в категории меток (ключ). Значение может быть пустым или нулевым.

CustomerAWSAccountId -> (строка)

Параметр CustomerAWSAccountID указывает идентификатор учетной записи AWS покупателя.

MeteringRecordId -> (строка)

MeteringRecordId — это уникальный идентификатор этого события измерения.

Status -> (строка)

UsageRecordResult Status указывает статус индивидуальной UsageRecord, обработанной BatchMeterUsage.

  • Успешно — UsageRecord был принят и обработан BatchMeterUsage.
  • Подписка клиента отсутствует — указанный CustomerIdentifier не может использовать ваш продукт. UsageRecord не была принята. Существует три причины такого результата:
    • Идентификатор клиента недействителен.
    • У идентификатора клиента, предоставленного в записи измерения, нет активного соглашения или подписки на этот продукт. Будущие UsageRecords для этого клиента будут неудачными, пока клиент не подпишется на ваш продукт.
    • Учетная запись Amazon Web Services клиента была приостановлена.
  • Дублирующая запись — указывает, что UsageRecord была недействительной и не была принята. У ранее измеренной UsageRecord был тот же клиент, измерение и время, но другое количество.

UnprocessedRecords -> (список)

Содержит все UsageRecords, которые не были обработаны BatchMeterUsage. Это список UsageRecords. Вы можете повторить неудачный запрос, выполнив другой вызов BatchMeterUsage с этим списком в качестве входных данных в BatchMeterUsageRequest.

(структура)

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

Несколько запросов с тем же UsageRecords в качестве входных данных будут дедублированы для предотвращения двойного счета.

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

Метка времени в формате UTC, для которой сообщается использование.

Ваше приложение может измерять использование за последние один час. Убедитесь, что значение timestamp не предшествует началу использования программного обеспечения.

CustomerIdentifier -> (строка)

CustomerIdentifier получается с помощью операции ResolveCustomer и представляет собой отдельного покупателя в вашем приложении.

Dimension -> (строка)

При регистрации продукта на Amazon Web Services Marketplace указываются размеры. Они представляют собой разные единицы измерения в вашем приложении.

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

Количество использования, потребленное клиентом для заданного измерения и времени. По умолчанию устанавливается в значение 0, если не указано иное.

UsageAllocations -> (список)

Набор UsageAllocations для отправки. Сумма всех UsageAllocation количеств должна быть равна количеству UsageRecord.

(структура)

Распределения использования позволяют разделить использование по меткам.

Каждая UsageAllocation указывает количество использования для определенного набора меток.

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

Общее количество, выделенное для этого объема использования.

Tags -> (список)

Набор меток, определяющих объем использования. Для объема элементов без меток этот параметр можно опустить.

(структура)

Метаданные, назначенные распределению. Каждая метка состоит из key и value.

Key -> (строка)

Одна часть пары «ключ-значение», составляющей tag. key — это метка, которая действует как категория для конкретных значений меток.

Value -> (строка)

Одна часть пары «ключ-значение», составляющей tag. value выступает в качестве описателя в категории меток (ключ). Значение может быть пустым или нулевым.

CustomerAWSAccountId -> (строка)

Параметр CustomerAWSAccountID указывает идентификатор учетной записи AWS покупателя.

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

Spec-Zone.ru

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