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://accesscontextmanager.googleapis.com/v1/{name=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 2025-02-12 UTC."],[[["This endpoint initiates an asynchronous cancellation of a long-running operation, where success is not guaranteed and depends on the server's capabilities."],["The `POST` request is sent to `https://accesscontextmanager.googleapis.com/v1/{name=operations/**}:cancel`, using gRPC Transcoding syntax, to the operation resource specified by the `name` path parameter."],["The request body must be empty, and on successful cancellation, the operation will have an error code of `1` (CANCELLED) without being deleted, or will just complete normally if the cancellation is unsuccessful."],["A successful response returns an empty JSON object, and clients can use `Operations.GetOperation` or similar methods to verify the success of the cancellation."],["Authorization to use this endpoint requires the `https://www.googleapis.com/auth/cloud-platform` OAuth scope."]]],[]]
