Files
scylladb/api/api-doc/cache_service.json
Amnon Heiman d4b5e65b7c API Adding the cache_service definition file
This adds the definition file for the cache service, the API is based on
the CacheServiceMBean definition and contain the following command:
get_row_cache_save_period_in_seconds
set_row_cache_save_period_in_seconds
get_key_cache_save_period_in_seconds
set_key_cache_save_period_in_seconds
get_counter_cache_save_period_in_seconds
set_counter_cache_save_period_in_seconds
get_row_cache_keys_to_save
set_row_cache_keys_to_save
get_key_cache_keys_to_save
set_key_cache_keys_to_save
get_counter_cache_keys_to_save
set_counter_cache_keys_to_save
invalidate_key_cache
invalidate_counter_cache
set_row_cache_capacity_in_mb
set_key_cache_capacity_in_mb
set_counter_cache_capacity_in_mb
save_caches

Signed-off-by: Amnon Heiman <amnon@cloudius-systems.com>
2015-06-24 14:29:22 +03:00

342 lines
10 KiB
JSON

{
"apiVersion":"0.0.1",
"swaggerVersion":"1.2",
"basePath":"{{Protocol}}://{{Host}}",
"resourcePath":"/cache_service",
"produces":[
"application/json"
],
"apis":[
{
"path":"/cache_service/row_cache_save_period",
"operations":[
{
"method":"GET",
"summary":"get row cache save period in seconds",
"type":"int",
"nickname":"get_row_cache_save_period_in_seconds",
"produces":[
"application/json"
],
"parameters":[
]
},
{
"method":"POST",
"summary":"set row cache save period in seconds",
"type":"void",
"nickname":"set_row_cache_save_period_in_seconds",
"produces":[
"application/json"
],
"parameters":[
{
"name":"period",
"description":"row cache save period in seconds",
"required":true,
"allowMultiple":false,
"type":"int",
"paramType":"query"
}
]
}
]
},
{
"path":"/cache_service/key_cache_save_period",
"operations":[
{
"method":"GET",
"summary":"get key cache save period in seconds",
"type":"int",
"nickname":"get_key_cache_save_period_in_seconds",
"produces":[
"application/json"
],
"parameters":[
]
},
{
"method":"POST",
"summary":"set key cache save period in seconds",
"type":"void",
"nickname":"set_key_cache_save_period_in_seconds",
"produces":[
"application/json"
],
"parameters":[
{
"name":"period",
"description":"key cache save period in seconds",
"required":true,
"allowMultiple":false,
"type":"int",
"paramType":"query"
}
]
}
]
},
{
"path":"/cache_service/counter_cache_save_period",
"operations":[
{
"method":"GET",
"summary":"get counter cache save period in seconds",
"type":"int",
"nickname":"get_counter_cache_save_period_in_seconds",
"produces":[
"application/json"
],
"parameters":[
]
},
{
"method":"POST",
"summary":"set counter cache save period in seconds",
"type":"void",
"nickname":"set_counter_cache_save_period_in_seconds",
"produces":[
"application/json"
],
"parameters":[
{
"name":"ccspis",
"description":"counter cache save period in seconds",
"required":true,
"allowMultiple":false,
"type":"int",
"paramType":"query"
}
]
}
]
},
{
"path":"/cache_service/row_cache_keys_to_save",
"operations":[
{
"method":"GET",
"summary":"get row cache keys to save",
"type":"int",
"nickname":"get_row_cache_keys_to_save",
"produces":[
"application/json"
],
"parameters":[
]
},
{
"method":"POST",
"summary":"set row cache keys to save",
"type":"void",
"nickname":"set_row_cache_keys_to_save",
"produces":[
"application/json"
],
"parameters":[
{
"name":"rckts",
"description":"row cache keys to save",
"required":true,
"allowMultiple":false,
"type":"int",
"paramType":"query"
}
]
}
]
},
{
"path":"/cache_service/key_cache_keys_to_save",
"operations":[
{
"method":"GET",
"summary":"get key cache keys to save",
"type":"int",
"nickname":"get_key_cache_keys_to_save",
"produces":[
"application/json"
],
"parameters":[
]
},
{
"method":"POST",
"summary":"set key cache keys to save",
"type":"void",
"nickname":"set_key_cache_keys_to_save",
"produces":[
"application/json"
],
"parameters":[
{
"name":"kckts",
"description":"key cache keys to save",
"required":true,
"allowMultiple":false,
"type":"int",
"paramType":"query"
}
]
}
]
},
{
"path":"/cache_service/counter_cache_keys_to_save",
"operations":[
{
"method":"GET",
"summary":"get counter cache keys to save",
"type":"int",
"nickname":"get_counter_cache_keys_to_save",
"produces":[
"application/json"
],
"parameters":[
]
},
{
"method":"POST",
"summary":"set counter cache keys to save",
"type":"void",
"nickname":"set_counter_cache_keys_to_save",
"produces":[
"application/json"
],
"parameters":[
{
"name":"cckts",
"description":"counter cache keys to save",
"required":true,
"allowMultiple":false,
"type":"int",
"paramType":"query"
}
]
}
]
},
{
"path":"/cache_service/invalidate_key_cache",
"operations":[
{
"method":"POST",
"summary":"invalidate the key cache; for use after invalidating row cache",
"type":"void",
"nickname":"invalidate_key_cache",
"produces":[
"application/json"
],
"parameters":[
]
}
]
},
{
"path":"/cache_service/invalidate_counter_cache",
"operations":[
{
"method":"POST",
"summary":"invalidate counter cache",
"type":"void",
"nickname":"invalidate_counter_cache",
"produces":[
"application/json"
],
"parameters":[
]
}
]
},
{
"path":"/cache_service/row_cache_capacity",
"operations":[
{
"method":"POST",
"summary":"set row cache capacity in mb",
"type":"void",
"nickname":"set_row_cache_capacity_in_mb",
"produces":[
"application/json"
],
"parameters":[
{
"name":"capacity",
"description":"row cache capacity in mb",
"required":true,
"allowMultiple":false,
"type":"long",
"paramType":"query"
}
]
}
]
},
{
"path":"/cache_service/key_cache_capacity",
"operations":[
{
"method":"POST",
"summary":"set key cache capacity in mb",
"type":"void",
"nickname":"set_key_cache_capacity_in_mb",
"produces":[
"application/json"
],
"parameters":[
{
"name":"capacity",
"description":"key cache capacity in mb",
"required":true,
"allowMultiple":false,
"type":"long",
"paramType":"query"
}
]
}
]
},
{
"path":"/cache_service/counter_cache_capacity",
"operations":[
{
"method":"POST",
"summary":"set counter cache capacity in mb",
"type":"void",
"nickname":"set_counter_cache_capacity_in_mb",
"produces":[
"application/json"
],
"parameters":[
{
"name":"capacity",
"description":"counter cache capacity in mb",
"required":true,
"allowMultiple":false,
"type":"long",
"paramType":"query"
}
]
}
]
},
{
"path":"/cache_service/save_caches",
"operations":[
{
"method":"POST",
"summary":"save row and key caches",
"type":"void",
"nickname":"save_caches",
"produces":[
"application/json"
],
"parameters":[
]
}
]
}
]
}