Luna Index Manager API (v.0.4.0)

Download OpenAPI specification:Download

Service is intended for managing the process of creating indexes.

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

request identifier.

Responses

Response samples

Content type
application/json
{
  • "Version": {
    }
}

queue

get queue

Get indexing tasks from the pending queue.

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

request identifier.

Responses

Response samples

Content type
application/json
{
  • "task_ids": [
    ],
  • "count": 1
}

tasks

get tasks

Get indexing tasks info.

query Parameters
task_ids
Array of strings <uuid> (uuid)
Example: task_ids=557d54ec-29ad-4f3c-93b4-c9092ef12515

Task IDs to search for.

statuses
Array of strings (task_status)
Items Enum: "pending" "indexing" "success" "error"
Example: statuses=pending,indexing

Task statuses to search for.

start_time__gte
string <date-time> (time)
Example: start_time__gte=2018-08-11T09:11:41.674Z

Index building start time lower including bound in RFC 3339 format.

indexer
string
Example: indexer=http://127.0.0.1:5180

Origin of the indexer that build the index for task.

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

request identifier.

Responses

Response samples

Content type
application/json
{
  • "tasks": [
    ]
}

create task

Create new indexing task.

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

request identifier.

Request Body schema: application/json
task_type
required
string
required
object (list_task_content)

Responses

Request samples

Content type
application/json
{
  • "task_type": "list",
  • "content": {
    }
}

Response samples

Content type
application/json
{
  • "task_id": "557d54ec-29ad-4f3c-93b4-c9092ef12515"
}

remove tasks

Remove indexing tasks.

query Parameters
task_ids
Array of strings <uuid> (uuid)
Example: task_ids=557d54ec-29ad-4f3c-93b4-c9092ef12515

Task IDs to search for.

statuses
Array of strings (task_status)
Items Enum: "pending" "indexing" "success" "error"
Example: statuses=pending,indexing

Task statuses to search for.

start_time__gte
string <date-time> (time)
Example: start_time__gte=2018-08-11T09:11:41.674Z

Index building start time lower including bound in RFC 3339 format.

indexer
string
Example: indexer=http://127.0.0.1:5180

Origin of the indexer that build the index for task.

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

request identifier.

Responses

Response samples

Content type
application/json
{}

indexes

get indexes

Get info about stored indexes.

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

request identifier.

Responses

Response samples

Content type
application/json
{
  • "indexes": [
    ],
  • "count": 1
}

remove index

Remove index by ID.

path Parameters
index_id
required
string <uuid> (uuid) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...
Example: 557d54ec-29ad-4f3c-93b4-c9092ef12515

Index 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

request identifier.

Responses

Response samples

Content type
application/json
{}

get most relevant indexes

Get most relevant indexes for all the labels.

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

request identifier.

Responses

Response samples

Content type
application/json
{
  • "label_indexes": [
    ]
}

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

request identifier.

Accept
required
string
Enum: "application/x-yaml" "text/html"

acceptable type of receiving data

Responses

Response samples

Content type
application/json
{}

get development manual

Get sphinx documentation - Development Manual. After the request you will be redirected to the page /docs/dev/index.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

request identifier.

Responses

Response samples

Content type
application/json
{}

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

request identifier.

Accept
string
Enum: "application/json" "text/plain"

acceptable type of receiving data

Responses

Response samples

Content type
{
  • "INFLUX_MONITORING": {
    }
}

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

request identifier.

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0.123
}

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

request identifier.

Responses

Response samples

Content type
application/json
{
  • "plugins": [
    ]
}

metrics

get service requests statistics

Get statistics of success and failed requests to the service in prometheus format.

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

request identifier.

Responses

Response samples

Content type
text/plain
# HELP request_count_total Counter of requests
# TYPE request_count_total counter
request_count_total{path="GET:/healthcheck",status_code="200"} 1.0