[ aws . iotsitewise ]
batch-get-asset-property-aggregates
Описание
Получает агрегированные значения (например, среднее, минимальное и максимальное) для одного или нескольких свойств актива. Дополнительную информацию см. в разделе «Запрос агрегатов» в Руководстве пользователя IoT SiteWise.
См. также: Документацию API AWS
Синтаксис
batch-get-asset-property-aggregates
--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 BatchGetAssetPropertyAggregates.
Для идентификации свойства актива необходимо указать одно из следующего:
assetIdиpropertyIdсвойства актива.propertyAlias, который представляет собой псевдоним потока данных (например,/company/windfarm/3/turbine/7/temperature). Для определения псевдонима свойства актива см. UpdateAssetProperty.
entryId -> (строка)
assetId -> (строка)
propertyId -> (строка)
propertyAlias -> (строка)
/company/windfarm/3/turbine/7/temperature). Дополнительную информацию см. в разделе «Сопоставление промышленных потоков данных со свойствами актива» в Руководстве пользователя IoT SiteWise.aggregateTypes -> (список)
Функция агрегирования данных.
(строка)
resolution -> (строка)
startDate -> (метка времени)
endDate -> (метка времени)
qualities -> (список)
Качество для фильтрации данных актива.
(строка)
timeOrdering -> (строка)
Порядок сортировки запрошенной информации по времени.
По умолчанию: ASCENDING
Сокращённый синтаксис:
entryId=string,assetId=string,propertyId=string,propertyAlias=string,aggregateTypes=string,string,resolution=string,startDate=timestamp,endDate=timestamp,qualities=string,string,timeOrdering=string ...
Синтаксис JSON:
[
{
"entryId": "string",
"assetId": "string",
"propertyId": "string",
"propertyAlias": "string",
"aggregateTypes": ["AVERAGE"|"COUNT"|"MAXIMUM"|"MINIMUM"|"SUM"|"STANDARD_DEVIATION", ...],
"resolution": "string",
"startDate": timestamp,
"endDate": timestamp,
"qualities": ["GOOD"|"BAD"|"UNCERTAIN", ...],
"timeOrdering": "ASCENDING"|"DESCENDING"
}
...
]
--next-token (строка)
--max-results (целое число)
Максимальное количество результатов, возвращаемых для каждого постраничного запроса. Результат возвращается в одном из двух случаев, который произойдёт раньше:
- Размер набора результатов равен 1 МБ.
- Количество точек данных в наборе результатов равно значению
maxResults. Максимальное значениеmaxResultsравно 4000.
--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.
Вывод
errorEntries -> (список)
Список ошибок (при их наличии), связанных с пакетным запросом. Каждая запись об ошибке содержит entryId записи, которая завершилась ошибкой.
(структура)
Содержит информацию об ошибке для записи агрегированного свойства актива, связанной с API BatchGetAssetPropertyAggregates.
errorCode -> (строка)
errorMessage -> (строка)
entryId -> (строка)
successEntries -> (список)
Список записей, успешно обработанных этим пакетным запросом. Каждая запись об успехе содержит entryId записи, которая завершилась успешно, и последний результат запроса.
(структура)
Содержит информацию об успехе для записи, связанной с API BatchGetAssetPropertyAggregates.
entryId -> (строка)
aggregatedValues -> (список)
Запрошенные агрегированные значения свойств актива (например, среднее, минимальное и максимальное).
(структура)
Содержит агрегированные значения свойств актива (например, среднее, минимальное и максимальное).
timestamp -> (метка времени)
quality -> (строка)
value -> (структура)
Значение агрегатов.
average -> (двойное)
count -> (двойное)
maximum -> (двойное)
minimum -> (двойное)
sum -> (двойное)
standardDeviation -> (двойное)
skippedEntries -> (список)
Список записей, которые не были обработаны этим пакетным запросом. потому что эти записи были полностью обработаны предыдущими запросами с постраничной передачей. Каждая пропущенная запись содержит entryId записи, которую пропустили.
(структура)
Содержит информацию о записи, которая была обработана предыдущим запросом BatchGetAssetPropertyAggregates.
entryId -> (строка)
completionStatus -> (строка)
errorInfo -> (структура)
Информация об ошибке, такая как код ошибки и метка времени.
errorCode -> (строка)
errorTimestamp -> (метка времени)
nextToken -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.