Метод listOperations

HTTP-запрос
Path-параметры
Query-параметры
Ответ

Возвращает список операций для указанного устройства.

HTTP-запрос

GET https://iot-devices.api.cloud.yandex.net/iot-devices/v1/devices/{deviceId}/operations

Path-параметры

Параметр	Описание
deviceId	Обязательное поле. Идентификатор устройства для получения списка операций. Для получения идентификатора устройства используйте запрос list.

Query-параметры

Параметр	Описание
pageSize	Максимальное число возвращаемых результатов на странице. Если количество результатов больше чем `page_size` , сервис вернет значение nextPageToken, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. Допустимые значения — от 0 до 1000 включительно.
pageToken	Токен страницы. Установите значение `page_token` равным значению поля nextPageToken предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.
filter	Параметры фильтрации ресурсов в ответе. В настоящее время фильтрация осуществляется только по полю Device.name. Максимальная длина строки в символах — 1000.

Ответ

HTTP Code: 200 - OK

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

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

    }
  ],
  "nextPageToken": "string"
}

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