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://{endpoint}/v2beta1/{name=projects/*/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-27 UTC."],[[["\u003cp\u003eThis document describes how to cancel a long-running operation via an HTTP POST request to a specific endpoint with a designated operation name.\u003c/p\u003e\n"],["\u003cp\u003eThe request body for canceling an operation must be empty, and the URL follows gRPC Transcoding syntax, using the operation's name as a path parameter.\u003c/p\u003e\n"],["\u003cp\u003eUpon successful cancellation, the operation will not be deleted but will contain an error status with a \u003ccode\u003eCode.CANCELLED\u003c/code\u003e code, indicating that the operation did not finish.\u003c/p\u003e\n"],["\u003cp\u003eSuccessful operation cancellation results in an empty JSON response body, while accessing it requires one of the specified OAuth scopes for authorization.\u003c/p\u003e\n"],["\u003cp\u003eThe document also contains a section called "Try it!", which allows user to try the API.\u003c/p\u003e\n"]]],[],null,[]]
