Method: projects.locations.catalogs.databases.locks.check

Checks the state of a lock specified by the lock ID.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



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.

Authorization Scopes

Requires one of the following OAuth scopes:


For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • biglake.locks.check

For more information, see the IAM documentation.