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://config.googleapis.com/v1/{name=projects/*/locations/*/operations/*}:cancel
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-11-01 UTC."],[[["This page details how to cancel a long-running operation using a POST request to a specific URL structure defined by gRPC Transcoding."],["The operation to be cancelled is identified by its name, which is provided as a path parameter in the URL, following the format `projects/{project}/locations/{location}/operations/{operation}`."],["The request body for this operation must be empty, while a successful cancellation will result in an empty response body."],["The operation requires the OAuth scope `https://www.googleapis.com/auth/cloud-platform` for authorization."],["Cancelling the operation is not guaranteed, but if successful will result in an `Operation.error` value with a `google.rpc.Status.code` of 1."]]],[]]
