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 returnsgoogle.rpc.Code.UNIMPLEMENTED. Clients can useOperations.GetOperationor 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 anOperation.errorvalue with agoogle.rpc.Status.codeof1, corresponding toCode.CANCELLED.
HTTP request
POST https://datastore.googleapis.com/v1/{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-04-30 UTC."],[[["\u003cp\u003eThis document describes how to cancel a long-running operation using an HTTP POST request.\u003c/p\u003e\n"],["\u003cp\u003eThe operation to be canceled is specified using its resource name within the URL path.\u003c/p\u003e\n"],["\u003cp\u003eThe request body for cancellation must be empty, as no additional data is required.\u003c/p\u003e\n"],["\u003cp\u003eA successful cancellation will result in an empty JSON response, and the operation will have a \u003ccode\u003eCode.CANCELLED\u003c/code\u003e error status.\u003c/p\u003e\n"],["\u003cp\u003eCanceling the operation requires authorization scopes related to Datastore or the broader Cloud Platform.\u003c/p\u003e\n"]]],[],null,["# Method: projects.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- [Try it!](#try-it)\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](/datastore/docs/reference/data/rest/v1/projects.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](/datastore/docs/reference/data/rest/v1/projects.operations#Operation.FIELDS.error) value with a [google.rpc.Status.code](/datastore/docs/reference/data/rest/v1/projects.operations#Status.FIELDS.code) of `1`, corresponding to `Code.CANCELLED`.\n\n### HTTP request\n\n`POST https://datastore.googleapis.com/v1/{name=projects/*/operations/*}:cancel`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\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 one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/datastore`\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp)."]]
