polling¶
Summary¶
Resource | Operation | Description |
---|---|---|
Polling | GET /api/app/v1/polling/bandwidth | Get bandwidth stats |
GET /api/app/v1/polling/cpu | Get CPU stats | |
GET /api/app/v1/polling/disk | Get diskspace | |
GET /api/app/v1/polling/diskio | Get diskio stats | |
GET /api/app/v1/polling/mem | Get memory usage stats |
Details¶
-
GET
/api/app/v1/polling/bandwidth
¶ Get bandwidth stats for a module and appliance interfaces.
New in version 1.0.
Response Headers: - Content-Type – application/json
Status Codes: - 200 OK – Success - bandwidth stats
- 401 Unauthorized – Access Denied
Accepted Authorization: admin, audit
Example 1 - Request: Get appliance bandwidth stats:
GET /api/app/v1/polling/bandwidth HTTP/1.1 Accept: text/html
Example 1 - Response: Get appliance bandwidth stats:
HTTP/1.1 200 OK Content-Type: application/json { "Bonded Interfaces E2, P2": { "b_recv": "84325549", "b_sent": "2059375", "drop_in": "4325", "drop_out": "0", "err_in": "0", "err_out": "0", "in": "0.01", "mac_addr": "44:a8:42:48:2a:9c", "out": "0.00", "p_recv": "100979", "p_sent": "32028", "speed": "1000Mb/s", "status": "True" }, "C": { "b_recv": "10550315", "b_sent": "9359403", "drop_in": "32", "drop_out": "0", "err_in": "0", "err_out": "0", "in": "0.02", "mac_addr": "2e:c7:08:36:99:8c", "out": "0.03", "p_recv": "76028", "p_sent": "65276", "speed": "0Mb/s", "status": "True" }, "N": { "b_recv": "342", "b_sent": "2883142", "drop_in": "0", "drop_out": "0", "err_in": "0", "err_out": "0", "in": "0.00", "mac_addr": "96:08:83:f5:e6:15", "out": "0.01", "p_recv": "5", "p_sent": "37346", "speed": "10000Mb/s", "status": "True" }, "P1": { "b_recv": "3114", "b_sent": "1397298", "drop_in": "0", "drop_out": "0", "err_in": "0", "err_out": "0", "in": "0.00", "mac_addr": "7e:ee:e7:70:e2:45", "out": "0.00", "p_recv": "35", "p_sent": "18096", "speed": "10000Mb/s", "status": "True" } }
-
GET
/api/app/v1/polling/cpu
¶ Get CPU usage stats.
New in version 1.0.
Response Headers: - Content-Type – application/json
Status Codes: - 200 OK – Success - CPU stats
- 401 Unauthorized – Access Denied
Accepted Authorization: admin, audit
Example 1 - Request: Get CPU stats:
GET /api/app/v1/polling/cpu HTTP/1.1 Accept: text/html
Example 1 - Response: Get CPU stats:
HTTP/1.1 200 OK Content-Type: application/json { "cpu_usage": [ "Total=2.8%", "CPU-0=2.0%", "CPU-1=1.0%", "CPU-2=2.0%", "CPU-3=0.0%", "CPU-4=3.0%", "CPU-5=0.0%", "CPU-6=5.0%", "CPU-7=1.0%", "CPU-8=1.0%", "CPU-9=1.0%", "CPU-10=2.0%", "CPU-11=0.0%", "CPU-12=0.0%", "CPU-13=1.0%", "CPU-14=0.0%", "CPU-15=0.0%", "CPU-16=0.0%", "CPU-17=1.0%", "CPU-18=0.0%", "CPU-19=0.0%", "CPU-20=0.0%", "CPU-21=1.0%", "CPU-22=1.0%", "CPU-23=1.0%" ] }
-
GET
/api/app/v1/polling/disk
¶ Get diskspace.
New in version 1.0.
Response Headers: - Content-Type – application/json
Status Codes: - 200 OK – Success - diskspace
- 401 Unauthorized – Access Denied
Accepted Authorization: admin, audit
Example 1 - Request: Get diskspace:
GET /api/app/v1/polling/disk HTTP/1.1 Accept: text/html
Example 1 - Response: Get diskspace:
HTTP/1.1 200 OK Content-Type: application/json { "Fingerprinting": { "free": "16G", "rate": "0%", "total": "16G", "used": "0" }, "Proxy Cache": { "free": "16G", "rate": "0%", "total": "16G", "used": "0" }, "System": { "free": "92G", "rate": "21%", "total": "120G", "used": "24G" } }
-
GET
/api/app/v1/polling/diskio
¶ Get diskio stats.
New in version 1.0.
Response Headers: - Content-Type – application/json
Status Codes: - 200 OK – Success - diskio stats
- 401 Unauthorized – Access Denied
Accepted Authorization: admin, audit
Example 1 - Request: Get diskio stats:
GET /api/app/v1/polling/diskio HTTP/1.1 Accept: text/html
Example 1 - Response: Get diskio stats:
HTTP/1.1 200 OK Content-Type: application/json { "iops": { "Fingerprinting": "0io/s", "System": "326io/s" } }
-
GET
/api/app/v1/polling/mem
¶ Get memory usage stats.
New in version 1.0.
Response Headers: - Content-Type – application/json
Status Codes: - 200 OK – Success - memory usage stats
- 401 Unauthorized – Access Denied
Accepted Authorization: admin, audit
Example 1 - Request: Get memory usage stats:
GET /api/app/v1/polling/mem HTTP/1.1 Accept: text/html
Example 1 - Response: Get memory usage stats:
HTTP/1.1 200 OK Content-Type: application/json { "MTOTAL": "12599218176", "MUSED": "5814579200", "MUSEDPRC": "46" }