Luna Serving (v.0.1.18)

Download OpenAPI specification:

'Luna Serving'

version

get version

get service version

header Parameters

Luna-Request-Id

string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4...

Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a

external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

200
500

Content type

application/json

{"Version": {"api": 1,
"major": 0,
"minor": 0,
"patch": 0
}
}

documents

get openapi documentation

Get service OpenApi documentation. If Accept request header is of type application/x-yaml, returns documentation in yaml format or returns html documentation, if Accept-Type is text/html

header Parameters

Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.
Accept required	string (accept_docs_handler) Enum: "application/x-yaml" "text/html" acceptable type of receiving data

Responses

Response samples

415
500

Content type

application/json

{"error_code": 12024,
"detail": "Bad/incomplete input data",
"desc": "Unsupported media type",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12024"
}

get development manual

Get sphinx documentation - Development Manual. After the request you will be redirected to the page /docs/dev/index.html

header Parameters

Accept	string Value: "application/json" Preferred response content type
Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

500

Content type

application/json

{"error_code": 1,
"detail": "internal server error",
"desc": "internal server error",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-1"
}

config

get service configuration

Get service configuration. Passwords and tokens will be hidden in the response.

header Parameters

Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.
Accept	string Enum: "application/json" "text/plain" acceptable type of receiving data

Responses

Response samples

200
415
500

Content type

application/json

{"INFLUX_MONITORING": {"SEND_DATA_FOR_MONITORING": 0,
"ORGANIZATION": "ORGANIZATION_NAME",
"TOKEN": "********",
"BUCKET": "luna_monitoring",
"HOST": "127.0.0.1",
"PORT": 8086,
"USE_SSL": 0,
"FLUSHING_PERIOD": 1
}
}

service

create service

Create service.

header Parameters

Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.
Content-Type	string Value: "application/json" Content type is `application/json`.
Luna-Account-Id required	string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: 557d54ec-29ad-4f3c-93b4-c9092ef12515 Account ID.

Request Body schema: application/json
required

service_name required	string (service_name) [ 3 .. 128 ] characters ^[a-zA-Z0-9_-]*$ Unique user service name.
addresses required	Array of strings <uri> (service_addresses) non-empty [ items <uri > ] lists of urls for service
description	string (service_description) <= 512 characters Default: "" Service description.
shared	integer (service_shared) [ 0 .. 1 ] Default: 0 Shared service means that any user can access service.
	object (healthcheck) Service healthcheck parameters. For a service to be considered alive, a request to `route` must return a response with status code `2xx` or `3xx`

Responses

Request samples

Payload

Content type

application/json

{"service_name": "sanic_service1",
"addresses": ["http://127.0.0.1:8000"
],
"description": "Greate service.",
"shared": 0,
"healthcheck": {"healthcheck": 0,
"route": "/healthcheck",
"interval": 10,
"timeout": 3
}
}

Response samples

201
400
409
500

Content type

application/json

{"service_id": "557d54ec-29ad-4f3c-93b4-c9092ef12515",
"service_name": "sanic_service1"
}

get services

Get service list.

query Parameters

account_id	string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: account_id=8950722f-3fd4-4223-b48f-03f95f0e8dfb Account ID.
service_names	Array of strings (service_name) [ items [ 3 .. 128 ] characters ^[a-zA-Z0-9_-]*$ ] Example: service_names=name1,name2 Service name filter.
page	integer >= 1 Default: 1 Page number.
page_size	integer [ 1 .. 1000 ] Default: 10 Number of items on page.
create_time__gte	string <date-time> (time) Example: create_time__gte=2021-09-21T11:11:41.674Z Entity create time lower including bound filter in RFC 3339 format. Only entities with the creation time greater than or equal to the specified boundary will be returned in the response.
create_time__lt	string <date-time> (time) Example: create_time__lt=2021-09-21T19:11:41.674Z Entity create time upper excluding bound filter in RFC 3339 format. Only entities with the creation time lower than the specified boundary will be returned in the response.
targets	string Default: "account_id,service_name,description,addresses,create_time,shared,healthcheck,health" Example: targets=service_name,shared Comma-separated list of service target fields. Available targets: account_id, service_name, description, addresses, create_time, shared, healthcheck, health
shared	integer [ 0 .. 1 ] Shared service filter. Shared services are available for all users.

