mirror of
https://github.com/cgrates/cgrates.git
synced 2026-02-19 22:28:45 +05:00
Console command to reload cache, documentation for apier on cache and scheduler, various small fixes
This commit is contained in:
66
docs/api_cache.rst
Normal file
66
docs/api_cache.rst
Normal file
@@ -0,0 +1,66 @@
|
||||
Cache APIs
|
||||
==========
|
||||
|
||||
Set of cache related APIs.
|
||||
|
||||
|
||||
ApierV1.ReloadCache
|
||||
-------------------
|
||||
|
||||
Used to enforce a cache reload. It can be fine tuned to reload individual destinations and rating plans. In order to reload all destinations and/or rating plans, one can use empty list or null values instead.
|
||||
|
||||
**Request**:
|
||||
|
||||
Data:
|
||||
|
||||
::
|
||||
|
||||
type ApiReloadCache struct {
|
||||
DestinationIds []string
|
||||
RatingPlanIds []string
|
||||
}
|
||||
|
||||
Mandatory parameters: none
|
||||
|
||||
*JSON sample*:
|
||||
::
|
||||
|
||||
{
|
||||
"id": 1,
|
||||
"method": "ApierV1.ReloadCache",
|
||||
"params": [
|
||||
{
|
||||
"DestinationIds": [
|
||||
"GERMANY",
|
||||
"GERMANY_MOBILE",
|
||||
"FS_USERS"
|
||||
],
|
||||
"RatingPlanIds": [
|
||||
"RETAIL1"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
**Reply**:
|
||||
|
||||
Data:
|
||||
::
|
||||
|
||||
string
|
||||
|
||||
Possible answers:
|
||||
* *OK*
|
||||
|
||||
*JSON sample*:
|
||||
::
|
||||
|
||||
{
|
||||
"error": null,
|
||||
"id": 1,
|
||||
"result": "OK"
|
||||
}
|
||||
|
||||
**Errors**:
|
||||
|
||||
``SERVER_ERROR`` - Server error occurred.
|
||||
Reference in New Issue
Block a user