describe-time-series

Описание

Получает информацию о временном ряду (потоке данных).

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

Если временной ряд не связан с свойством актива, укажите alias временного ряда.
Если временной ряд связан со свойством актива, укажите одно из следующих:
- alias временного ряда.
- assetId и propertyId, которые идентифицируют свойство актива.

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

Синтаксис

  describe-time-series
[--alias <value>]
[--asset-id <value>]
[--property-id <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]

Параметры

--alias (строка)

Псевдоним, идентифицирующий временной ряд.

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

Идентификатор актива, в котором было создано свойство актива. Это может быть фактический идентификатор в формате UUID или же externalId:, за которым следует внешний идентификатор, если он есть. Дополнительную информацию см. в разделе «Ссылка на объекты с внешними идентификаторами» в Руководстве пользователя IoT SiteWise.

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

Идентификатор свойства актива. Это может быть фактический идентификатор в формате UUID или же externalId:, за которым следует внешний идентификатор, если он есть. Дополнительную информацию см. в разделе «Ссылка на объекты с внешними идентификаторами» в Руководстве пользователя 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
text
table
yaml
yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

on
off
auto

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

Вывод

assetId -> (строка)

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

propertyId -> (строка)

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

alias -> (строка)

Псевдоним, идентифицирующий временной ряд.

timeSeriesId -> (строка)

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

dataType -> (строка)

Тип данных временного ряда.

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

dataTypeSpec -> (строка)

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

Варианты этого параметра зависят от типа составной модели, в которой вы создали свойство актива, связанное с вашим временным рядом. Используйте AWS/ALARM_STATE для состояния тревоги в составных моделях тревоги.

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

Дата создания временного ряда в формате эпохи Unix.

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

Дата последнего обновления временного ряда в формате эпохи Unix.

timeSeriesArn -> (строка)

ARN временного ряда, имеющий следующий формат.

arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId}