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://apigeeregistry.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-03-07 UTC."],[[["This document describes the legacy Apigee Registry API's operation cancellation process, which is no longer supported, and recommends using the Apigee API hub APIs instead."],["Cancellation of a long-running operation is triggered via a POST request to a specific URL, `https://apigeeregistry.googleapis.com/v1/{name=projects/*/locations/*/operations/*}:cancel`."],["The request requires a `name` path parameter specifying the operation to be canceled, and the request body must be empty."],["A successful cancellation attempt results in an empty response body, and the operation's status is updated with a `Code.CANCELLED` error code."],["The operation for canceling long-running requests requires the `https://www.googleapis.com/auth/cloud-platform` OAuth scope for authorization."]]],[]]
