Метод create

HTTP-запрос
Параметры в теле запроса
Ответ

Создает устройство в указанном реестре.

HTTP-запрос

POST https://iot-devices.api.cloud.yandex.net/iot-devices/v1/devices

Параметры в теле запроса

{
  "registryId": "string",
  "name": "string",
  "description": "string",
  "certificates": [
    {
      "certificateData": "string"
    }
  ],
  "topicAliases": "object",
  "password": "string"
}

Поле	Описание
registryId	string Обязательное поле. Идентификатор реестра, в котором создается устройство. Чтобы получить идентификатор реестра, используйте запрос list. Максимальная длина строки в символах — 50.
name	string Обязательное поле. Имя устройства. Имя должно быть уникальным в рамках реестра. Максимальная длина строки в символах — 50. Значение должно соответствовать регулярному выражению `[a-zA-Z0-9_-]*`.
description	string Описание устройства. Максимальная длина строки в символах — 256.
certificates[]	object Спецификация сертификата устройства.
certificates[]. certificateData	string Публичная часть сертификата устройства.
topicAliases	object Алиас топика устройства. Алиас — это альтернативное имя топика устройства, назначенное пользователем. Алиас сопоставляется со стандартным топиком, например `my/custom/alias` эквивалентен `$device/{id}/events`.
password	string Пароль устройства. Пароль должен содержать не менее трех категорий символов: строчные латинские буквы, прописные латинские буквы, цифры, специальные символы.

Ответ

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": true,
  "metadata": "object",

  //  включает только одно из полей `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": "object",
  // конец списка возможных полей

}

Ресурс Operation. Дополнительные сведения см. в разделе
Объект Operation.

Поле	Описание
id	string Идентификатор операции.
description	string Описание операции. Длина описания должна быть от 0 до 256 символов.
createdAt	string (date-time) Время создания ресурса в формате в RFC3339. Строка в формате RFC3339.
createdBy	string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
modifiedAt	string (date-time) Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. Строка в формате RFC3339.
done	boolean (boolean) Если значение равно `false` — операция еще выполняется. Если `true` — операция завершена, и задано значение одного из полей `error` или `response`.
metadata	object Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля `metadata`.
error	object Описание ошибки в случае сбоя или отмены операции. включает только одно из полей `error`, `response` Описание ошибки в случае сбоя или отмены операции.
error. code	integer (int32) Код ошибки. Значение из списка google.rpc.Code.
error. message	string Текст ошибки.
error. details[]	object Список сообщений с подробными сведениями об ошибке.
response	object включает только одно из полей `error`, `response` Результат операции в случае успешного завершения. Если исходный метод не возвращает никаких данных при успешном завершении, например метод Delete, поле содержит объект google.protobuf.Empty. Если исходный метод — это стандартный метод Create / Update, поле содержит целевой ресурс операции. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля `response`.