[ aws . iotsitewise ]
batch-get-asset-property-value-history
Описание
Получает исторические значения для одного или нескольких свойств актива. Дополнительную информацию см. в разделе Запрос исторических значений в Руководстве пользователя IoT SiteWise.
См. также: Документация API AWS
Синтаксис
batch-get-asset-property-value-history
--entries <value>
[--next-token <value>]
[--max-results <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 (список)
Список записей исторических значений свойств актива для запроса пакетного получения. Вы можете указать до 16 записей в одном запросе.
(структура)
Содержит информацию о записи исторического значения свойства актива, связанного с API BatchGetAssetPropertyValueHistory.
Для идентификации свойства актива необходимо указать одно из следующего:
assetIdиpropertyIdсвойства актива.propertyAlias, который представляет собой псевдоним потока данных (например,/company/windfarm/3/turbine/7/temperature). Чтобы определить псевдоним свойства актива, см. UpdateAssetProperty.
entryId -> (строка)
assetId -> (строка)
propertyId -> (строка)
propertyAlias -> (строка)
/company/windfarm/3/turbine/7/temperature). Дополнительную информацию см. в разделе Сопоставление потоков промышленных данных со свойствами актива в Руководстве пользователя IoT SiteWise.startDate -> (метка времени)
endDate -> (метка времени)
qualities -> (список)
Качество, по которому фильтруются данные актива.
(строка)
timeOrdering -> (строка)
Порядок хронологической сортировки запрашиваемой информации.
По умолчанию: ASCENDING
Упрощенный синтаксис:
entryId=string,assetId=string,propertyId=string,propertyAlias=string,startDate=timestamp,endDate=timestamp,qualities=string,string,timeOrdering=string ...
Синтаксис JSON:
[
{
"entryId": "string",
"assetId": "string",
"propertyId": "string",
"propertyAlias": "string",
"startDate": timestamp,
"endDate": timestamp,
"qualities": ["GOOD"|"BAD"|"UNCERTAIN", ...],
"timeOrdering": "ASCENDING"|"DESCENDING"
}
...
]
--next-token (строка)
--max-results (целое число)
Максимальное количество результатов, возвращаемых для каждого запроса пагинации. Результат возвращается в обоих случаях, в зависимости от того, какой из них происходит первым.
- Размер набора результатов равен 4 МБ.
- Количество точек данных в наборе результатов равно значению
maxResults. Максимальное значениеmaxResultsравно 20000.
--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 записи, которая завершилась неудачно.
(структура)
Список ошибок (если таковые имеются), связанных с пакетным запросом. Каждая запись об ошибке содержит entryId записи, которая завершилась неудачно.
errorCode -> (строка)
errorMessage -> (строка)
entryId -> (строка)
successEntries -> (список)
Список записей, которые были успешно обработаны этим пакетным запросом. Каждая успешная запись содержит entryId записи, которая выполнилась успешно, и последние результаты запроса.
(структура)
Содержит информацию об успехе для записи, связанной с API BatchGetAssetPropertyValueHistory.
entryId -> (строка)
assetPropertyValueHistory -> (список)
Запрашиваемые исторические значения для указанного свойства актива.
(структура)
Содержит информацию о значении свойства актива.
value -> (структура)
Значение свойства актива (см. Variant).
stringValue -> (строка)
integerValue -> (целое число)
doubleValue -> (двойное значение)
booleanValue -> (логическое значение)
nullValue -> (структура)
Тип данных пустого свойства актива с качествами BAD и UNCERTAIN.
valueType -> (строка)
timestamp -> (структура)
Отметка времени значения свойства актива.
timeInSeconds -> (длинное целое число)
offsetInNanos.offsetInNanos -> (целое число)
timeInSeconds.quality -> (строка)
skippedEntries -> (список)
Список записей, которые не были обработаны этим пакетным запросом, так как эти записи были полностью обработаны предыдущими запросами с пагинацией. Каждая пропущенная запись содержит entryId записи, которая была пропущена.
(структура)
Содержит информацию о записи, которая была обработана предыдущим запросом BatchGetAssetPropertyValueHistory.
entryId -> (строка)
completionStatus -> (строка)
errorInfo -> (структура)
Информация об ошибке, такая как код ошибки и отметка времени.
errorCode -> (строка)
errorTimestamp -> (метка времени)
nextToken -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.