Full name: projects.locations.instances.operations.cancel
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://chronicle.googleapis.com/v1alpha/{name}:cancel
Path parameters
Parameters
name
string
The name of the operation resource to be cancelled.
Request body
The request body must be empty.
Response body
If successful, the response body is an empty JSON object.
[[["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-27 UTC."],[[["This API endpoint, `projects.locations.instances.operations.cancel`, initiates the cancellation of a long-running operation, with no guaranteed success."],["The endpoint uses a `POST` HTTP request to the URL `https://chronicle.googleapis.com/v1alpha/{name}:cancel`, where `{name}` represents the operation's resource name."],["The request requires an empty body, and if successful, returns an empty JSON object as a response."],["Authorization requires the OAuth scope `https://www.googleapis.com/auth/cloud-platform` and the IAM permission `chronicle.operations.cancel` on the specified resource."],["Cancellation results can be verified by calling the [Operations.GetOperation](/chronicle/docs/reference/rest/v1alpha/projects.locations.instances.operations/get#google.longrunning.Operations.GetOperation) method, which can show either a success in cancellation or a completion of the operation despite the cancellation attempt."]]],[]]
