Default request queue
Get and lock default request queue head
Returns the given number of first requests from the default request queue of the Actor run and locks them for the given time.
This endpoint is a shortcut for getting the run's defaultRequestQueueId and then using the Get head and lock endpoint.
post/v2/actor-runs/{runId}/request-queue/head/lock
Path parameters
runIdstring required
Example:3KH8gEpp4d8uQSe8T
Actor run ID.
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"
}
]
}
}