JinaD (Daemon) (1.2.3)

Download OpenAPI specification:Download

REST interface for managing distributed Jina

daemon

API to manage the Daemon

Home

The instruction HTML when user visits / directly

.. #noqa: DAR201

Responses

Request samples

curl --request GET \
  --url http://localhost:8000/

Response samples

Content type
application/json
null

Get the status of the daemon

Responses

Request samples

curl --request GET \
  --url http://localhost:8000/status

Response samples

Content type
application/json
{
  • "jina": { },
  • "envs": { },
  • "peas": {
    },
  • "pods": {
    },
  • "flows": {
    },
  • "workspaces": {
    },
  • "used_memory": "string"
}

flows

API to manage Flows

Get all alive Flows' status

Responses

Request samples

curl --request GET \
  --url http://localhost:8000/flows

Response samples

Content type
application/json
{
  • "size": 0,
  • "time_created": "2019-08-24T14:15:22Z",
  • "time_updated": "2019-08-24T14:15:22Z",
  • "num_add": 0,
  • "num_del": 0,
  • "items": {
    }
}

Create a Flow from a YAML config

Request Body schema: multipart/form-data
flow
required
string <binary> (Flow)
workspace_id
string <uuid> (Workspace Id)

Responses

Request samples

curl --request POST \
  --url http://localhost:8000/flows \
  --header 'content-type: multipart/form-data'

Response samples

Content type
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Terminate all running Flows

Responses

Request samples

curl --request DELETE \
  --url http://localhost:8000/flows

Response samples

Content type
application/json
null

Get all accept arguments of a Flow

Responses

Request samples

curl --request GET \
  --url http://localhost:8000/flows/arguments

Response samples

Content type
application/json
null

Get the status of a running Flow

path Parameters
id
required
string <uuid> (Id)

Responses

Request samples

curl --request GET \
  --url http://localhost:8000/flows/%7Bid%7D

Response samples

Content type
application/json
{
  • "time_created": "2019-08-24T14:15:22Z",
  • "arguments": { },
  • "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
  • "workdir": "string",
  • "yaml_source": "string"
}

Run an update operation on the Flow object

Types supported: "rolling_update" and "dump"

path Parameters
id
required
string <uuid> (Id)
query Parameters
kind
required
object (UpdateOperationEnum)
Enum: "rolling_update" "dump"

Represents the type of operation to perform in the update

We consider these an update operation since they change the underlying state

dump_path
required
string (Dump Path)
pod_name
required
string (Pod Name)
shards
integer (Shards)

Responses

Request samples

curl --request PUT \
  --url 'http://localhost:8000/flows/%7Bid%7D?kind=SOME_OBJECT_VALUE&dump_path=SOME_STRING_VALUE&pod_name=SOME_STRING_VALUE&shards=SOME_INTEGER_VALUE'

Response samples