Yandex.Cloud
  • Сервисы
  • Почему Yandex.Cloud
  • Сообщество
  • Тарифы
  • Документация
  • Связаться с нами
Подключиться
Yandex Load Balancer
  • Начало работы
  • Пошаговые инструкции
    • Все инструкции
    • Балансировщики
      • Создать балансировщик
      • Создать внутренний сетевой балансировщик
      • Запустить балансировщик
      • Остановить балансировщик
      • Удалить балансировщик
      • Проверить состояние целевых ресурсов
      • Добавить обработчик
      • Удалить обработчик
    • Целевые группы
      • Создать целевую группу
      • Подключить целевую группу к балансировщику
      • Отключить целевую группу от балансировщика
      • Удалить целевую группу
  • Концепции
    • Балансировщик нагрузки
    • Внутренний балансировщик
    • Обработчик
    • Целевые ресурсы и группы
    • Проверка состояния ресурсов
    • Квоты и лимиты
  • Рекомендации по использованию сервиса
  • Управление доступом
  • Правила тарификации
  • Справочник API
    • Аутентификация в API
    • gRPC
      • Обзор
      • NetworkLoadBalancerService
      • TargetGroupService
      • OperationService
    • REST
      • Обзор
      • NetworkLoadBalancer
        • Обзор
        • addListener
        • attachTargetGroup
        • create
        • delete
        • detachTargetGroup
        • get
        • getTargetStates
        • list
        • listOperations
        • removeListener
        • start
        • stop
        • update
      • TargetGroup
        • Обзор
        • addTargets
        • create
        • delete
        • get
        • list
        • listOperations
        • removeTargets
        • update
      • Operation
        • Обзор
        • get
  • Вопросы и ответы
  1. Справочник API
  2. gRPC
  3. OperationService

OperationService

  • Вызовы OperationService
  • Get
    • GetOperationRequest
    • Operation
  • Cancel
    • CancelOperationRequest
    • Operation

Набор методов для управления операциями в асинхронных запросах API.
Ссылки указаны относительно домена operation.api.cloud.yandex.net.

Вызов Описание
Get Возвращает информацию об указанной операции.
Cancel Отменяет указанную операцию.

Вызовы OperationService

Get

Возвращает информацию об указанной операции.
Ссылка в запросе указана относительно домена operation.api.cloud.yandex.net.

rpc Get (GetOperationRequest) returns (Operation)

GetOperationRequest

Поле Описание
operation_id string
Обязательное поле. Идентификатор возвращаемой операции.

Operation

Поле Описание
id string
Идентификатор операции.
description string
Описание операции. Длина описания должна быть от 0 до 256 символов.
created_at google.protobuf.Timestamp
Время создания ресурса в формате в RFC3339.
created_by string
Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
modified_at google.protobuf.Timestamp
Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
done bool
Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
metadata google.protobuf.Any
Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
result oneof: error или response
Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
  error google.rpc.Status
Описание ошибки в случае сбоя или отмены операции.
  response google.protobuf.Any
Результат операции в случае успешного завершения. Если исходный метод не возвращает никаких данных при успешном завершении, например метод Delete, поле содержит объект google.protobuf.Empty. Если исходный метод — это стандартный метод Create / Update, поле содержит целевой ресурс операции. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля response.

Cancel

Отменяет указанную операцию.

rpc Cancel (CancelOperationRequest) returns (Operation)

CancelOperationRequest

Поле Описание
operation_id string
Обязательное поле. Идентификатор отменяемой операции.

Operation

Поле Описание
id string
Идентификатор операции.
description string
Описание операции. Длина описания должна быть от 0 до 256 символов.
created_at google.protobuf.Timestamp
Время создания ресурса в формате в RFC3339.
created_by string
Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
modified_at google.protobuf.Timestamp
Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
done bool
Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
metadata google.protobuf.Any
Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
result oneof: error или response
Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
  error google.rpc.Status
Описание ошибки в случае сбоя или отмены операции.
  response google.protobuf.Any
Результат операции в случае успешного завершения. Если исходный метод не возвращает никаких данных при успешном завершении, например метод Delete, поле содержит объект google.protobuf.Empty. Если исходный метод — это стандартный метод Create / Update, поле содержит целевой ресурс операции. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля response.
В этой статье:
  • Вызовы OperationService
  • Get
  • GetOperationRequest
  • Operation
  • Cancel
  • CancelOperationRequest
  • Operation
Language
Вакансии
Политика конфиденциальности
Условия использования
© 2021 ООО «Яндекс.Облако»