Method: operations.cancel

AI-generated Key Takeaways

• This document details how to cancel a long-running Route Optimization operation using a POST request to a specific URL.

• Cancellation is attempted but not guaranteed, and the operation's status can be checked using the Operations.GetOperation method.

• Successful cancellation results in the operation having an error code indicating it was canceled but the operation itself is not deleted.

• The request must have an empty body and include the operation's name as a path parameter.

• Authorization requires the https://www.googleapis.com/auth/cloud-platform OAuth scope.

• HTTP request
• Path parameters
• Request body
• Response body
• Authorization scopes

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://routeoptimization.googleapis.com/v1/{name=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 an empty JSON object.

Authorization scopes

Requires the following OAuth scope:

• https://www.googleapis.com/auth/cloud-platform