Sign in

v3

latestOpenAPI 3.1.2Apache 2.02026-07-31231237972.0 KB
Storage/Request queues/Requests locks

Prolong request lock

Prolongs request lock. The request lock can be prolonged only by the client that has locked it using Get and lock head operation.

The clientKey identifier is used for locking and unlocking requests. You can delete or prolong the lock only for requests that were locked by the same client key or from the same Actor run.

put/v2/request-queues/{queueId}/requests/{requestId}/lock

Path parameters

queueIdstring required
Example:WkzbQMuFYuamGv3YF

Queue ID or username~queue-name.

requestIdstring required
Example:xpsmkDlspokDSmklS

Request ID.

Query parameters

lockSecsnumber double required
Example:60

How long the requests will be locked for (in seconds).

clientKeystring
Example:client-abc

A unique identifier of the client accessing the request queue. It must be a string between 1 and 32 characters long. This identifier is used to determine whether the queue was accessed by multiple clients. If clientKey is not provided, the system considers this API call to come from a new client. For details, see the hadMultipleClients field returned by the Get head operation.

forefrontstring
Example:false

Determines if request should be added to the head of the queue or to the end after lock expires.

Response

Example response

{
  "data": {
    "lockExpiresAt": "2022-06-14T23:00:00.000Z"
  }
}