Method: operations.cancelOperation
Stay organized with collections
Save and categorize content based on your preferences.
Starts 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 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 value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.
HTTP request
POST https://optimization.googleapis.com/v1/{name=projects/*/operations/*}:cancel
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
The name of the operation resource to be cancelled.
|
Request body
The request body must be empty.
Response body
If successful, the response body is empty.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-11-15 UTC.
[null,null,["Last updated 2024-11-15 UTC."],[[["\u003cp\u003eThis documentation describes how to cancel a long-running operation using an HTTP request.\u003c/p\u003e\n"],["\u003cp\u003eThe 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\u003eIf the cancellation is successful, the server returns an empty response body; however, it is not guaranteed the operation will be cancelled immediately.\u003c/p\u003e\n"],["\u003cp\u003eThe operation's status can be checked with alternative methods, and if cancelled, it is marked with an error code rather than being deleted.\u003c/p\u003e\n"]]],["The provided content describes how to cancel a long-running operation. A `POST` HTTP request is sent to a specific URL, defined by the operation's name in the path. The request body must be empty. Successful cancellation results in an empty response body, and the operation's status changes to `CANCELLED`. The `Operations.GetOperation` method can be used to check if the operation is successful, completed, or cancelled. The server might not support cancel operations, in which case, it returns an `UNIMPLEMENTED` code.\n"],null,["# Method: operations.cancelOperation\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- [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](/optimization/service/reference/rest/v1/operations/getOperation#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](/optimization/service/reference/rest/v1/operations#Operation.FIELDS.error) value with a [google.rpc.Status.code](/optimization/service/reference/rest/v1/operations#Status.FIELDS.code) of `1`, corresponding to `Code.CANCELLED`.\n\n### HTTP request\n\n`POST https://optimization.googleapis.com/v1/{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 empty."]]
