Required. The name of the lock to check. Format: projects/{project_id_or_number}/locations/{locationId}/catalogs/{catalogId}/databases/{databaseId}/locks/{lock_id}
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of Lock.
[[["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-02 UTC."],[[["\u003cp\u003eThis endpoint checks the state of a lock using its ID, as specified in the URL path.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request is a \u003ccode\u003ePOST\u003c/code\u003e method directed to a specific URL using gRPC Transcoding syntax, and it includes a required parameter named \u003ccode\u003ename\u003c/code\u003e in the path.\u003c/p\u003e\n"],["\u003cp\u003eThe request body for this operation must be empty, and it does not require any additional parameters in its content.\u003c/p\u003e\n"],["\u003cp\u003eA successful response will contain an instance of the \u003ccode\u003eLock\u003c/code\u003e object, detailing the state of the specified lock.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization for this operation requires one of two specified OAuth scopes or the \u003ccode\u003ebiglake.locks.check\u003c/code\u003e IAM permission on the \u003ccode\u003ename\u003c/code\u003e resource.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.catalogs.databases.locks.check\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\nChecks the state of a lock specified by the lock ID.\n\n### HTTP request\n\n`POST https://biglake.googleapis.com/v1alpha1/{name=projects/*/locations/*/catalogs/*/databases/*/locks/*}:check`\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 contains an instance of [Lock](/bigquery/docs/reference/biglake/rest/v1alpha1/projects.locations.catalogs.databases.locks#Lock).\n\n### Authorization Scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/bigquery`\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](https://cloud.google.com/docs/authentication/).\n\n### IAM Permissions\n\nRequires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource:\n\n- `biglake.locks.check`\n\nFor more information, see the [IAM documentation](https://cloud.google.com/iam/docs)."]]
