Method: operations.cancel
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Démarre l'annulation asynchrone sur une opération de longue durée. Le serveur fait de son mieux pour annuler l'opération, mais la réussite de l'annulation n'est pas garantie. Si le serveur n'accepte pas cette méthode, il renvoie google.rpc.Code.UNIMPLEMENTED. Les clients peuvent utiliser Operations.GetOperation ou d'autres méthodes pour vérifier si l'annulation a réussi, ou si l'opération a abouti malgré la tentative d'annulation. En cas d'annulation réussie, l'opération n'est pas supprimée, mais elle devient une opération dotée d'une valeur Operation.error avec un code d'état google.rpc.Status.code de 1, correspondant au code Code.CANCELLED.
Requête HTTP
POST https://vault.googleapis.com/v1/{name=operations/**}:cancel
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de chemin d'accès
| Paramètres |
name |
string
Le nom de la ressource de l'opération à annuler.
|
Corps de la requête
Le corps de la requête doit être vide.
Corps de la réponse
Si la requête aboutit, le corps de la réponse est un objet JSON vide.
Champs d'application des autorisations
Requiert le niveau d'accès OAuth suivant :
https://www.googleapis.com/auth/ediscovery
Pour en savoir plus, consultez le guide d'autorisation.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/25 (UTC).
[null,null,["Dernière mise à jour le 2025/07/25 (UTC)."],[],[],null,["# Method: operations.cancel\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nStarts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use [Operations.GetOperation](/workspace/vault/reference/rest/v1/operations/get#google.longrunning.Operations.GetOperation) or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an [Operation.error](/workspace/vault/reference/rest/v1/operations#Operation.FIELDS.error) value with a [google.rpc.Status.code](/workspace/vault/reference/rest/v1/operations#Status.FIELDS.code) of `1`, corresponding to `Code.CANCELLED`.\n\n### HTTP request\n\n`POST https://vault.googleapis.com/v1/{name=operations/**}:cancel`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|--------------------------------------------------------------|\n| `name` | `string` The name of the operation resource to be cancelled. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body is an empty JSON object.\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/ediscovery`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
