-
Notifications
You must be signed in to change notification settings - Fork 11
/
swagger.yml
9125 lines (9064 loc) · 257 KB
/
swagger.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.2
x-stoplight:
id: def28pda18io3
info:
title: Ercole
version: 2.0.0
license:
name: GNU General Public License v3.0 or later
url: "https://www.gnu.org/licenses/gpl-3.0-standalone.html"
description: API used to talk to ercole services
contact:
name: Issues support
url: "https://github.com/ercole-io/ercole"
servers:
- description: Api service on dev.ercole.io
url: "https://dev.ercole.io/api"
- description: Chart service on dev.ercole.io
url: "https://dev.ercole.io/chart"
- description: Data service on dev.ercole.io
url: "https://dev.ercole.io/data"
- description: Alert service on dev.ercole.io
url: "https://dev.ercole.io/alert"
- description: Repo service on dev.ercole.io
url: "https://dev.ercole.io/repo"
- description: Data service
url: "http://localhost:11111"
- url: "http://localhost:11112"
description: Alert service
- url: "http://localhost:11113"
description: Api service
- url: "http://localhost:11116"
description: Chart service
tags:
- name: data-service
description: API served by data-service
- name: alert-service
description: API served by alert-service
- name: api-service
description: API served by api-service
- name: chart-service
description: API served by chart-service
- name: thunder-service
description: API served by thunder-service
- name: fe-user
description: API used by the end user
- name: agent-user
description: API used by the ercole-agent
- name: developer-user
description: API used by the developers
- name: service-user
description: API used by the services
- name: read
description: API that don't change the state of the informations
- name: write
description: API that change the state of the informations
components:
securitySchemes:
basicAuthDataService:
type: http
scheme: basic
description: access to data-service APIs
basicAuthAlertService:
type: http
scheme: basic
description: access to alert-service APIs
basicAuthApiService:
type: http
scheme: basic
description: access to api-service APIs
tokenAuthApiService:
type: http
scheme: bearer
bearerFormat: JWT
description: access using the access token
responses:
error:
description: Contains some informations about an error
content:
application/json:
schema:
type: object
additionalProperties: false
properties:
error:
type: string
message:
type: string
sourceFilename:
type: string
lineNumber:
type: integer
required:
- error
- message
- sourceFilename
- lineNumber
examples:
Test1:
value:
error: Invalid status
errorDescription: invalid status
sourceFilename: /home/travis/go/src/github.com/ercole-io/ercole/api-service/controller/alerts_api.go
lineNumber: 65
schemas:
Configuration:
type: object
properties:
DataService:
type: object
$ref: "#/components/schemas/DataService"
AlertService:
type: object
$ref: "#/components/schemas/AlertService"
APIService:
type: object
$ref: "#/components/schemas/APIService"
ChartService:
type: object
$ref: "#/components/schemas/ChartService"
ThunderService:
type: object
$ref: "#/components/schemas/ThunderService"
ResourceFilePath:
type: string
DataService:
type: object
properties:
RemoteEndpoint:
type: string
BindIP:
type: string
LogHTTPRequest:
type: boolean
LogInsertingHostdata:
type: boolean
AgentUsername:
type: string
AgentPassword:
type: string
CurrentHostCleaningJob:
type: object
properties:
Crontab:
type: string
HourThreshold:
type: integer
RunAtStartup:
type: boolean
ArchivedHostCleaningJob:
type: object
properties:
Crontab:
type: string
HourThreshold:
type: integer
RunAtStartup:
type: boolean
FreshnessCheckJob:
type: object
properties:
Crontab:
type: string
HourThreshold:
type: integer
RunAtStartup:
type: boolean
LicenseTypeMetricsDefault:
type: array
items:
type: string
LicenseTypeMetricsByEnvironment:
type: object
AlertService:
type: object
properties:
RemoteEndpoint:
type: string
BindIP:
type: string
Port:
type: integer
LogHTTPRequest:
type: boolean
LogMessages:
type: boolean
LogAlertThrows:
type: boolean
PublisherUsername:
type: string
PublisherPassword:
type: string
QueueBufferSize:
type: integer
Emailer:
type: object
properties:
Enabled:
type: boolean
From:
type: string
To:
type: array
items:
type: string
SMTPServer:
type: string
SMTPPort:
type: integer
SMTPUsername:
type: string
SMTPPassword:
type: string
DisableSSLCertificateValidation:
type: boolean
AlertType:
type: object
properties:
NewHost:
type: boolean
NewDatabase:
type: boolean
NewLicense:
type: boolean
NewOption:
type: boolean
NewUnlistedRunningDatabase:
type: boolean
NewHostCpu:
type: boolean
MissingPrimaryDatabase:
type: boolean
MissingDatabase:
type: boolean
AgentError:
type: boolean
NoData:
type: boolean
APIService:
type: object
properties:
RemoteEndpoint:
type: string
BindIP:
type: string
Port:
type: integer
LogHTTPRequest:
type: boolean
ReadOnly:
type: boolean
DebugOracleDatabaseContractsAssignmentAlgorithm:
type: boolean
AuthenticationProvider:
type: object
properties:
Type:
type: string
Username:
type: string
Password:
type: string
PrivateKey:
type: string
PublicKey:
type: string
TokenValidityTimeout:
type: integer
Host:
type: string
Port:
type: integer
LDAPBase:
type: string
LDAPUseSSL:
type: boolean
LDAPBindDN:
type: string
LDAPBindPassword:
type: string
LDAPUserFilter:
type: string
LDAPGroupFilter:
type: string
OperatingSystemAggregationRules:
type: array
items:
type: object
properties:
Regex:
type: string
Group:
type: string
Product:
type: string
DefaultDatabaseTags:
type: array
items:
type: string
PGASGASumTargetPercentage:
type: integer
PGASGASumTargetPercentagePerHosts:
type: array
items:
type: object
ChartService:
type: object
properties:
RemoteEndpoint:
type: string
BindIP:
type: string
Port:
type: integer
LogHTTPRequest:
type: boolean
ThunderService:
type: object
properties:
RemoteEndpoint:
type: string
BindIP:
type: string
Port:
type: integer
LogHTTPRequest:
type: boolean
OciDataRetrieveJob:
type: object
properties:
Crontab:
type: string
HourThreshold:
type: integer
RunAtStartup:
type: boolean
OciRemoveOldDataObjectsJob:
type: object
properties:
Crontab:
type: string
HourThreshold:
type: integer
RunAtStartup:
type: boolean
AwsDataRetrieveJob:
type: object
properties:
Crontab:
type: string
HourThreshold:
type: integer
RunAtStartup:
type: boolean
HostDataInfo:
type: object
required:
- hostname
- environment
- location
- cpuModel
- cpuCores
- cpuThreads
- socket
- type
- virtual
- kernel
- os
- memoryTotal
- swapTotal
- oracleCluster
- veritasCluster
- sunCluster
- aixCluster
properties:
hostname:
type: string
pattern: '^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])$'
environment:
type: string
location:
type: string
cpuModel:
type: string
cpuCores:
type: integer
cpuThreads:
type: integer
socket:
type: integer
type:
type: string
virtual:
type: boolean
kernel:
type: string
os:
type: string
memoryTotal:
type: number
swapTotal:
type: number
oracleCluster:
type: boolean
veritasCluster:
type: boolean
sunCluster:
type: boolean
aixCluster:
type: boolean
clusterwareVersion:
type: string
Filesystems:
type: array
items:
type: object
properties:
filesystem:
type: string
fsType:
type: string
size:
type: string
used:
type: string
usedPerc:
type: string
mountedOn:
type: string
required:
- filesystem
- fsType
- size
- used
- usedPerc
- mountedOn
Patch:
type: object
properties:
database:
type: string
version:
type: string
patchID:
type: string
action:
type: string
description:
type: string
date:
type: string
required:
- database
- version
- patchID
- action
- description
- date
Tablespace:
type: object
properties:
database:
type: string
name:
type: string
maxSize:
type: string
total:
type: string
used:
type: string
usedPerc:
type: string
status:
type: string
required:
- database
- name
- maxSize
- total
- used
- usedPerc
- status
Schema:
type: object
properties:
Database:
type: string
User:
type: string
Total:
type: integer
Tables:
type: integer
Indexes:
type: integer
lob:
type: integer
required:
- Database
- User
- Total
- Tables
- Indexes
- LOB
Partitioning:
type: object
properties:
owner:
type: string
segmentName:
type: string
count:
type: integer
mb:
type: number
required:
- Owner
- SegmentName
- Count
- Mb
OracleDatabaseFeature:
type: object
properties:
Name:
type: string
Status:
type: boolean
required:
- Name
- Status
License:
type: object
properties:
Name:
type: string
Count:
type: number
required:
- Name
- Count
ADDM:
type: object
properties:
Finding:
type: string
Recommendation:
type: string
Action:
type: string
Benefit:
oneOf:
- type: string
- type: boolean
Hostname:
type: string
nullable: true
Location:
type: string
nullable: true
Environment:
type: string
nullable: true
CreatedAt:
type: string
nullable: true
required:
- Finding
- Recommendation
- Action
- Benefit
SegmentAdvisor:
type: object
properties:
SegmentOwner:
type: string
SegmentName:
type: string
SegmentType:
type: string
PartitionName:
type: string
Reclaimable:
type: string
Recommendation:
type: string
required:
- SegmentOwner
- SegmentName
- SegmentType
- PartitionName
- Reclaimable
- Recommendation
LastPSU:
type: object
properties:
Date:
type: string
Description:
type: string
required:
- Date
- Description
Backup:
type: object
properties:
BackupType:
type: string
Hour:
type: string
WeekDays:
type: string
AvgBckSize:
type: string
Retention:
type: string
required:
- BackupType
- Hour
- WeekDays
- AvgBckSize
- Retention
Database:
type: object
properties:
pgsqlMigrabilitySemaphore:
type: string
InstanceNumber:
type: string
nullable: true
InstanceName:
type: string
Name:
type: string
UniqueName:
type: string
Status:
type: string
Version:
type: string
Platform:
type: string
nullable: true
Archivelog:
type: string
nullable: true
Charset:
type: string
nullable: true
nCharset:
type: string
nullable: true
BlockSize:
type: string
cpuCount:
type: string
sgaTarget:
type: string
nullable: true
pgaTarget:
type: string
nullable: true
MemoryTarget:
type: string
nullable: true
sgaMaxSize:
type: string
nullable: true
SegmentsSize:
type: string
Used:
type: string
nullable: true
Allocable:
type: string
nullable: true
Elapsed:
type: string
nullable: true
dbTime:
type: string
nullable: true
DailycpuUsage:
type: string
nullable: true
Work:
type: string
asm:
type: boolean
nullable: true
Dataguard:
type: boolean
rac:
nullable: true
type: boolean
ha:
nullable: true
type: boolean
Hostname:
type: string
nullable: true
Location:
type: string
nullable: true
Environment:
type: string
nullable: true
CreatedAt:
type: string
nullable: true
ArchiveLogStatus:
type: boolean
nullable: true
Memory:
type: number
nullable: true
DatafileSize:
type: number
nullable: true
Patches:
type: array
nullable: true
items:
$ref: "#/components/schemas/Patch"
Tablespaces:
type: array
nullable: true
items:
$ref: "#/components/schemas/Tablespace"
Schemas:
type: array
nullable: true
items:
$ref: "#/components/schemas/Schema"
Features:
type: array
nullable: true
items:
$ref: "#/components/schemas/OracleDatabaseFeature"
Licenses:
type: array
nullable: true
items:
$ref: "#/components/schemas/License"
Partitionings:
type: array
nullable: true
items:
$ref: "#/components/schemas/Partitioning"
addms:
type: array
nullable: true
items:
$ref: "#/components/schemas/ADDM"
SegmentAdvisors:
type: array
nullable: true
items:
$ref: "#/components/schemas/SegmentAdvisor"
LastpsUs:
type: array
nullable: true
items:
$ref: "#/components/schemas/LastPSU"
Backups:
type: array
nullable: true
items:
$ref: "#/components/schemas/Backup"
Changes:
nullable: true
type: array
items:
$ref: "#/components/schemas/DatabaseChange"
pgsqlMigrability:
nullable: true
type: array
items:
$ref: "#/components/schemas/PgsqlMigrability"
canbemigrate:
type: boolean
required:
- Name
- UniqueName
- Status
- Version
- BlockSize
- CPUCount
- SegmentsSize
- Work
- Dataguard
Cluster:
type: object
properties:
Name:
type: string
Environment:
type: string
nullable: true
Location:
type: string
nullable: true
Hostname:
type: string
nullable: true
HostnameAgentVirtualization:
type: string
nullable: true
VirtualizationNodes:
nullable: true
anyOf:
- type: string
nullable: true
- type: array
items:
type: string
uniqueItems: true
PhysicalServerModelNames:
nullable: true
anyOf:
- type: string
nullable: true
- type: array
items:
type: string
uniqueItems: true
VirtualizationNodesCount:
nullable: true
type: integer
VirtualizationNodesStats:
nullable: true
type: object
required:
- VirtualizationNode
- TotalVMsCount
- TotalVMsWithErcoleAgentCount
- TotalVMsWithoutErcoleAgentCount
properties:
VirtualizationNode:
type: string
TotalvMsCount:
type: integer
TotalvMsWithErcoleAgentCount:
type: integer
TotalvMsWithoutErcoleAgentCount:
type: integer
Type:
type: string
cpu:
type: integer
Sockets:
type: integer
vmsCount:
type: integer
nullable: true
vmsErcoleAgentCount:
type: integer
nullable: true
vms:
type: array
items:
type: object
properties:
name:
type: string
clusterName:
type: string
hostname:
type: string
cappedCPU:
type: boolean
virtualizationNode:
type: string
physicalServerModelName:
type: string
isErcoleInstalled:
type: boolean
required:
- name
- clusterName
- hostname
- cappedCPU
- virtualizationNode
required:
- name
- type
- cpu
- sockets
- vms
CellDisk:
type: object
properties:
name:
type: string
status:
type: string
errCount:
type: string
usedPerc:
type: string
required:
- name
- status
- errCount
- usedPerc
ExadataInstance:
type: object
properties:
hostname:
type: string
rackID:
type: string
components:
type: array
items:
$ref: "#/components/schemas/ExadataComponent"
totalMemory:
type: integer
usedMemory:
type: integer
freeMemory:
type: integer
usedMemoryPercentage:
type: string
totalCPU:
type: integer
usedCPU:
type: integer
freeCPU:
type: integer
usedCPUPercentage:
type: string
totalSize:
type: integer
usedSize:
type: integer
freeSpace:
type: integer
usedSizePercentage:
type: string
required:
- racID
ExadataInstanceResponseList:
type: array
items:
properties:
rackID:
type: string
hostname:
type: string
ExadataComponent:
type: object
properties:
rackID:
type: string
hostType:
type: string
hostname:
type: string
hostID:
type: string
cpuEnabled:
type: integer
totalCPU:
type: integer
memory:
type: integer
imageVersion:
type: string
kernel:
type: string
model:
type: string
fanUsed:
type: integer
fanTotal:
type: integer
psuUsed:
type: integer
psuTotal:
type: integer
msStatus:
type: string
rsStatus:
type: string
cellServiceStatus:
type: string
swVersion:
type: string
vms:
type: array
items:
$ref: "#/components/schemas/ExadataVM"
storageCells:
type: array