Spec-Zone.ru › AWS CLI v2

[ aws . iotsitewise ]

batch-get-asset-property-value

Описание

Получает текущее значение одного или нескольких свойств актива. Дополнительную информацию см. в разделе «Запрос текущих значений» в Руководстве пользователя IoT SiteWise.

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

Синтаксис

  batch-get-asset-property-value
--entries <value>
[--next-token <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]

Параметры

--entries (список)

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

(структура)

Содержит информацию для записи значения свойства актива, связанной с API BatchGetAssetPropertyValue.

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

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

entryId -> (строка)

Идентификатор записи.

assetId -> (строка)

Идентификатор актива, в котором было создано свойство актива.

propertyId -> (строка)

Идентификатор свойства актива в формате UUID.

propertyAlias -> (строка)

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

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

entryId=string,assetId=string,propertyId=string,propertyAlias=string ...

Синтаксис JSON:

[
  {
    "entryId": "string",
    "assetId": "string",
    "propertyId": "string",
    "propertyAlias": "string"
  }
  ...
]

--next-token (строка)

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

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

Вывод

errorEntries -> (список)

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

(структура)

Содержит информацию об ошибке для записи значения свойства актива, связанной с API BatchGetAssetPropertyValue.

errorCode -> (строка)

Код ошибки.

errorMessage -> (строка)

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

entryId -> (строка)

Идентификатор записи.

successEntries -> (список)

Список записей, успешно обработанных этим пакетным запросом. Каждая успешная запись содержит entryId записи, которая прошла, и последний результат запроса.

(структура)

Содержит информацию об успехе для записи, связанной с API BatchGetAssetPropertyValue.

entryId -> (строка)

Идентификатор записи.

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

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

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

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

stringValue -> (строка)

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

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

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

doubleValue -> (двойное значение)

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

booleanValue -> (булево)

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

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

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

valueType -> (строка)

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

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

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

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

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

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

Наносекундный смещение от timeInSeconds.

quality -> (строка)

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

skippedEntries -> (список)

Список записей, которые не были обработаны этим пакетным запросом, потому что эти записи были полностью обработаны предыдущими запросами с постраничной обработкой. Каждая пропущенная запись содержит entryId записи, которая была пропущена.

(структура)

Содержит информацию для записи, которая была обработана предыдущим запросом BatchGetAssetPropertyValue.

entryId -> (строка)

Идентификатор записи.

completionStatus -> (строка)

Статус завершения каждой записи, связанной с запросом BatchGetAssetPropertyValue.

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

Информация об ошибке, например, код ошибки и отметка времени.

errorCode -> (строка)

Код ошибки.

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

Дата возникновения ошибки в формате эпохи Unix.

nextToken -> (строка)

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

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

Spec-Zone.ru

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