Method: operations.cancelOperation

AI-generated Key Takeaways

• This documentation describes how to cancel a long-running operation using an HTTP request.

• The request is sent to a specific URL with the operation's name as a path parameter and an empty request body.

• If the cancellation is successful, the server returns an empty response body; however, it is not guaranteed the operation will be cancelled immediately.

• The operation's status can be checked with alternative methods, and if cancelled, it is marked with an error code rather than being deleted.

• HTTP request
• Path parameters
• Request body
• Response body
• Try it!

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.