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."],[[["\u003cp\u003eThis page details how to initiate the asynchronous cancellation of a long-running operation using an HTTP POST request to a specific URL.\u003c/p\u003e\n"],["\u003cp\u003eThe request URL includes a path parameter, \u003ccode\u003ename\u003c/code\u003e, which specifies the operation resource to be cancelled.\u003c/p\u003e\n"],["\u003cp\u003eThe request body for canceling an operation must be empty, and a successful cancellation returns an empty response body.\u003c/p\u003e\n"],["\u003cp\u003eCancelling an operation requires \u003ccode\u003eosconfig.osPolicyAssignments.update\u003c/code\u003e IAM permission on the target \u003ccode\u003ename\u003c/code\u003e resource, along with the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"],["\u003cp\u003eOn successful cancellation, the operation is marked as cancelled but not deleted, with an \u003ccode\u003eOperation.error\u003c/code\u003e and a \u003ccode\u003eCode.CANCELLED\u003c/code\u003e status.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.osPolicyAssignments.operations.cancel\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [IAM Permissions](#body.aspect_1)\n- [Try it!](#try-it)\n\nStarts 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](/compute/docs/osconfig/rest/v1alpha/projects.locations.osPolicyAssignments.operations/get#google.longrunning.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](/compute/docs/osconfig/rest/Shared.Types/ListOperationsResponse#Operation.FIELDS.error) value with a [google.rpc.Status.code](/compute/docs/osconfig/rest/Shared.Types/ListOperationsResponse#Status.FIELDS.code) of `1`, corresponding to `Code.CANCELLED`.\n\n### HTTP request\n\n`POST https://osconfig.googleapis.com/v1/{name=projects/*/locations/*/osPolicyAssignments/*/operations/*}:cancel`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body is an empty JSON object.\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp).\n\n### IAM Permissions\n\nRequires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource:\n\n- `osconfig.osPolicyAssignments.update`\n\nFor more information, see the [IAM documentation](https://cloud.google.com/iam/docs)."]]