header Parameters

Luna-Request-Id

string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4...

Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a

external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

200
400
500

Content type

application/json

{"services": [{"service_name": "sanic_service1",
"description": "Greate service.",
"account_id": "557d54ec-29ad-4f3c-93b4-c9092ef12515",
"create_time": "2018-08-11T09:11:41Z",
"addresses": ["http://127.0.0.1:8000"
],
"shared": 0,
"healthcheck": {"healthcheck": 0,
"route": "/healthcheck",
"interval": 10,
"timeout": 3
},
"health": {"property1": "up",
"property2": "up"
}
}
]
}

get service

Get service by name.

path Parameters

service_name

required

string (service_name) [ 3 .. 128 ] characters ^[a-zA-Z0-9_-]*$

Example: sanic_service1

Name of the service.

query Parameters

account_id

string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: account_id=8950722f-3fd4-4223-b48f-03f95f0e8dfb

Account ID.

header Parameters

Luna-Request-Id

string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4...

Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a

external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

200
404
500

Content type

application/json

{"service_name": "sanic_service1",
"description": "Greate service.",
"account_id": "557d54ec-29ad-4f3c-93b4-c9092ef12515",
"create_time": "2018-08-11T09:11:41Z",
"addresses": ["http://127.0.0.1:8000"
],
"shared": 0,
"healthcheck": {"healthcheck": 0,
"route": "/healthcheck",
"interval": 10,
"timeout": 3
},
"health": {"property1": "up",
"property2": "up"
}
}

delete service

delete service.

path Parameters

service_name

required

string (service_name) [ 3 .. 128 ] characters ^[a-zA-Z0-9_-]*$

Example: sanic_service1

Name of the service.

header Parameters

Luna-Request-Id

string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4...

Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a

external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

404
500

Content type

application/json

{"error_code": 52001,
"desc": "Object not found",
"detail": "Service with name `nonexists` not found",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-52001"
}

traefik

get Traefik config Internal

Warning: only for Traefik use

Get JSON Traefik configuration

Responses

Response samples

200
500

Content type

application/json

{"http": {"routers": {"service1": {"rule": "PathPrefix(`/service1`)",
"entryPoints": ["web"
],
"service": "service1",
"middlewares": ["stripFirstSegment"
]
}
},
"services": {"service1": {"loadBalancer": {"servers": [{"url": "http://127.0.0.1:8000"
}
]
}
}
},
"middlewares": {"stripFirstSegment": {"replacePathRegex": {"regex": "^/[^/]+/(.*)",
"replacement": "/$1"
}
}
}
}
}

plugins

get list of plugins

Get list of service plugins

header Parameters

Luna-Request-Id

string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4...

Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a

external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

200
500

Content type

application/json

{"plugins": [{"name": "foo",
"running": 1
}
]
}

health

get health

get health of service

query Parameters

include_luna_services

integer

Default: 0

Enum: 0 1

Whether to perform healthchecks for dependent luna services.

header Parameters

Luna-Request-Id

string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4...

Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a

external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

200
500
502

Content type

application/json

{"execution_time": 0.123
}

Luna Serving (v.0.1.18)

version

get version

header Parameters

Responses

Response samples

documents

get openapi documentation

header Parameters

Responses

Response samples

get development manual

header Parameters

Responses

Response samples

config

get service configuration

header Parameters

Responses

Response samples

service

create service

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

get services

query Parameters

header Parameters

Responses

Response samples

get service

path Parameters

query Parameters

header Parameters

Responses

Response samples

delete service

path Parameters

header Parameters

Responses

Response samples

traefik

get Traefik config Internal

Responses

Response samples

plugins

get list of plugins

header Parameters

Responses

Response samples

health

get health

query Parameters

header Parameters

Responses

Response samples

Request Body schema: application/json
required