Worker API

The worker API allows to launch new workers, query and manipulate their status, and invoke their exported functions.

Launch a new worker.

Creates a new worker. The worker initially is in `Idle`` status, waiting to be invoked.

The parameters in the request are the following:

• name is the name of the created worker. This has to be unique, but only for a given component
• args is a list of strings which appear as command line arguments for the worker
• env is a list of key-value pairs (represented by arrays) which appear as environment variables for the worker

Example Request JSON

{
  "name": "string",
  "args": ["string"],
  "env": {
    "property1": "string",
    "property2": "string"
  }
}

Example Response JSON

{
  "workerId": {
    "componentId": "196100ac-4eec-4fb6-a7f7-86c8b584771d",
    "workerName": "string"
  },
  "componentVersion": 0
}

Get metadata of multiple workers

Filters

Comparators

• StringFilterComparator: eq|equal|=|==, ne|notequal|!=, like, notlike
• FilterComparator: eq|equal|=|==, ne|notequal|!=, ge|greaterequal|>=, gt|greater|>, le|lessequal|<=, lt|less|<

Returns metadata about an existing component workers:

• workers list of workers metadata
• cursor cursor for next request, if cursor is empty/null, there are no other values

Query Parameters

Example Response JSON

{
  "workers": [
    {
      "workerId": {
        "componentId": "196100ac-4eec-4fb6-a7f7-86c8b584771d",
        "workerName": "string"
      },
      "accountId": "string",
      "args": ["string"],
      "env": {
        "property1": "string",
        "property2": "string"
      },
      "status": "Running",
      "componentVersion": 0,
      "retryCount": 0,
      "pendingInvocationCount": 0,
      "updates": [
        {
          "type": "pendingUpdate",
          "timestamp": "2019-08-24T14:15:22Z",
          "targetVersion": 0
        }
      ],
      "createdAt": "2019-08-24T14:15:22Z",
      "lastError": "string"
    }
  ],
  "cursor": 0
}

Delete a worker

Interrupts and deletes an existing worker.

Example Response JSON

{}

Get metadata of a worker

Returns metadata about an existing worker:

• workerId is a combination of the used component and the worker's user specified name
• accountId the account the worker is created by
• args is the provided command line arguments passed to the worker
• env is the provided map of environment variables passed to the worker
• componentVersion is the version of the component used by the worker
• retryCount is the number of retries the worker did in case of a failure
• status is the worker's current status, one of the following:
• Running if the worker is currently executing
• Idle if the worker is waiting for an invocation
• Suspended if the worker was running but is now waiting to be resumed by an event (such as end of a sleep, a promise, etc)
• Interrupted if the worker was interrupted by the user
• Retrying if the worker failed, and an automatic retry was scheduled for it
• Failed if the worker failed and there are no more retries scheduled for it
• Exited if the worker explicitly exited using the exit WASI function

Example Response JSON

{
  "workerId": {
    "componentId": "196100ac-4eec-4fb6-a7f7-86c8b584771d",
    "workerName": "string"
  },
  "accountId": "string",
  "args": ["string"],
  "env": {
    "property1": "string",
    "property2": "string"
  },
  "status": "Running",
  "componentVersion": 0,
  "retryCount": 0,
  "pendingInvocationCount": 0,
  "updates": [
    {
      "type": "pendingUpdate",
      "timestamp": "2019-08-24T14:15:22Z",
      "targetVersion": 0
    }
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "lastError": "string"
}

Invoke a function and await it's resolution

Supply the parameters in the request body as JSON.

Query Parameters

Headers

Example Request JSON

{
  "params": null
}

Example Response JSON

{
  "result": null
}

Invoke a function

A simpler version of the previously defined invoke and await endpoint just triggers the execution of a function and immediately returns. Custom calling convention is not supported. To understand how to get the function name and how to encode the function parameters check Component interface

Query Parameters

Headers

Example Request JSON

{
  "params": null
}

Example Response JSON

{}

Complete a promise

Completes a promise with a given custom array of bytes. The promise must be previously created from within the worker, and it's identifier (a combination of a worker identifier and an oplogIdx ) must be sent out to an external caller so it can use this endpoint to mark the promise completed. The data field is sent back to the worker and it has no predefined meaning.

Example Request JSON

{
  "oplogIdx": 0,
  "data": [0]
}

Example Response JSON

true

Interrupt a worker

Interrupts the execution of a worker. The worker's status will be Interrupted unless the recover-immediately parameter was used, in which case it remains as it was. An interrupted worker can be still used, and it is going to be automatically resumed the first time it is used. For example in case of a new invocation, the previously interrupted invocation is continued before the new one gets processed.

Query Parameters

Example Response JSON

{}

Advanced search for workers

Filter types

Comparators

• StringFilterComparator: Equal, NotEqual, Like, NotLike
• FilterComparator: Equal, NotEqual, GreaterEqual, Greater, LessEqual, Less

Returns metadata about an existing component workers:

• workers list of workers metadata
• cursor cursor for next request, if cursor is empty/null, there are no other values

Example Request JSON

{
  "filter": {
    "type": "Name",
    "comparator": "Equal",
    "value": "string"
  },
  "cursor": 0,
  "count": 0,
  "precise": true
}

Example Response JSON

{
  "workers": [
    {
      "workerId": {
        "componentId": "196100ac-4eec-4fb6-a7f7-86c8b584771d",
        "workerName": "string"
      },
      "accountId": "string",
      "args": ["string"],
      "env": {
        "property1": "string",
        "property2": "string"
      },
      "status": "Running",
      "componentVersion": 0,
      "retryCount": 0,
      "pendingInvocationCount": 0,
      "updates": [
        {
          "type": "pendingUpdate",
          "timestamp": "2019-08-24T14:15:22Z",
          "targetVersion": 0
        }
      ],
      "createdAt": "2019-08-24T14:15:22Z",
      "lastError": "string"
    }
  ],
  "cursor": 0
}

Resume a worker

Example Response JSON

{}

Update a worker

Example Request JSON

{
  "mode": "Automatic",
  "targetVersion": 0
}

Example Response JSON

{}

Worker API Errors