CreateLock - Data Lake Formation - Alibaba Cloud Documentation Center

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dlf:CreateLock

*All Resource

*

None

Request syntax

POST /api/metastore/catalogs/databases/tables/locks HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
Body	object	No	The request body.
LockObjList	array	No	A list of lock information.	{"databaseName":"db","tableName":"test"}
	LockObj	No	The lock information.

The LockObjList parameter can contain only one lock object.
The LockObj parameter supports only table locks. Partition-level locks are not supported.

Response elements

Element	Type	Description	Example
	object	The response body.
Code	string	The status code.	OK
Message	string	The returned message.	.
RequestId	string	The request ID.	73201200-4C1A-4FEF-BD6B-C0DA7994FFA2
Success	boolean	Indicates whether the call was successful. Valid values: true: The call was successful. false: The call failed.	True
LockStatus	LockStatus	The lock status information.	{"lockId":12323,"lockStatus":"ACQUIRED"}

Code: The error code.
Message: The error message.
RequestId: The unique ID of the request.
Success: Indicates whether the request is successful. Valid values are true and false.
LockStatus: This field is returned only if the request is successful. Otherwise, this field is empty. The LockStatus object contains two fields: LockId and LockState. The LockId field has a value if the value of LockState is ACQUIRED. Otherwise, the LockId field is empty.

Examples

Success response

JSON format

{
  "Code": "OK",
  "Message": ".",
  "RequestId": "73201200-4C1A-4FEF-BD6B-C0DA7994FFA2",
  "Success": true,
  "LockStatus": {
    "LockId": 1,
    "LockState": "ACQUIRED"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.