Облачная платформаВсе платформы

Прежде чем начать

Язык статьи: Русский
Показать оригинал
Страница переведена автоматически и может содержать неточности. Рекомендуем сверяться с английской версией.

Обзор

API.

Описание

Платформа поддерживает RESTful API, позволяющие вызывать их по HTTPS. Подробную информацию о том, как вызывать API, см Вызов API.

Эндпоинты

Эндпоинт — это адрес запроса для вызова API. Эндпоинты IoTDA см Как получить адрес доступа к платформе?.

Ограничения

  • Прямая совместимость гарантирует, что более старые версии API остаются функциональными после обновлений, хотя они не будут включать улучшения. Новые функции доступны только в новой версии.
  • При получении и обработке ответных сообщений и push‑сообщений от IoT‑платформы приложение должно поддерживать или игнорировать новые параметры в сообщениях. Оно не должно возвращать ошибку из‑за новых параметров.
  • Подробную информацию о других ограничениях вызова API см Ограничения.
  • В сценариях шлюза значение device_id является идентификатором дочернего устройства, если не указано иное.

Понятия

  • Аккаунт

    Учетная запись создается после успешной регистрации в облачной платформе. Учетная запись имеет полные права доступа ко всем своим облачным сервисам и ресурсам. Ее можно использовать для сброса паролей пользователей и предоставления им прав. Учетная запись является платежным субъектом и не должна использоваться напрямую для рутинного управления. В целях безопасности создайте пользователей Identity and Access Management (IAM) и предоставьте им права для рутинного управления.

  • Пользователи

    Пользователь Identity and Access Management (IAM) создается учетной записью для использования облачных сервисов. Каждый IAM‑пользователь имеет свои учетные данные (пароль и ключи доступа).

    Вы можете просмотреть идентификатор учетной записи и идентификатор пользователя в Мои учетные данные. Для аутентификации API потребуются имя учетной записи, имя пользователя и пароль.

  • Регион

    Регионы делятся по географическому расположению и задержке сети. Публичные сервисы, такие как Elastic Cloud Server (ECS), Elastic Volume Service (EVS), Object Storage Service (OBS), Virtual Private Cloud (VPC), Elastic IP (EIP) и Image Management Service (IMS), совместно используются внутри одного региона. Регионы классифицируются на универсальные и выделенные регионы. Универсальный регион предоставляет универсальные облачные сервисы для общих арендаторов. Выделенный регион предоставляет специальные сервисы для конкретных арендаторов.

  • Зона доступности (AZ)

    Зона доступности (AZ) состоит из одного или нескольких физических дата‑центров. Каждая AZ имеет независимые системы охлаждения, пожаротушения, влагозащиты и электроснабжения. Внутри AZ вычислительные, сетевые, хранилищные и другие ресурсы логически разделены на несколько Кластеров. AZ в рамках региона соединены высокоскоростными оптическими волокнами для обеспечения высокодоступных систем с межзонным резервированием.

  • Проект

    Проект соответствует региону. Проекты по умолчанию определяются для группировки и физической изоляции ресурсов (включая вычислительные, хранилищные и сетевые ресурсы) между регионами. Пользователям могут предоставляться права в проекте по умолчанию для доступа ко всем ресурсам в их доменах в регионе, связанном с проектом. Если требуется более тонкий контроль доступа, создайте подпроекты в рамках проекта по умолчанию и приобретайте ресурсы в подпроектах. Затем можно назначать пользователям права, необходимые для доступа только к ресурсам в конкретных подпроектах.

    Рисунок 1 Модель изоляции проекта


  • Enterprise project

    Enterprise projects группируют и управляют ресурсами в разных регионах. Ресурсы в Enterprise projects логически изолированы. Они содержат ресурсы в нескольких регионах и позволяют добавлять или удалять ресурсы. Для получения дополнительной информации об Enterprise проектах и о том, как получить их идентификаторы, см Enterprise Management User Guide.

  • Пространства ресурсов

    Пространство ресурсов — это пространство, выделенное для ваших приложений. Ресурсы (например, продукты и устройства), созданные на платформе, должны принадлежать пространству ресурсов. Вы можете использовать пространство ресурсов для управления на основе доменов. Подробнее см Пространства ресурсов.

  • Продукты

    Модель продукта описывает возможности и функции устройства. Разработчики могут определять модели продукта для создания абстрактной модели устройства на платформе. Подробнее см Определение модели продукта.

  • Доставка сообщений

    Доставка сообщений не зависит от моделей продукта. Платформа предоставляет односторонние уведомления для устройств и кэширует сообщения. Подробнее см Доставка сообщений.

  • Доставка команд

    Модель продукта определяет команды, которые могут быть доставлены устройствам. Приложения могут вызывать API платформы для доставки команд устройствам, эффективно управляя этими устройствами. Подробнее см Доставка команд.

  • Доставка свойств

    Доставка свойств используется для запроса или изменения свойств. Приложение или платформа могут получать информацию о свойствах устройства или изменять свойства и синхронизировать результат изменения с устройством. Подробнее см Доставка свойств.

  • Управление очередью AMQP

    AMQP — это аббревиатура Advanced Queuing Message Protocol. Вы можете использовать клиент AMQP для установления соединения с IoTDA и получения данных. Подробнее см Подписка и push AMQP.

  • Пересылка данных

    Устройство может подключаться к платформе и обмениваться данными с ней. Устройство передает данные на платформу, используя пользовательские темы или модели продукта. После завершения конфигурации подписки/push в консоли платформа отправляет сообщения о изменениях жизненного цикла устройства, отмеченных свойствах устройства, сообщениях устройства, изменениях статуса сообщений устройства, изменениях статуса устройства и статусах пакетных задач приложению. Подробнее см Режимы пересылки.

  • Тень устройства

    Платформа IoT поддерживает создание теней устройств. Тень устройства — это JSON‑файл, в котором хранится статус устройства, последние отмеченные свойства устройства и конфигурации устройства для доставки. У каждого устройства есть только одна тень. Устройство может получать и задавать свою тень для синхронизации свойств, как из тени в устройство, так и из устройства в тень. Подробнее см Тень устройства.

  • Группа устройств

    Группа — это набор устройств. Вы можете создавать группы для всех устройств в пространстве ресурсов на основе разных правил, таких как регионы и типы, и управлять устройствами по группам. Например, можно выполнить обновление прошивки группы водяных счетчиков в пространстве ресурсов. Устройства в группе могут добавляться, удаляться, изменяться и запрашиваться. Устройство может быть привязано к нескольким группам и отвязано от них. Подробнее см Группы и Теги.

  • Теги

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

  • Правила связывания

    Правила связывания классифицируются на правила на стороне устройства и облачные правила. Правила на стороне устройства: это правила связывания, доставляемые устройствам, где движок правил на стороне устройства парсит и исполняет правила. Правила на стороне устройства могут работать на устройствах, когда сеть прервана или устройства не могут связаться с платформой. Облачные правила: если вы задаете облачное правило, IoTDA определяет, выполнено ли условие срабатывания правила. Если условие выполнено, IoTDA выполняет заданные вами действия, такие как alarm reporting, уведомление о теме и доставка команды. Подробнее см Облачные правила.

  • Пакетные задачи

    Вы можете использовать пакетные задачи для выполнения пакетных операций над несколькими устройствами. Поддерживаемые пакетные операции: Обновление программного обеспечения и прошивки, создание, изменение, удаление, заморозка, разморозка и обновление устройств, создание команд и сообщений, и установка тени устройства.

  • OTA‑обновление

    OTA‑обновление означает обновление программного обеспечения и прошивки. Обновление программного обеспечения относится к обновлению системного и прикладного ПО устройства. Обновление прошивки относится к обновлению базового драйвера аппаратного обеспечения устройства. Вы можете загрузить пакет обновления программного/прошивочного обеспечения в IoTDA или использовать файл, связанный с объектом в OBS, для удаленного обновления устройств. Подробнее см OTA‑обновления.