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://osconfig.googleapis.com/v1alpha/{name=projects/*/locations/*/osPolicyAssignments/*/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-07-28 UTC."],[[["This webpage details how to initiate the asynchronous cancellation of a long-running operation using an HTTP POST request."],["The request URL follows gRPC Transcoding syntax and requires a `name` path parameter specifying the operation resource to be cancelled."],["The request body for cancelling the operation must be empty, and a successful operation results in an empty response body."],["Cancelling this type of operation requires the `https://www.googleapis.com/auth/cloud-platform` OAuth scope and the `osconfig.osPolicyAssignments.update` IAM permission."],["While the server attempts to cancel the operation, success isn't guaranteed, and clients should use `Operations.GetOperation` to determine if cancellation was successful."]]],[]]
