Метод listOperations

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

HTTP-запрос

GET https://compute.api.cloud.yandex.net/compute/v1/disks/{diskId}/operations

Path-параметры

Параметр Описание
diskId Обязательное поле. Идентификатор ресурса Disk, для которого запрашивается список операций. Максимальная длина строки в символах — 50.

Query-параметры

Параметр Описание
pageSize Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем pageSize, сервис вернет значение nextPageToken, которое можно использовать для получения следующей страницы. Максимальное значение — 1000.
pageToken Токен страницы. Установите значение pageToken равным значению поля nextPageToken прошлого запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.

Ответ

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.

operations[].
createdBy
string

Только для вывода. Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.

operations[].
modifiedAt
string (date-time)

Только для вывода. Время, когда ресурс Operation последний раз обновлялся. Значение в формате 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, используйте nextPageToken в качестве значения параметра pageToken в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения nextPageToken для перебора страниц результатов.