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://clouddeploy.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-06-13 UTC."],[[["\u003cp\u003eThis webpage details the process for initiating the asynchronous cancellation of a long-running operation, acknowledging that success is not guaranteed.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request to cancel an operation is a \u003ccode\u003ePOST\u003c/code\u003e request to a specific URL structure using gRPC Transcoding, with the operation's name included as a path parameter.\u003c/p\u003e\n"],["\u003cp\u003eCanceling the operation requires an empty request body, meaning no data needs to be sent in the request.\u003c/p\u003e\n"],["\u003cp\u003eA successful cancellation will be confirmed with an empty JSON object in the response body, while the operation's status will contain a \u003ccode\u003eCode.CANCELLED\u003c/code\u003e error.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization for canceling an operation requires the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],[],null,[]]
