Home

Cyclops RC Wiki

Read Configuration guide for:

• Variable documentation configuration file guide

---

1. Rate of a resource

API: /rate
URL http://IP_Addr:PORT/{context_name}/rate
Type: Get
Headers: None (OAuth will be integrated in future release)
Parameters :
resourcename: String
from : Date (Ex: 2015-01-13 09:30:00)
to : Date (Ex: 2015-01-13 09:30:00)

Response Code : 200
Request : None

Example Response

{
 "time": {
   "to": "2015-01-12 01:10:00",
   "from": "2015-01-12 01:01:00"
 },
 "rate": {
   "network.incoming.bytes": [
     [
       1433721515910,
       349410940001,
       ".0000000000001"
     ],
     [
       1433721455908,
       349410900001,
       ".0000000000001"
     ]
   ]
 }
}

---

2. Status of the rate and rating policy

API: /rate/status
URL http://IP_Addr:PORT/{context_name}/rate/status
Type: Get
Headers: None (OAuth will be integrated in future release)
Parameters :
resourcename: String
from : Date (Ex: 2015-01-13 09:30:00)
to : Date (Ex: 2015-01-13 09:30:00)

Response Code : 200
Request : None

Example Responses

{
 "rate_policy": "dynamic",
 "rate": null
}

---

{
 "source" : "dashboard",
 "time" : "2015-03-17 17:34:45",
 "rate_policy" : "static",
 "rate" : {
     "resource1": 3,
     "resource2": 4
 }
}

---

3. Consolidated list of charge data records

API: /charge
URL http://IP_Addr:PORT/{context_name}/charge
Type: Get
Headers: None (OAuth will be integrated in future release)
Parameters :
userid: String
from : Date (Ex: 2015-01-13 09:30:00)
to : Date (Ex: 2015-01-13 09:30:00)

Response Code : 200
Request : None

Example Response

{
 "userid": "f83aa92bc3c64a3497b334cc712b0491",
 "time": {
   "to": "2015-06-15 23:59",
   "from": "2015-06-15 00:00"
 },
 "charge": {
   "columns": [
     "time",
     "sequence_number",
     "userid",
     "usage",
     "price",
     "resource"
   ],
   "points": [
     [
       1434355851689,
       413208650001,
       "f83aa92bc3c64a3497b334cc712b0491",
       177576860000000,
       364077180301507.56,
       "cpu"
     ],
     [
       1434355851689,
       413208640001,
       "f83aa92bc3c64a3497b334cc712b0491",
       177576860000000,
       364077180301507.56,
       "cpu"
     ]
   ]
 }
}

---

4. Scheduler for Rate and CDR generation

API: /scheduler/{command}
URL: http://IP_Addr:PORT/{context_name}/scheduler/{command}
Commands: start, stop, restart, status, force
Type: Get
Headers: None (OAuth will be integrated in future release)
Parameters : None
Response Code : 200
Request : None

---

5. Manual Rate generation

API: /generate/{action}
URL http://IP_Addr:PORT/{context_name}/generate/rate
Type: Get
Headers: None (OAuth will be integrated in future release)
Parameters : None
Response Code : 200
Request : None

Example Response

The rate generation was successful

---

6. Manual CDR generation

API: /generate/{action}
URL http://IP_Addr:PORT/{context_name}/generate/cdr
Type: Get
Headers: None (OAuth will be integrated in future release)
Parameters : None
Response Code : 200
Request : None

Example Response

The cdr generation was successful