Download OpenAPI specification:Download
'VisionLabs Luna-Index-Meta-Manager'
Service is intended for managing the process of creating indexes.
get service version
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. |
{- "Version": {
- "api": 0,
- "major": 0,
- "minor": 0,
- "patch": 0
}
}
Get indexing tasks from the pending queue.
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. |
{- "task_ids": [
- "557d54ec-29ad-4f3c-93b4-c9092ef12515"
], - "count": 1
}
Get indexing tasks info.
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. |
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. |
{- "tasks": [
- {
- "task_id": "557d54ec-29ad-4f3c-93b4-c9092ef12515",
- "status": "indexing",
- "create_time": "2018-08-11T09:11:41.674+03:00",
- "start_time": "2018-08-11T09:11:41.674+03:00",
- "end_time": "2018-08-11T09:11:41.674+03:00",
- "indexer": "string",
- "error": {
- "error_code": 1,
- "detail": "Internal server error",
- "desc": "Internal server error",
}, - "content": {
- "list_id": "557d54ec-29ad-4f3c-93b4-c9092ef12515"
}
}
]
}
Create new indexing task.
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. |
task_type required | string list list |
required | object (list_task_content) |
{- "task_type": "list",
- "content": {
- "list_id": "557d54ec-29ad-4f3c-93b4-c9092ef12515"
}
}
{- "task_id": "557d54ec-29ad-4f3c-93b4-c9092ef12515"
}
Remove indexing tasks.
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. |
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. |
{- "error_code": 12022,
- "desc": "Bad/incomplete input data",
- "detail": "Failed to validate query parameters. Path: 'handler_id', message: 'Extra inputs are not permitted",
}
Get info about stored indexes.
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. |
{- "indexes": [
- {
- "index_id": "557d54ec-29ad-4f3c-93b4-c9092ef12515",
- "index_type": "list",
- "label": "557d54ec-29ad-4f3c-93b4-c9092ef12515",
- "descriptor_version": 59
}
], - "count": 1
}
Remove index by ID.
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. |
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. |
{- "error_code": 26204,
- "desc": "Object not found",
- "detail": "Index with id '7acc35cf-a3b2-4f87-8d8b-5496a2782d37' not found in the storage",
}
Get most relevant indexes for all the labels.
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. |
{- "label_indexes": [
- {
- "label": "557d54ec-29ad-4f3c-93b4-c9092ef12515",
- "index": {
- "index_id": "557d54ec-29ad-4f3c-93b4-c9092ef12515",
- "index_type": "list",
- "descriptor_version": 59
}
}
]
}
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
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 |
{- "error_code": 12024,
- "detail": "Bad/incomplete input data",
- "desc": "Unsupported media type",
}
Get sphinx documentation - Development Manual. After the request you will be redirected to the page /docs/dev/index.html
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. |
{- "error_code": 1,
- "detail": "Internal server error",
- "desc": "Internal server error",
}
Get service configuration. Passwords and tokens will be hidden in the response.
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 |
{- "INFLUX_MONITORING": {
- "SEND_DATA_FOR_MONITORING": 0,
- "VERSION": 2,
- "ORGANIZATION": "ORGANIZATION_NAME",
- "TOKEN": "********",
- "BUCKET": "luna_monitoring",
- "HOST": "127.0.0.1",
- "PORT": 8086,
- "USE_SSL": 0,
- "FLUSHING_PERIOD": 1
}
}
Get health of service.
include_luna_services | integer Default: 0 Enum: 0 1 whether to perform healthchecks for dependent luna services. |
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. |
{- "execution_time": 0.123
}
Get list of service plugins:
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. |
{- "plugins": [
- {
- "name": "string",
- "running": 0
}
]
}