Method: projects.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://earthengine.googleapis.com/v1beta/{name=projects/*/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
Nécessite l'un des champs d'application OAuth suivants :
https://www.googleapis.com/auth/earthengine
https://www.googleapis.com/auth/cloud-platform
Pour en savoir plus, consultez OAuth 2.0 Overview.
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)."],[[["\u003cp\u003eInitiates an asynchronous cancellation process for long-running operations, although cancellation success is not guaranteed.\u003c/p\u003e\n"],["\u003cp\u003eThe server may return an \u003ccode\u003eUNIMPLEMENTED\u003c/code\u003e error if it lacks cancellation support; use \u003ccode\u003eOperations.GetOperation\u003c/code\u003e to verify cancellation status.\u003c/p\u003e\n"],["\u003cp\u003eUpon successful cancellation, the operation persists with an error code indicating cancellation instead of deletion.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eCancelOperation\u003c/code\u003e request is sent to a specific URL with the operation's name as a path parameter and an empty request body.\u003c/p\u003e\n"],["\u003cp\u003eProper authorization is needed using either \u003ccode\u003eearthengine\u003c/code\u003e or \u003ccode\u003ecloud-platform\u003c/code\u003e OAuth scopes to execute the request.\u003c/p\u003e\n"]]],["This describes how to asynchronously cancel a long-running operation. A `POST` request to a specific URL using `gRPC Transcoding` initiates cancellation, with the operation's name as a path parameter. The request body must be empty. Upon success, the server returns an empty JSON object, but cancellation isn't guaranteed. The status of the operation is checked via `Operations.GetOperation` and a successful cancellation changes the operation's status `Code.CANCELLED` and is not deleted.\n"],null,["# Method: projects.operations.cancel\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](/earth-engine/reference/rest/v1alpha/projects.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](/earth-engine/reference/rest/Shared.Types/ListOperationsResponse#Operation.FIELDS.error) value with a [google.rpc.Status.code](/earth-engine/reference/rest/Shared.Types/ListOperationsResponse#Status.FIELDS.code) of `1`, corresponding to `Code.CANCELLED`.\n\n### HTTP request\n\n`POST https://earthengine.googleapis.com/v1beta/{name=projects/*/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 one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/earthengine`\n- `\n https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]