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://edgenetwork.googleapis.com/v1/{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 outlines how to initiate the asynchronous cancellation of a long-running operation, noting that success is not guaranteed and the server will make its best effort.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request uses a \u003ccode\u003ePOST\u003c/code\u003e method directed to a specific URL, which is structured using gRPC Transcoding syntax and requires a defined operation name within the URL.\u003c/p\u003e\n"],["\u003cp\u003eCancelling an operation requires the user to have \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e authorization scopes.\u003c/p\u003e\n"],["\u003cp\u003eThe request body for cancelling an operation must be empty, and a successful response will also return an empty body.\u003c/p\u003e\n"],["\u003cp\u003eUpon successful cancellation, an operation will remain but will be updated with a \u003ccode\u003eCode.CANCELLED\u003c/code\u003e status, and other methods may be used to get the cancellation status.\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- [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` 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/network/rest/v1/projects.locations.operations#Operation.FIELDS.error) value with a [google.rpc.Status.code](/distributed-cloud/edge/1.7.1/docs/reference/network/rest/v1/projects.locations.operations#Status.FIELDS.code) of 1, corresponding to `Code.CANCELLED`.\n\n### HTTP request\n\n`POST https://edgenetwork.googleapis.com/v1/{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/)."]]
