mirror of
https://github.com/scylladb/scylladb.git
synced 2026-06-06 23:13:15 +00:00
771f818ed0
This adds the Swagger definition file for the compaction_manager. It is based on the CompactionManagerMBean and contains the following command: get_compactions get_compaction_summary force_user_defined_compaction stop_compaction Signed-off-by: Amnon Heiman <amnon@cloudius-systems.com>
126 lines
3.9 KiB
JSON
126 lines
3.9 KiB
JSON
{
|
|
"apiVersion":"0.0.1",
|
|
"swaggerVersion":"1.2",
|
|
"basePath":"{{Protocol}}://{{Host}}",
|
|
"resourcePath":"/compaction_manager",
|
|
"produces":[
|
|
"application/json"
|
|
],
|
|
"apis":[
|
|
{
|
|
"path":"/compaction_manager/compactions",
|
|
"operations":[
|
|
{
|
|
"method":"GET",
|
|
"summary":"get List of running compactions",
|
|
"type":"array",
|
|
"items":{
|
|
"type":"jsonmap"
|
|
},
|
|
"nickname":"get_compactions",
|
|
"produces":[
|
|
"application/json"
|
|
],
|
|
"parameters":[
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path":"/compaction_manager/compaction_summary",
|
|
"operations":[
|
|
{
|
|
"method":"GET",
|
|
"summary":"get compaction summary",
|
|
"type":"array",
|
|
"items":{
|
|
"type":"string"
|
|
},
|
|
"nickname":"get_compaction_summary",
|
|
"produces":[
|
|
"application/json"
|
|
],
|
|
"parameters":[
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path":"/compaction_manager/force_user_defined_compaction",
|
|
"operations":[
|
|
{
|
|
"method":"POST",
|
|
"summary":"Triggers the compaction of user specified sstables. You can specify files from various keyspaces and columnfamilies. If you do so, user defined compaction is performed several times to the groups of files in the same keyspace/columnfamily. must contain keyspace and columnfamily name in path(for 2.1+) or file name itself.",
|
|
"type":"void",
|
|
"nickname":"force_user_defined_compaction",
|
|
"produces":[
|
|
"application/json"
|
|
],
|
|
"parameters":[
|
|
{
|
|
"name":"data_files",
|
|
"description":"a comma separated list of sstable file to compact. must contain keyspace and columnfamily name in path(for 2.1+) or file name itself",
|
|
"required":true,
|
|
"allowMultiple":false,
|
|
"type":"string",
|
|
"paramType":"query"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path":"/compaction_manager/stop_compaction",
|
|
"operations":[
|
|
{
|
|
"method":"POST",
|
|
"summary":"Stop all running compaction-like tasks having the provided type",
|
|
"type":"void",
|
|
"nickname":"stop_compaction",
|
|
"produces":[
|
|
"application/json"
|
|
],
|
|
"parameters":[
|
|
{
|
|
"name":"type",
|
|
"description":"the type of compaction to stop. Can be one of: - COMPACTION - VALIDATION - CLEANUP - SCRUB - INDEX_BUILD",
|
|
"required":true,
|
|
"allowMultiple":false,
|
|
"type":"string",
|
|
"paramType":"string"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"models":{
|
|
"mapper":{
|
|
"id":"mapper",
|
|
"description":"A key value mapping",
|
|
"properties":{
|
|
"key":{
|
|
"type":"string",
|
|
"description":"The key"
|
|
},
|
|
"value":{
|
|
"type":"string",
|
|
"description":"The value"
|
|
}
|
|
}
|
|
},
|
|
"jsonmap":{
|
|
"id":"jsonmap",
|
|
"description":"A json representation of a map as a list of key value",
|
|
"properties":{
|
|
"value":{
|
|
"type":"array",
|
|
"items":{
|
|
"type":"mapper"
|
|
},
|
|
"description":"A list of key, value mapping"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
} |