Spec-Zone.ru › AWS CLI v2

[ aws . iotsitewise ]

batch-put-asset-property-value

Описание

Отправляет список значений свойств актива в IoT SiteWise. Каждое значение — это данные временной метки-качества-значения (TQV). Дополнительную информацию см. в разделе Ввод данных с помощью API в Руководстве пользователя IoT SiteWise.

Для определения свойства актива необходимо указать одно из следующего:

  • assetId и propertyId свойства актива.
  • propertyAlias, являющийся псевдонимом потока данных (например, /company/windfarm/3/turbine/7/temperature). Чтобы определить псевдоним свойства актива, см. UpdateAssetProperty.

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

IoT SiteWise принимает только TQV с временной меткой не более чем за 7 дней до текущего момента и не более чем через 10 минут. IoT SiteWise отклоняет временные метки, выходящие за пределы диапазона [-7 дней, +10 минут], и возвращает ошибку TimestampOutOfRangeException.

Для каждого свойства актива IoT SiteWise перезаписывает TQV с дублирующими временными метками, если только более новое TQV имеет другое качество. Например, если вы сохранили TQV {T1, GOOD, V1}, то сохранение {T1, GOOD, V2} заменит существующее TQV.

IoT SiteWise авторизует доступ к каждому элементу BatchPutAssetPropertyValue индивидуально. Дополнительную информацию см. в разделе Авторизация BatchPutAssetPropertyValue в Руководстве пользователя IoT SiteWise.

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

Синтаксис

  batch-put-asset-property-value
[--enable-partial-entry-processing | --no-enable-partial-entry-processing]
--entries <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]

Параметры

--enable-partial-entry-processing | --no-enable-partial-entry-processing (boolean)

Этот параметр включает частичный ввод на уровне записи. Если установлен в значение true, мы вводим все TQV, не приводящие к ошибке. Если установлен в значение false, недопустимое TQV приводит к отказу от ввода всей записи, содержащей его.

--entries (список)

Список записей значений свойств актива для запроса пакетного ввода. Вы можете указать до 10 записей в одном запросе.

(структура)

Содержит список обновлений значений для свойства актива в списке записей активов, потребляемых операцией API BatchPutAssetPropertyValue.

entryId -> (строка)

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

assetId -> (строка)

ID актива для обновления.

propertyId -> (строка)

ID свойства актива для этой записи.

propertyAlias -> (строка)

Псевдоним, определяющий свойство, например, путь к потоку данных сервера OPC-UA (например, /company/windfarm/3/turbine/7/temperature). Дополнительную информацию см. в разделе Сопоставление промышленных потоков данных со свойствами активов в Руководстве пользователя IoT SiteWise.

propertyValues -> (список)

Список значений свойств для загрузки. Вы можете указать до 10 элементов массива propertyValues.

(структура)

Содержит информацию о значении свойства актива.

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

Значение свойства актива (см. Variant).

stringValue -> (строка)

Данные свойства актива типа строка (последовательность символов). Разрешённый шаблон: “^$|[^u0000-u001Fu007F]+”. Максимальная длина — 1024.

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

Данные свойства актива типа целое число (целое число).

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

Данные свойства актива типа двойное (число с плавающей запятой). Минимальное значение — -10^10. Максимальное значение — 10^10. Разрешено Double.NaN.

booleanValue -> (boolean)

Данные свойства актива типа Boolean (true или false).

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

Тип данных нулевого свойства актива с качествами BAD и UNCERTAIN.

valueType -> (строка)

Тип данных нулевого свойства актива.

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

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

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

Дата временной метки в секундах в формате эпохи Unix. Дробные данные наносекунд предоставляются offsetInNanos.

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

Смещение в наносекундах от timeInSeconds.

quality -> (строка)

Качество значения свойства актива.

Синтаксис JSON:

[
  {
    "entryId": "string",
    "assetId": "string",
    "propertyId": "string",
    "propertyAlias": "string",
    "propertyValues": [
      {
        "value": {
          "stringValue": "string",
          "integerValue": integer,
          "doubleValue": double,
          "booleanValue": true|false,
          "nullValue": {
            "valueType": "D"|"B"|"S"|"I"|"U"
          }
        },
        "timestamp": {
          "timeInSeconds": long,
          "offsetInNanos": integer
        },
        "quality": "GOOD"|"BAD"|"UNCERTAIN"
      }
      ...
    ]
  }
  ...
]

--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 (boolean)

Включить отладочную запись в журнал.

--endpoint-url (строка)

Переопределить стандартную URL-адресу команды заданной URL-адресой.

--no-verify-ssl (boolean)

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

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования выходных данных команды.

  • json
  • текст
  • таблица
  • yaml
  • yaml-поток

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из файла с вашими учетными данными.

--region (строка)

Используемый регион. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/отключить цветной вывод.

  • включено
  • выключено
  • автоматически

--no-sign-request (boolean)

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

--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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое сопоставляется с двоичным блоком, fileb:// всегда будет обрабатываться как двоичное и использовать содержимое файла напрямую независимо от настроек cli-binary-format. При использовании file:// содержимое файла должно быть правильно отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Отключить пагинатор CLI для вывода.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Примеры

Примечание

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

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

Отправка данных в свойства активов

Следующий пример batch-put-asset-property-value отправляет данные мощности и температуры в свойства активов, определяемые псевдонимами свойств.

aws iotsitewise batch-put-asset-property-value \
    --cli-input-json file://batch-put-asset-property-value.json

Содержимое batch-put-asset-property-value.json:

{
    "entries": [
        {
            "entryId": "1575691200-company-windfarm-3-turbine-7-power",
            "propertyAlias": "company-windfarm-3-turbine-7-power",
            "propertyValues": [
                {
                    "value": {
                        "doubleValue": 4.92
                    },
                    "timestamp": {
                        "timeInSeconds": 1575691200
                    },
                    "quality": "GOOD"
                }
            ]
        },
        {
            "entryId": "1575691200-company-windfarm-3-turbine-7-temperature",
            "propertyAlias": "company-windfarm-3-turbine-7-temperature",
            "propertyValues": [
                {
                    "value": {
                        "integerValue": 38
                    },
                    "timestamp": {
                        "timeInSeconds": 1575691200
                    }
                }
            ]
        }
    ]
}

Вывод:

{
    "errorEntries": []
}

Дополнительную информацию см. в разделе Ввод данных с помощью API AWS IoT SiteWise в Руководстве пользователя AWS IoT SiteWise.

Вывод

errorEntries -> (список)

Список ошибок (если таковые имеются), связанных с запросом пакетного ввода. Каждая запись об ошибке содержит entryId записи, которая не удалась.

(структура)

Содержит сведения об ошибках для записей значений свойств активов, связанных с API BatchPutAssetPropertyValue.

entryId -> (строка)

ID не удавшейся записи.

errors -> (список)

Список ошибок обновления значений свойств.

(структура)

Содержит сведения об ошибках при обновлении набора значений свойств актива.

errorCode -> (строка)

Код ошибки.

errorMessage -> (строка)

Соответствующее сообщение об ошибке.

timestamps -> (список)

Список временных меток каждой ошибки, если таковые имеются.

(структура)

Содержит временную метку с необязательной точностью до наносекунд.

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

Дата временной метки в секундах в формате эпохи Unix. Дробные данные наносекунд предоставляются offsetInNanos.

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

Смещение в наносекундах от timeInSeconds.

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

Spec-Zone.ru

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