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
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-08-25 UTC."],[[["\u003cp\u003eThis API endpoint, \u003ccode\u003eprojects.locations.instances.operations.cancel\u003c/code\u003e, initiates the cancellation of a long-running operation, with no guaranteed success.\u003c/p\u003e\n"],["\u003cp\u003eThe endpoint uses a \u003ccode\u003ePOST\u003c/code\u003e HTTP request to the URL \u003ccode\u003ehttps://chronicle.googleapis.com/v1alpha/{name}:cancel\u003c/code\u003e, where \u003ccode\u003e{name}\u003c/code\u003e represents the operation's resource name.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires an empty body, and if successful, returns an empty JSON object as a response.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires the OAuth scope \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e and the IAM permission \u003ccode\u003echronicle.operations.cancel\u003c/code\u003e on the specified resource.\u003c/p\u003e\n"],["\u003cp\u003eCancellation results can be verified by calling the \u003ca href=\"/chronicle/docs/reference/rest/v1alpha/projects.locations.instances.operations/get#google.longrunning.Operations.GetOperation\"\u003eOperations.GetOperation\u003c/a\u003e method, which can show either a success in cancellation or a completion of the operation despite the cancellation attempt.\u003c/p\u003e\n"]]],[],null,["# Method: 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- [IAM Permissions](#body.aspect_1)\n- [Try it!](#try-it)\n\n**Full name**: projects.locations.instances.operations.cancel\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](/chronicle/docs/reference/rest/v1alpha/projects.locations.instances.operations/get#google.longrunning.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](/chronicle/docs/reference/rest/Shared.Types/ListOperationsResponse#Operation.FIELDS.error) value with a [google.rpc.Status.code](/chronicle/docs/reference/rest/Shared.Types/ListOperationsResponse#Status.FIELDS.code) of `1`, corresponding to `Code.CANCELLED`.\n\n### HTTP request\n\nChoose a location: \nafrica-south1 asia-northeast1 asia-south1 asia-southeast1 asia-southeast2 australia-southeast1 europe-west12 europe-west2 europe-west3 europe-west6 europe-west9 me-central1 me-central2 me-west1 northamerica-northeast2 southamerica-east1 us eu \n\n\u003cbr /\u003e\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 an empty JSON object.\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](/docs/authentication#authorization-gcp).\n\n### IAM Permissions\n\nRequires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource:\n\n- `chronicle.operations.cancel`\n\nFor more information, see the [IAM documentation](https://cloud.google.com/iam/docs)."]]
