If you cancel a metadata import job that is in progress, the changes in the job might be partially applied. We recommend that you reset the state of the entry groups in your project by running another metadata job that reverts the changes from the canceled job.
HTTP request
POST https://dataplex.googleapis.com/v1/{name=projects/*/locations/*/metadataJobs/*}: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 page documents how to cancel a metadata job via a POST request to the specified endpoint.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires a resource name parameter formatted as \u003ccode\u003eprojects/{project_id_or_number}/locations/{locationId}/metadataJobs/{metadataJobId}\u003c/code\u003e in the URL path.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must be empty to successfully cancel a metadata job.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization for cancelling the metadata job requires the \u003ccode\u003edataplex.metadataJobs.cancel\u003c/code\u003e IAM permission and the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"],["\u003cp\u003eCancelling a metadata job will produce an empty JSON response body.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.metadataJobs.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\nCancels a metadata job.\n\nIf you cancel a metadata import job that is in progress, the changes in the job might be partially applied. We recommend that you reset the state of the entry groups in your project by running another metadata job that reverts the changes from the canceled job.\n\n### HTTP request\n\n`POST https://dataplex.googleapis.com/v1/{name=projects/*/locations/*/metadataJobs/*}: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).\n\n### IAM Permissions\n\nRequires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource:\n\n- `dataplex.metadataJobs.cancel`\n\nFor more information, see the [IAM documentation](https://cloud.google.com/iam/docs)."]]
