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://gdchardwaremanagement.googleapis.com/v1alpha/{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 2025-07-11 UTC."],[[["\u003cp\u003eThis webpage details the process of asynchronously canceling a long-running operation, noting that cancellation success is not guaranteed and may result in an error code of \u003ccode\u003eCode.CANCELLED\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request for initiating a cancellation is a \u003ccode\u003ePOST\u003c/code\u003e request to a specific URL defined by gRPC Transcoding syntax, requiring a path parameter \u003ccode\u003ename\u003c/code\u003e to identify the operation.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must be empty when sending a cancellation request, and a successful cancellation also returns an empty response body.\u003c/p\u003e\n"],["\u003cp\u003eInitiating an operation cancellation requires the OAuth scope \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e and the IAM permission \u003ccode\u003egdchardwaremanagement.operations.cancel\u003c/code\u003e on the target resource.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.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](/distributed-cloud/edge/1.7.1/docs/reference/hardware/rest/v1alpha/projects.locations.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](/distributed-cloud/edge/1.7.1/docs/reference/hardware/rest/v1alpha/projects.locations.operations#Operation.FIELDS.error) value with a [google.rpc.Status.code](/distributed-cloud/edge/1.7.1/docs/reference/hardware/rest/v1alpha/projects.locations.operations#Status.FIELDS.code) of 1, corresponding to `Code.CANCELLED`.\n\n### HTTP request\n\n`POST https://gdchardwaremanagement.googleapis.com/v1alpha/{name=projects/*/locations/*/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 empty.\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](https://cloud.google.com/docs/authentication/).\n\n### IAM Permissions\n\nRequires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource:\n\n- `gdchardwaremanagement.operations.cancel`\n\nFor more information, see the [IAM documentation](https://cloud.google.com/iam/docs)."]]
