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/v1/{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 page details how to initiate the asynchronous cancellation of a long-running operation using an HTTP POST request to a specific URL."],["The request URL includes a path parameter, `name`, which specifies the operation resource to be cancelled."],["The request body for canceling an operation must be empty, and a successful cancellation returns an empty response body."],["Cancelling an operation requires `osconfig.osPolicyAssignments.update` IAM permission on the target `name` resource, along with the `https://www.googleapis.com/auth/cloud-platform` OAuth scope."],["On successful cancellation, the operation is marked as cancelled but not deleted, with an `Operation.error` and a `Code.CANCELLED` status."]]],[]]
