Sign in

v3

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

Get head and lock

Returns the given number of first requests from the queue and locks them for the given time.

If this endpoint locks the request, no other client or run will be able to get and lock these requests.

The response contains the hadMultipleClients boolean field which indicates that the queue was accessed by more than one client (with unique or empty clientKey).

post/v2/request-queues/{queueId}/head/lock

Path parameters

queueIdstring required
Example:WkzbQMuFYuamGv3YF

Queue ID or username~queue-name.

Query parameters

lockSecsnumber double required
Example:60

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

limitnumber double
Example:25

How many items from the queue should be returned.

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.

Response

Example response

{
  "data": {
    "limit": 3,
    "queueModifiedAt": "2018-03-14T23:00:00.000Z",
    "hadMultipleClients": true,
    "lockSecs": 60,
    "items": [
      {
        "id": "8OamqXBCpPHxyj9",
        "retryCount": 0,
        "uniqueKey": "http://example.com",
        "url": "http://example.com",
        "method": "GET",
        "lockExpiresAt": "2022-06-14T23:00:00.000Z"
      },
      {
        "id": "8OamqXBCpPHxyx9",
        "retryCount": 0,
        "uniqueKey": "http://example.com/a",
        "url": "http://example.com/a",
        "method": "GET",
        "lockExpiresAt": "2022-06-14T23:00:00.000Z"
      },
      {
        "id": "8OamqXBCpPHxy08",
        "retryCount": 0,
        "uniqueKey": "http://example.com/a/b",
        "url": "http://example.com/a/b",
        "method": "GET",
        "lockExpiresAt": "2022-06-14T23:00:00.000Z"
      }
    ]
  }
}