Spec-Zone.ru › AWS CLI v2

[ aws . iotsitewise ]

получить-значение-свойства-актива

Описание

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

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

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

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

Синтаксис

  get-asset-property-value
[--asset-id <value>]
[--property-id <value>]
[--property-alias <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]

Параметры

--asset-id (строка)

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

--property-id (строка)

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

--property-alias (строка)

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

--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.

Примеры

Примечание

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

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

Для получения текущего значения свойства актива

Следующий пример get-asset-property-value получает текущее значение общей мощности ветряной турбины.

aws iotsitewise get-asset-property-value \
    --asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE \
    --property-id a1b2c3d4-5678-90ab-cdef-66666EXAMPLE

Вывод:

{
    "propertyValue": {
        "value": {
            "doubleValue": 6890.8677520453875
        },
        "timestamp": {
            "timeInSeconds": 1580853000,
            "offsetInNanos": 0
        },
        "quality": "GOOD"
    }
}

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

Вывод

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

Текущее значение свойства актива.

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 -> (строка)

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

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

Spec-Zone.ru

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