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://dataplex.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-07-21 UTC."],[[["\u003cp\u003eThis webpage documents how to initiate the asynchronous cancellation of a long-running operation using an HTTP POST request.\u003c/p\u003e\n"],["\u003cp\u003eThe request URL requires the operation's resource name to be specified as a path parameter in the \u003ccode\u003ename\u003c/code\u003e field.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must be empty when submitting the cancellation request.\u003c/p\u003e\n"],["\u003cp\u003eUpon a successful cancellation, the response will be an empty JSON object, but the operation is not deleted.\u003c/p\u003e\n"],["\u003cp\u003eThe cancellation will be made on a best effort basis, and requires the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e authorization scope.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.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](/dataplex/docs/reference/rest/v1/projects.locations.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](/dataplex/docs/reference/rest/v1/organizations.locations.operations#Operation.FIELDS.error) value with a [google.rpc.Status.code](/dataplex/docs/reference/rest/v1/organizations.locations.operations#Operation.Status.FIELDS.code) of `1`, corresponding to `Code.CANCELLED`.\n\n### HTTP request\n\n`POST https://dataplex.googleapis.com/v1/{name=projects/*/locations/*/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 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)."]]
