diff options
author | nicolargo <nicolas@nicolargo.com> | 2023-01-17 08:11:31 +0100 |
---|---|---|
committer | nicolargo <nicolas@nicolargo.com> | 2023-01-17 08:11:31 +0100 |
commit | 05aaee684c1ede557ebe616b5154cfd56ceb38e2 (patch) | |
tree | f85f923a33eb054809d370d447113612b8178e85 /docs/api.rst | |
parent | 3f54d086bc1c0d35a85a585de4eb0065805bd72e (diff) |
version 3.3.1.1v3.3.1.1
Diffstat (limited to 'docs/api.rst')
-rw-r--r-- | docs/api.rst | 910 |
1 files changed, 438 insertions, 472 deletions
diff --git a/docs/api.rst b/docs/api.rst index d60c548f..95829983 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -74,7 +74,7 @@ Get plugin stats:: "refresh": 3.0, "regex": True, "result": None, - "timer": 0.8425271511077881}, + "timer": 1.3811793327331543}, {"count": 0, "countmax": 20.0, "countmin": None, @@ -83,7 +83,7 @@ Get plugin stats:: "refresh": 3.0, "regex": True, "result": None, - "timer": 0.8423657417297363}] + "timer": 1.3809046745300293}] Get a specific field:: @@ -101,7 +101,7 @@ Get a specific item when field matchs the given value:: "refresh": 3.0, "regex": True, "result": None, - "timer": 0.8425271511077881}]} + "timer": 1.3811793327331543}]} GET core -------- @@ -131,19 +131,19 @@ Get plugin stats:: "ctx_switches": 0, "guest": 0.0, "guest_nice": 0.0, - "idle": 58.6, + "idle": 30.5, "interrupts": 0, - "iowait": 0.0, + "iowait": 2.7, "irq": 0.0, "nice": 0.0, "soft_interrupts": 0, - "softirq": 0.0, + "softirq": 0.4, "steal": 0.0, "syscalls": 0, - "system": 6.7, + "system": 15.4, "time_since_update": 1, - "total": 38.2, - "user": 34.7} + "total": 71.6, + "user": 51.0} Fields descriptions: @@ -166,7 +166,7 @@ Fields descriptions: Get a specific field:: # curl http://localhost:61208/api/3/cpu/total - {"total": 38.2} + {"total": 71.6} GET diskio ---------- @@ -215,7 +215,7 @@ Get plugin stats:: "Id": "3abd51c615968482d9ccff5afc629f267f6dda113ed68b75b432615fae3b49fb", "Image": ["portainer/portainer-ce:2.9.3"], "Status": "running", - "Uptime": "36 mins", + "Uptime": "2 days", "cpu": {"total": 0.0}, "cpu_percent": 0.0, "io": {}, @@ -237,7 +237,7 @@ Get plugin stats:: "Experimental": "false", "GitCommit": "42c8b31", "GoVersion": "go1.18.9", - "KernelVersion": "5.15.0-56-generic", + "KernelVersion": "5.15.0-58-generic", "MinAPIVersion": "1.12", "Os": "linux"}, "Name": "Engine", @@ -253,7 +253,7 @@ Get plugin stats:: "Version": "0.19.0"}], "GitCommit": "42c8b31", "GoVersion": "go1.18.9", - "KernelVersion": "5.15.0-56-generic", + "KernelVersion": "5.15.0-58-generic", "MinAPIVersion": "1.12", "Os": "linux", "Platform": {"Name": "Docker Engine - Community"}, @@ -266,13 +266,13 @@ Get plugin stats:: # curl http://localhost:61208/api/3/fs [{"device_name": "/dev/mapper/ubuntu--gnome--vg-root", - "free": 50442330112, + "free": 50925744128, "fs_type": "ext4", "key": "mnt_point", "mnt_point": "/", - "percent": 78.2, + "percent": 77.9, "size": 243334156288, - "used": 180504371200}, + "used": 180020957184}, {"device_name": "zsfpool", "free": 41811968, "fs_type": "zfs", @@ -291,13 +291,13 @@ Get a specific item when field matchs the given value:: # curl http://localhost:61208/api/3/fs/mnt_point// {"/": [{"device_name": "/dev/mapper/ubuntu--gnome--vg-root", - "free": 50442330112, + "free": 50925744128, "fs_type": "ext4", "key": "mnt_point", "mnt_point": "/", - "percent": 78.2, + "percent": 77.9, "size": 243334156288, - "used": 180504371200}]} + "used": 180020957184}]} GET ip ------ @@ -323,7 +323,7 @@ GET load Get plugin stats:: # curl http://localhost:61208/api/3/load - {"cpucore": 4, "min1": 1.31591796875, "min15": 1.9091796875, "min5": 1.6796875} + {"cpucore": 4, "min1": 5.16015625, "min15": 1.4462890625, "min5": 2.86181640625} Fields descriptions: @@ -335,7 +335,7 @@ Fields descriptions: Get a specific field:: # curl http://localhost:61208/api/3/load/min1 - {"min1": 1.31591796875} + {"min1": 5.16015625} GET mem ------- @@ -343,16 +343,16 @@ GET mem Get plugin stats:: # curl http://localhost:61208/api/3/mem - {"active": 2804523008, - "available": 2706178048, - "buffers": 264335360, - "cached": 3114909696, - "free": 2706178048, - "inactive": 3516907520, - "percent": 65.5, - "shared": 591532032, - "total": 7836188672, - "used": 5130010624} + {"active": 1636028416, + "available": 2916896768, + "buffers": 346234880, + "cached": 3074457600, + "free": 2916896768, + "inactive": 5099053056, + "percent": 62.8, + "shared": 534540288, + "total": 7836196864, + "used": 4919300096} Fields descriptions: @@ -371,7 +371,7 @@ Fields descriptions: Get a specific field:: # curl http://localhost:61208/api/3/mem/total - {"total": 7836188672} + {"total": 7836196864} GET memswap ----------- @@ -379,13 +379,13 @@ GET memswap Get plugin stats:: # curl http://localhost:61208/api/3/memswap - {"free": 2626473984, - "percent": 67.5, - "sin": 4755005440, - "sout": 11063549952, + {"free": 8073506816, + "percent": 0.1, + "sin": 86016, + "sout": 8327168, "time_since_update": 1, "total": 8082419712, - "used": 5455945728} + "used": 8912896} Fields descriptions: @@ -409,29 +409,29 @@ Get plugin stats:: # curl http://localhost:61208/api/3/network [{"alias": None, - "cumulative_cx": 398215554, - "cumulative_rx": 199107777, - "cumulative_tx": 199107777, - "cx": 3314, + "cumulative_cx": 9534394, + "cumulative_rx": 4767197, + "cumulative_tx": 4767197, + "cx": 3864, "interface_name": "lo", "is_up": True, "key": "interface_name", - "rx": 1657, + "rx": 1932, "speed": 0, "time_since_update": 1, - "tx": 1657}, + "tx": 1932}, {"alias": None, - "cumulative_cx": 39497892918, - "cumulative_rx": 38949809930, - "cumulative_tx": 548082988, - "cx": 27720, + "cumulative_cx": 47640237, + "cumulative_rx": 40493750, + "cumulative_tx": 7146487, + "cx": 26518, "interface_name": "wlp2s0", "is_up": True, "key": "interface_name", - "rx": 21708, + "rx": 20940, "speed": 0, "time_since_update": 1, - "tx": 6012}] + "tx": 5578}] Fields descriptions: @@ -452,29 +452,28 @@ Get a specific field:: # curl http://localhost:61208/api/3/network/interface_name {"interface_name": ["lo", "wlp2s0", - "docker0", + "br_grafana", "br-119e6ee04e05", + "docker0", "br-87386b77b676", - "br_grafana", - "mpqemubr0", - "tap-1e376645a40", - "veth57bdacb"]} + "vethf38205a", + "mpqemubr0"]} Get a specific item when field matchs the given value:: # curl http://localhost:61208/api/3/network/interface_name/lo {"lo": [{"alias": None, - "cumulative_cx": 398215554, - "cumulative_rx": 199107777, - "cumulative_tx": 199107777, - "cx": 3314, + "cumulative_cx": 9534394, + "cumulative_rx": 4767197, + "cumulative_tx": 4767197, + "cx": 3864, "interface_name": "lo", "is_up": True, "key": "interface_name", - "rx": 1657, + "rx": 1932, "speed": 0, "time_since_update": 1, - "tx": 1657}]} + "tx": 1932}]} GET now ------- @@ -482,7 +481,7 @@ GET now Get plugin stats:: # curl http://localhost:61208/api/3/now - "2023-01-14 09:45:44 CET" + "2023-01-17 08:09:59 CET" GET percpu ---------- @@ -493,29 +492,29 @@ Get plugin stats:: [{"cpu_number": 0, "guest": 0.0, "guest_nice": 0.0, - "idle": 56.1, - "iowait": 0.0, + "idle": 32.2, + "iowait": 2.8, "irq": 0.0, "key": "cpu_number", "nice": 0.0, "softirq": 0.0, "steal": 0.0, - "system": 4.7, - "total": 43.9, - "user": 39.3}, + "system": 16.9, + "total": 67.8, + "user": 48.0}, {"cpu_number": 1, "guest": 0.0, "guest_nice": 0.0, - "idle": 28.2, - "iowait": 0.0, + "idle": 36.9, + "iowait": 2.4, "irq": 0.0, "key": "cpu_number", "nice": 0.0, "softirq": 0.0, "steal": 0.0, - "system": 3.9, - "total": 71.8, - "user": 68.0}] + "system": 9.5, + "total": 63.1, + "user": 51.2}] Get a specific field:: @@ -534,7 +533,7 @@ Get plugin stats:: "port": 0, "refresh": 30, "rtt_warning": None, - "status": 0.007094, + "status": 0.009487, "timeout": 3}] Get a specific field:: @@ -551,7 +550,7 @@ Get a specific item when field matchs the given value:: "port": 0, "refresh": 30, "rtt_warning": None, - "status": 0.007094, + "status": 0.009487, "timeout": 3}]} GET processcount @@ -560,12 +559,12 @@ GET processcount Get plugin stats:: # curl http://localhost:61208/api/3/processcount - {"pid_max": 0, "running": 2, "sleeping": 334, "thread": 1765, "total": 403} + {"pid_max": 0, "running": 1, "sleeping": 298, "thread": 1391, "total": 370} Get a specific field:: # curl http://localhost:61208/api/3/processcount/total - {"total": 403} + {"total": 370} GET processlist --------------- @@ -573,51 +572,51 @@ GET processlist Get plugin stats:: # curl http://localhost:61208/api/3/processlist - [{"cmdline": ["/snap/firefox/2154/usr/lib/firefox/firefox"], + [{"cmdline": ["/snap/firefox/2263/usr/lib/firefox/firefox"], "cpu_percent": 0.0, - "cpu_times": [8504.75, 2803.93, 8401.36, 1489.57, 0.0], + "cpu_times": [102.84, 30.4, 19.74, 4.93, 0.0], "gids": [1000, 1000, 1000], - "io_counters": [6360911872, 11858505728, 0, 0, 0], + "io_counters": [451314688, 413401088, 0, 0, 0], "key": "pid", - "memory_info": [484036608, 22242152448, 100323328, 659456, 0, 1409527808, 0], - "memory_percent": 6.176939176178121, + "memory_info": [426778624, 3789393920, 178733056, 647168, 0, 556158976, 0], + "memory_percent": 5.446246838956393, "name": "firefox", "nice": 0, - "num_threads": 187, - "pid": 4674, + "num_threads": 104, + "pid": 5040, "status": "S", "time_since_update": 1, "username": "nicolargo"}, - {"cmdline": ["/snap/firefox/2154/usr/lib/firefox/firefox", + {"cmdline": ["/snap/firefox/2263/usr/lib/firefox/firefox", "-contentproc", "-childID", "1", "-isForBrowser", "-prefsLen", - "31799", + "32129", "-prefMapSize", - "234979", + "236410", "-jsInitLen", - "246704", + "246772", "-parentBuildID", - "20221128185858", + "20230104235612", "-appDir", - "/snap/firefox/2154/usr/lib/firefox/browser", - "{8ed7e0e9-5dcf-4c35-9523-65d5178968f5}", - "4674", + "/snap/firefox/2263/usr/lib/firefox/browser", + "{152fde2c-5751-4719-9edb-ff980730fbac}", + "5040", "true", "tab"], "cpu_percent": 0.0, - "cpu_times": [1878.88, 294.96, 0.0, 0.0, 0.0], + "cpu_times": [34.54, 6.52, 0.0, 0.0, 0.0], "gids": [1000, 1000, 1000], - "io_counters": [446676992, 0, 0, 0, 0], + "io_counters": [4002816, 0, 0, 0, 0], "key": "pid", - "memory_info": [379330560, 3766951936, 44253184, 659456, 0, 1161146368, 0], - "memory_percent": 4.840753277871052, + "memory_info": [423772160, 3132645376, 86876160, 647168, 0, 534884352, 0], + "memory_percent": 5.407880472564912, "name": "WebExtensions", "nice": 0, "num_threads": 20, - "pid": 4980, + "pid": 5246, "status": "S", "time_since_update": 1, "username": "nicolargo"}] @@ -625,239 +624,199 @@ Get plugin stats:: Get a specific field:: # curl http://localhost:61208/api/3/processlist/pid - {"pid": [4674, - 4980, - 5110, - 527830, - 173709, - 3699, - 5464, - 431554, - 495017, - 5113, - 173765, - 174093, - 87518, - 10140, - 93773, - 5000, - 173645, - 534445, - 511174, - 173751, - 534543, - 9953, - 534732, - 535113, - 284680, - 128927, - 173679, - 535159, - 4050, - 3586, - 4426, - 173949, - 493657, - 511164, - 2510, + {"pid": [5040, + 5246, + 5752, + 4519, + 10873, + 5369, + 10724, + 4150, + 10653, + 5365, + 9219, + 5372, + 10547, + 10709, + 11252, + 10612, + 5261, + 11251, + 11480, + 11307, + 11506, + 4544, + 6074, + 10732, + 2512, + 10641, + 2452, + 11033, + 9543, + 11210, + 11417, + 10632, + 4625, + 10948, + 6020, + 422, + 10557, + 2721, + 4035, + 10558, + 4413, + 3409, + 1806, + 11501, + 4248, + 1816, + 1672, + 5179, + 1885, + 4473, + 6022, + 10848, + 4223, + 3244, + 3955, + 4182, + 4332, + 4263, + 5299, + 4331, + 4325, + 4445, 3351, - 173688, - 173781, - 496818, - 496817, - 408152, - 493678, - 4206, - 511549, - 427, - 173973, - 3820, - 5730, - 17316, - 174051, - 1616, - 3512, - 493683, + 4932, + 2640, + 4585, + 1655, + 4659, + 4352, + 4214, + 1635, + 2701, + 4330, + 2239, + 4130, + 1681, + 4328, + 1801, + 3354, + 2455, + 1876, + 4050, + 4561, + 3700, + 4327, + 1442, + 4192, + 4485, 1, - 5690, - 3903, - 4008, - 165775, - 3792, - 174314, - 493699, - 94498, - 2702, - 1662, - 1641, - 87895, - 87994, - 4158, - 87995, - 174313, - 4433, - 87753, - 3897, - 5691, - 4458, - 87853, - 94497, - 4903, - 3902, - 17315, - 3829, - 173649, - 87454, - 3273, - 1838, - 3676, - 3783, - 3695, - 10499, - 87474, - 3907, - 2209, - 3730, - 3486, - 3915, - 3901, - 3910, - 10649, - 533610, - 10551, - 511526, - 10082, - 87412, - 1615, - 173650, - 4005, - 3904, - 10318, - 165937, - 1663, 1777, - 2417, - 2626, - 10319, - 3805, - 10094, - 3956, - 1837, - 17467, - 1636, - 2688, - 4049, - 4089, - 3521, - 87413, - 87779, - 3861, - 1416, - 102131, - 10032, - 1782, - 1598, - 115869, - 17484, - 3970, - 1659, - 3524, - 465, - 2159, - 3898, - 3527, - 3802, - 5024, - 3743, - 1626, - 10033, - 3908, - 4036, - 3697, - 4170, - 10048, - 1642, - 3906, - 1654, - 3717, - 173849, - 3591, - 3896, - 3726, - 3909, - 3722, - 3900, - 3781, - 3994, - 10381, - 3748, - 87429, - 3584, - 3905, - 1868, - 1612, - 3891, - 112675, - 1607, + 4334, + 8663, + 4137, + 2451, 1660, - 3533, - 3510, - 98474, - 10372, - 3508, - 1648, - 1652, - 3706, - 3664, - 1629, - 1999, - 1614, - 1415, - 535105, - 1419, + 3934, + 3944, + 3220, + 4339, + 3701, + 1682, + 1873, + 2683, + 4392, + 4348, + 1676, + 1617, + 2179, + 4233, + 10560, + 4261, + 4166, + 4347, + 4155, + 1675, + 4329, + 4452, + 3971, + 9795, + 4443, + 3966, + 1634, + 1661, + 4314, + 4573, + 4377, + 468, + 4524, + 1673, + 10911, + 4335, + 1643, + 4324, + 3968, + 4178, + 6095, + 4229, 1666, - 4187, - 2680, - 173665, - 1432, - 17364, - 2681, - 1430, - 2428, - 3354, - 142951, - 1609, - 98475, - 1599, - 535158, - 5769, - 10035, - 173652, - 87415, - 3895, - 2483, - 511483, - 3572, - 511504, - 191811, - 98353, - 98484, - 511512, - 532452, - 98346, - 511490, - 4546, - 3487, - 2430, - 2492, - 2465, - 1431, - 1669, + 4201, + 4173, + 4337, + 3976, + 1670, + 4045, + 4212, + 1443, + 3952, + 2684, + 3953, + 4119, + 1631, + 4162, + 1626, + 3945, + 9703, + 2020, + 1646, + 1441, + 1633, + 3774, + 3176, + 3205, + 3183, + 3199, + 10591, + 4579, + 1685, + 1450, + 1449, + 11451, + 2472, + 1804, + 1803, + 4820, + 4018, + 1618, + 4323, + 11500, + 2480, + 3708, + 1695, + 2503, + 2485, + 2475, + 1447, + 3707, + 1628, 2, 3, 4, 5, - 7, + 6, + 8, 9, 10, 11, @@ -894,26 +853,31 @@ Get a specific field:: 92, 93, 94, + 95, 96, 97, 98, 99, 100, 101, + 102, 104, - 105, - 108, + 106, + 107, + 109, 110, 112, - 113, + 117, 118, - 119, - 120, - 121, + 128, 131, - 135, - 141, - 204, + 132, + 137, + 171, + 175, + 201, + 205, + 217, 218, 219, 220, @@ -921,39 +885,34 @@ Get a specific field:: 222, 223, 224, - 225, + 248, 249, - 250, + 254, 255, - 256, - 313, - 366, - 367, + 312, + 361, + 362, + 442, 447, - 448, - 545, - 614, - 685, - 686, - 687, - 694, - 950, - 951, - 952, - 953, - 956, - 957, - 958, - 959, - 960, - 961, + 577, + 601, + 676, + 677, + 678, + 682, + 693, + 963, + 964, + 965, 966, 967, - 1021, - 1022, - 1023, - 1024, - 1025, + 968, + 969, + 970, + 971, + 972, + 973, + 974, 1026, 1027, 1028, @@ -968,88 +927,95 @@ Get a specific field:: 1037, 1038, 1039, - 1056, - 1057, - 1065, + 1040, + 1041, + 1042, + 1043, + 1044, 1066, - 1083, - 1084, - 1085, - 1086, - 1087, - 1088, - 1089, - 2491, - 2527, - 2539, - 2586, - 2587, - 2589, - 2590, - 2592, + 1069, + 1070, + 1071, + 1072, + 1080, + 1081, + 1105, + 1106, + 1107, + 1108, + 1109, + 1110, + 1111, + 1897, + 2205, + 2206, + 2207, + 2208, + 2209, + 2212, + 2213, + 2214, + 2216, + 2217, + 2220, + 2504, + 2521, + 2531, + 2597, 2598, 2599, - 2606, - 3780, - 4620, - 10063, - 87445, - 282372, - 284747, - 284755, - 284756, - 284759, - 284760, - 445439, - 445440, - 445441, - 491085, - 493353, - 493435, - 493436, - 493437, - 493438, - 493440, - 493488, - 525438, - 526723, - 527334, - 529501, - 532606, - 532692, - 532694, - 532700, - 532986, - 533409, - 533601, - 533685, - 533744, - 533796, - 533986, - 534098, - 534679]} + 2600, + 2602, + 2604, + 2609, + 2610, + 4034, + 7079, + 7804, + 8417, + 8421, + 8425, + 8439, + 8440, + 8441, + 8442, + 8443, + 8448, + 8485, + 8490, + 8491, + 8492, + 10128, + 10129, + 10264, + 10290, + 11056, + 11236, + 11392, + 11484, + 11505]} Get a specific item when field matchs the given value:: - # curl http://localhost:61208/api/3/processlist/pid/4674 - {"4674": [{"cmdline": ["/snap/firefox/2154/usr/lib/firefox/firefox"], + # curl http://localhost:61208/api/3/processlist/pid/5040 + {"5040": [{"cmdline": ["/snap/firefox/2263/usr/lib/firefox/firefox"], "cpu_percent": 0.0, - "cpu_times": [8504.75, 2803.93, 8401.36, 1489.57, 0.0], + "cpu_times": [102.84, 30.4, 19.74, 4.93, 0.0], "gids": [1000, 1000, 1000], - "io_counters": [6360911872, 11858505728, 0, 0, 0], + "io_counters": [451314688, 413401088, 0, 0, 0], "key": "pid", - "memory_info": [484036608, - 22242152448, - 100323328, - |