Method: operations.cancel
Запускает асинхронную отмену длительной операции. Сервер делает все возможное, чтобы отменить операцию, но успех не гарантирован. Если сервер не поддерживает этот метод, он возвращает google.rpc.Code.UNIMPLEMENTED
. Клиенты могут использовать Operations.GetOperation
или другие методы, чтобы проверить, была ли отмена успешной или завершилась ли операция, несмотря на отмену. При успешной отмене операция не удаляется; вместо этого она становится операцией со значением Operation.error
со значением google.rpc.Status.code
, равным 1
, что соответствует Code.CANCELLED
.
HTTP-запрос
POST https://vault.googleapis.com/v1/{name=operations/**}:cancel
URL-адрес использует синтаксис транскодирования gRPC .
Параметры пути
Параметры |
---|
name | string Имя ресурса операции, которую необходимо отменить. |
Тело запроса
Тело запроса должно быть пустым.
Тело ответа
В случае успеха тело ответа представляет собой пустой объект JSON.
Области авторизации
Требуется следующая область действия OAuth:
-
https://www.googleapis.com/auth/ediscovery
Для получения дополнительной информации см.OAuth 2.0 Overview .
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons "С указанием авторства 4.0", а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2025-02-05 UTC.
[null,null,["Последнее обновление: 2025-02-05 UTC."],[[["Initiates the cancellation process for a long-running operation, although cancellation success is not guaranteed."],["Uses the `POST` method with a specific URL structure including the operation name for cancellation."],["Requires an empty request body and returns an empty response body upon successful cancellation."],["In case of unsupported cancellation by the server, an `UNIMPLEMENTED` error code is returned."],["If cancelled successfully, the operation is not deleted but marked with a `CANCELLED` status code."]]],["This document details the process of initiating asynchronous cancellation for a long-running operation. It uses an HTTP POST request to `vault.googleapis.com/v1/{name=operations/**}:cancel`. The `name` parameter specifies the operation to cancel. The request body must be empty, and a successful response returns an empty JSON object. The server attempts cancellation, and clients can check the status via `Operations.GetOperation`. Successful cancellation results in an `Operation.error` with `Code.CANCELLED`. Authorization requires the `https://www.googleapis.com/auth/ediscovery` OAuth scope.\n"]]