/
rhsm-subscriptions-api-spec.yaml
1907 lines (1895 loc) · 65.6 KB
/
rhsm-subscriptions-api-spec.yaml
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"
info:
title: "rhsm-subscriptions-api"
description: "REST interface for the rhsm-subscriptions service. Please note any deprecated APIs. Our current deprecation policy is to keep deprecated APIs around for at least 6 months."
version: 1.0.0
servers:
- url: /{PATH_PREFIX}/{APP_NAME}/v1
variables:
PATH_PREFIX:
default: api
APP_NAME:
default: rhsm-subscriptions
- url: https://{HOSTNAME}/{PATH_PREFIX}/{APP_NAME}/v1
variables:
HOSTNAME:
enum:
- ci.cloud.redhat.com
- qa.cloud.redhat.com
- stage.cloud.redhat.com
- cloud.redhat.com
default: ci.cloud.redhat.com
PATH_PREFIX:
default: api
APP_NAME:
default: rhsm-subscriptions
paths:
/version:
description: "Provides version and build information about the deployed application."
get:
summary: "Request version and build information about the deployed application."
operationId: getVersion
tags:
- version
responses:
'200':
description: 'The request for version information was successful.'
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/VersionInfo"
'500':
$ref: "../spec/error-responses.yaml#/$defs/InternalServerError"
/opt-in:
description: "Endpoint for opting into subscription watch."
get:
summary: "Get the opt-in configuration for the current account."
operationId: getOptInConfig
responses:
'200':
description: "The request for the account's opt-in configuration was successful."
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/OptInConfig"
example:
data:
opt_in_complete: true
org:
org_id: 1111
opt_in_type: 'API'
created: '2017-08-04T17:32:05Z'
last_updated: '2017-08-04T17:32:05Z'
meta:
org_id: 1111
'400':
$ref: "../spec/error-responses.yaml#/$defs/BadRequest"
'403':
$ref: "../spec/error-responses.yaml#/$defs/Forbidden"
'404':
$ref: "../spec/error-responses.yaml#/$defs/ResourceNotFound"
'500':
$ref: "../spec/error-responses.yaml#/$defs/InternalServerError"
put:
summary: "Create/Update an account's opt-in configuration. Org ID are defined by the
identity header."
operationId: putOptInConfig
responses:
'200':
description: "The request for the account's opt-in configuration was successful."
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/OptInConfig"
example:
data:
opt_in_complete: true
org:
org_id: 1111
opt_in_type: 'API'
created: '2017-08-04T17:32:05Z'
last_updated: '2017-08-04T17:32:05Z'
meta:
org_id: 1111
'400':
$ref: "../spec/error-responses.yaml#/$defs/BadRequest"
'403':
$ref: "../spec/error-responses.yaml#/$defs/Forbidden"
'404':
$ref: "../spec/error-responses.yaml#/$defs/ResourceNotFound"
'500':
$ref: "../spec/error-responses.yaml#/$defs/InternalServerError"
delete:
summary: "Delete an opt-in config for the associated org. The org ID are
pulled from the identity header."
operationId: deleteOptInConfig
responses:
'204':
description: "Successfully deleted the opt-in configuration for the accociated org"
'400':
$ref: "../spec/error-responses.yaml#/$defs/BadRequest"
'403':
$ref: "../spec/error-responses.yaml#/$defs/Forbidden"
'404':
$ref: "../spec/error-responses.yaml#/$defs/ResourceNotFound"
'500':
$ref: "../spec/error-responses.yaml#/$defs/InternalServerError"
/tally/products/{product_id}/{metric_id}:
description: "Operations on a data set of a given tally report."
parameters:
- name: product_id
in: path
required: true
schema:
$ref: '#/components/schemas/ProductId'
description: "The product to fetch graph data for"
- name: metric_id
in: path
required: true
schema:
$ref: '#/components/schemas/MetricId'
description: "The metric ID to fetch graph data for"
- name: category
in: query
schema:
$ref: '#/components/schemas/ReportCategory'
description: 'The category to fetch graph data for (optional)'
- name: granularity
in: query
required: true
schema:
$ref: '#/components/schemas/GranularityType'
description: "Include only report data matching the specified granularity."
- name: sla
in: query
schema:
$ref: '#/components/schemas/ServiceLevelType'
description: "Include only report data matching the specified service level."
- name: usage
in: query
schema:
$ref: '#/components/schemas/UsageType'
description: "Include only report data matching the specified usage."
- name: billing_provider
in: query
schema:
$ref: '#/components/schemas/BillingProviderType'
description: "Include only report data matching the specified billing provider"
- name: billing_account_id
in: query
schema:
$ref: '#/components/schemas/BillingAccountId'
description: "Include only report data matching the specified billing account"
- name: beginning
in: query
required: true
schema:
type: string
format: date-time
description: "Defines the start of the report period. Dates should be provided in ISO 8601
format but the only accepted offset is UTC. E.g. 2017-07-21T17:32:28Z"
- name: ending
in: query
required: true
schema:
type: string
format: date-time
description: "Defines the end of the report period. Defaults to the current time. Dates should
be provided in UTC."
- name: offset
in: query
schema:
type: integer
description: "The number of items to skip before starting to collect the result set"
- name: limit
in: query
schema:
type: integer
minimum: 1
description: "The numbers of items to return"
- name: use_running_totals_format
in: query
required: false
schema:
type: boolean
default:
false
description: "Whether to report the total for each temporal unit of the report period
individually or as a running total since the beginning of the report period."
- name: billing_category
in: query
schema:
$ref: '#/components/schemas/BillingCategory'
description: "Include only report data matching the specified billing_category."
get:
summary: "Fetch tally report data for an account and product."
description: "If the report is requested in a running total format, each temporal unit of
the report period (days, hours, etc.) will give the running total since the start of the
report period and set the has_data field as true, whether or not there is data that lands
in that specific temporal unit. However, if the report period stretches into the
future, temporal units in the future will have a value of zero and have has_data set to
false.
For example, if we have daily values of 0, 1, 0, 3, 0 and request a running total report
ending two days from now, we'll get back '(0, true), (1, true), (1, true), (4, true), (4,
true), (0, false), (0, false)'.
"
operationId: getTallyReportData
responses:
'200':
description: 'The request for a tally report was successful.'
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/TallyReportData"
'400':
$ref: "../spec/error-responses.yaml#/$defs/BadRequest"
'403':
$ref: "../spec/error-responses.yaml#/$defs/Forbidden"
'404':
$ref: "../spec/error-responses.yaml#/$defs/ResourceNotFound"
'500':
$ref: "../spec/error-responses.yaml#/$defs/InternalServerError"
tags:
- tally
/tally/products/{product_id}:
description: "Operations for a tally report of a specific account and product."
parameters:
- name: product_id
in: path
required: true
schema:
$ref: "#/components/schemas/ProductId"
description: "The ID for the product we wish to query"
- name: offset
in: query
schema:
type: integer
description: "The number of items to skip before starting to collect the result set"
- name: limit
in: query
schema:
type: integer
minimum: 1
description: "The numbers of items to return"
get:
deprecated: true
summary: "(Deprecated for removal after 2022-05-01). Fetch a tally report for an account and product. If page header parameters are omitted,
then any gaps in the resulting report snapshots are filled with a default fake snapshot."
description: "Deprecated: use /tally/products/{product_id}/{metric_id} instead"
operationId: getTallyReport
parameters:
- name: granularity
in: query
required: true
schema:
$ref: '#/components/schemas/GranularityType'
description: "The level of granularity to return."
- name: sla
in: query
schema:
$ref: '#/components/schemas/ServiceLevelType'
description: "Include only snapshots matching the specified service level."
- name: usage
in: query
schema:
$ref: '#/components/schemas/UsageType'
description: "Include only snapshots matching the specified usage."
- name: beginning
in: query
required: true
schema:
type: string
format: date-time
description: "Defines the start of the report period. Dates should be provided in ISO 8601
format but the only accepted offset is UTC. E.g. 2017-07-21T17:32:28Z"
- name: ending
in: query
required: true
schema:
type: string
format: date-time
description: "Defines the end of the report period. Defaults to the current time. Dates should
be provided in UTC."
- name: use_running_totals_format
in: query
required: false
schema:
type: boolean
default: false
responses:
'200':
description: 'The request for a tally report was successful.'
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/TallyReport"
example:
data:
- date: '2017-08-04T17:32:05Z'
instance_count: 10
cores: 40
sockets: 20
physical_instance_count: 5
physical_cores: 20
physical_sockets: 4
hypervisor_instance_count: 5
hypervisor_cores: 20
hypervisor_sockets: 4
- date: '2017-08-05T17:31:04Z'
instance_count: 7
cores: 14
sockets: 8
physical_instance_count: 8
physical_cores: 14
physical_sockets: 8
hypervisor_instance_count: 0
hypervisor_cores: 0
hypervisor_sockets: 0
- date: '2017-08-06T17:32:03Z'
instance_count: 24
cores: 28
sockets: 14
physical_instance_count: 0
physical_cores: 0
physical_sockets: 0
hypervisor_instance_count: 20
hypervisor_cores: 20
hypervisor_sockets: 10
cloud_instance_count: 4
cloud_cores: 8
cloud_sockets: 4
links:
first: '/api/rhsm-subscriptions/v1/tally/products/RHEL%20for%20x86?granularity=DAILY&sla=Premium&beginning=2017-08-01T17%3A32%3A28Z&ending=2017-08-31T17%3A32%3A28Z&offset=0&limit=5'
last: '/api/rhsm-subscriptions/v1/tally/products/RHEL%20for%20x86?granularity=DAILY&sla=Premium&beginning=2017-08-01T17%3A32%3A28Z&ending=2017-08-31T17%3A32%3A28Z&offset=5&limit=5'
previous: null
next: '/api/rhsm-subscriptions/v1/tally/products/RHEL%20for%20x86?granularity=DAILY&sla=Premium&beginning=2017-08-01T17%3A32%3A28Z&ending=2017-08-31T17%3A32%3A28Z&offset=5&limit=5'
meta:
count: 10
total_core_hours: 30
total_instance_hours: 20
product: RHEL Server
granularity: Daily
service_level: Premium
usage: Production
'400':
$ref: "../spec/error-responses.yaml#/$defs/BadRequest"
'403':
$ref: "../spec/error-responses.yaml#/$defs/Forbidden"
'404':
$ref: "../spec/error-responses.yaml#/$defs/ResourceNotFound"
'500':
$ref: "../spec/error-responses.yaml#/$defs/InternalServerError"
tags:
- tally
/capacity/products/{product_id}/{metric_id}:
description: 'Operations for capacity report for a given account and product'
parameters:
- name: product_id
in: path
required: true
schema:
$ref: "#/components/schemas/ProductId"
description: "The ID for the product we wish to query"
- name: metric_id
in: path
required: true
schema:
$ref: "#/components/schemas/MetricId"
description: "The metric ID for the product we wish to query"
- name: offset
in: query
schema:
type: integer
description: "The number of items to skip before starting to collect the result set"
- name: limit
in: query
schema:
type: integer
minimum: 1
description: "The numbers of items to return"
get:
summary: "Fetch a capacity report for an account and product."
operationId: getCapacityReportByMetricId
parameters:
- name: granularity
in: query
required: true
schema:
$ref: '#/components/schemas/GranularityType'
description: "The level of granularity to return."
- name: category
in: query
schema:
$ref: '#/components/schemas/ReportCategory'
description: 'The category to fetch data for'
- name: sla
in: query
schema:
$ref: '#/components/schemas/ServiceLevelType'
description: "Include only capacity for the specified service level."
- name: usage
in: query
schema:
$ref: '#/components/schemas/UsageType'
description: "Include only capacity for the specified usage level."
- name: beginning
in: query
required: true
schema:
type: string
format: date-time
description: "Defines the start of the report period. Dates should be provided in ISO 8601
format but the only accepted offset is UTC. E.g. 2017-07-21T17:32:28Z"
- name: ending
in: query
required: true
schema:
type: string
format: date-time
description: "Defines the end of the report period. Defaults to the current time. Dates should
be provided in UTC."
responses:
'200':
description: 'The request for a capacity report was successful.'
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/CapacityReportByMetricId"
example:
data:
- date: '2017-08-01T17:32:05Z'
has_data: true
value: 100.0
- date: '2017-08-02T17:31:04Z'
has_data: false
value: 0.0
- date: '2017-08-03T17:31:04Z'
has_data: false
value: 0.0
- date: '2017-08-04T17:31:04Z'
has_data: false
value: 0.0
- date: '2017-08-05T17:31:04Z'
has_data: false
value: 0.0
links:
first: '/api/rhsm-subscriptions/v1/capacity/RHEL%20for%20x86/Sockets?granularity=DAILY&sla=Premium&beginning=2017-08-01T17%3A32%3A28Z&ending=2017-08-31T17%3A32%3A28Z&offset=0&limit=5'
last: '/api/rhsm-subscriptions/v1/capacity/RHEL%20for%20x86/Sockets?granularity=DAILY&sla=Premium&beginning=2017-08-01T17%3A32%3A28Z&ending=2017-08-31T17%3A32%3A28Z&offset=5&limit=5'
previous: null
next: '/api/rhsm-subscriptions/v1/capacity/RHEL%20for%20x86/Sockets?granularity=DAILY&sla=Premium&beginning=2017-08-01T17%3A32%3A28Z&ending=2017-08-31T17%3A32%3A28Z&offset=5&limit=5'
meta:
count: 10
product: RHEL Server
granularity: Daily
service_level: Premium
'400':
$ref: "../spec/error-responses.yaml#/$defs/BadRequest"
'403':
$ref: "../spec/error-responses.yaml#/$defs/Forbidden"
'404':
$ref: "../spec/error-responses.yaml#/$defs/ResourceNotFound"
'500':
$ref: "../spec/error-responses.yaml#/$defs/InternalServerError"
tags:
- capacity
/capacity/products/{product_id}:
description: 'Operations for capacity report for a given account and product'
parameters:
- name: product_id
in: path
required: true
schema:
$ref: "#/components/schemas/ProductId"
description: "The ID for the product we wish to query"
- name: offset
in: query
schema:
type: integer
description: "The number of items to skip before starting to collect the result set"
- name: limit
in: query
schema:
type: integer
minimum: 1
description: "The numbers of items to return"
get:
deprecated: true
summary: "(Deprecated) Fetch a capacity report for an account and product."
operationId: getCapacityReport
parameters:
- name: granularity
in: query
required: true
schema:
$ref: '#/components/schemas/GranularityType'
description: "The level of granularity to return."
- name: sla
in: query
schema:
$ref: '#/components/schemas/ServiceLevelType'
description: "Include only capacity for the specified service level."
- name: usage
in: query
schema:
$ref: '#/components/schemas/UsageType'
description: "Include only capacity for the specified usage level."
- name: beginning
in: query
required: true
schema:
type: string
format: date-time
description: "Defines the start of the report period. Dates should be provided in ISO 8601
format but the only accepted offset is UTC. E.g. 2017-07-21T17:32:28Z"
- name: ending
in: query
required: true
schema:
type: string
format: date-time
description: "Defines the end of the report period. Defaults to the current time. Dates should
be provided in UTC."
responses:
'200':
description: 'The request for a capacity report was successful.'
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/CapacityReport"
example:
data:
- date: '2017-08-04T17:32:05Z'
sockets: 0
physical_sockets: 0
hypervisor_sockets: 0
has_infinite_quantity: false
- date: '2017-08-05T17:31:04Z'
sockets: 0
physical_sockets: 0
hypervisor_sockets: 0
has_infinite_quantity: false
- date: '2017-08-06T17:32:03Z'
sockets: 10
physical_sockets: 5
hypervisor_sockets: 5
has_infinite_quantity: false
- date: '2017-08-07T17:34:02Z'
sockets: null
physical_sockets: null
hypervisor_sockets: null
has_infinite_quantity: true
- date: '2017-08-08T17:32:01Z'
sockets: 10
physical_sockets: 5
hypervisor_sockets: 5
has_infinite_quantity: true
links:
first: '/api/rhsm-subscriptions/v1/capacity/RHEL%20for%20x86?granularity=DAILY&sla=Premium&beginning=2017-08-01T17%3A32%3A28Z&ending=2017-08-31T17%3A32%3A28Z&offset=0&limit=5'
last: '/api/rhsm-subscriptions/v1/capacity/RHEL%20for%20x86?granularity=DAILY&sla=Premium&beginning=2017-08-01T17%3A32%3A28Z&ending=2017-08-31T17%3A32%3A28Z&offset=5&limit=5'
previous: null
next: '/api/rhsm-subscriptions/v1/capacity/RHEL%20for%20x86?granularity=DAILY&sla=Premium&beginning=2017-08-01T17%3A32%3A28Z&ending=2017-08-31T17%3A32%3A28Z&offset=5&limit=5'
meta:
count: 10
product: RHEL Server
granularity: Daily
service_level: Premium
'400':
$ref: "../spec/error-responses.yaml#/$defs/BadRequest"
'403':
$ref: "../spec/error-responses.yaml#/$defs/Forbidden"
'404':
$ref: "../spec/error-responses.yaml#/$defs/ResourceNotFound"
'500':
$ref: "../spec/error-responses.yaml#/$defs/InternalServerError"
tags:
- capacity
/hosts/products/{product_id}:
description: 'Operations for hosts for a given account and product'
parameters:
- name: product_id
in: path
required: true
schema:
$ref: "#/components/schemas/ProductId"
description: "The ID for the product we wish to query"
- name: offset
in: query
schema:
type: integer
description: "The number of items to skip before starting to collect the result set"
- name: limit
in: query
schema:
type: integer
minimum: 1
maximum: 100
description: "The numbers of items to return"
get:
deprecated: true
summary: "Fetch hosts matching report criteria."
operationId: getHosts
parameters:
- name: sla
in: query
schema:
$ref: '#/components/schemas/ServiceLevelType'
description: "Include only hosts for the specified service level."
- name: usage
in: query
schema:
$ref: '#/components/schemas/UsageType'
description: "Include only hosts for the specified usage level."
- name: uom
in: query
schema:
$ref: '#/components/schemas/Uom'
description: "Filter hosts to those that contribute to a specific unit of measure"
- name: display_name_contains
description: Include only hosts containing the specified display name. Passing an empty string behaves the same way as passing null
schema:
type: string
#Default to empty string to prevent complex jpql statement later
default: ''
in: query
- name: beginning
in: query
required: false
schema:
type: string
format: date-time
description: "Defines the start of the report period. Dates should be provided in ISO 8601
format but the only accepted offset is UTC. E.g. 2017-07-21T17:32:28Z.
Only applicable for OpenShift-dedicated-metrics and OpenShift-metrics products"
- name: ending
in: query
required: false
schema:
type: string
format: date-time
description: "Defines the end of the report period. Dates should be provided in ISO 8601
format but the only accepted offset is UTC. E.g. 2017-07-21T17:32:28Z.
Only applicable for OpenShift-dedicated-metrics and OpenShift-metrics products"
- name: sort
in: query
schema:
$ref: "#/components/schemas/HostReportSort"
description: "What property to sort by (optional)"
- name: dir
in: query
schema:
$ref: "#/components/schemas/SortDirection"
description: "Which direction to sort by (default: asc)"
responses:
'200':
description: 'The request for hosts was successful.'
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/HostReport"
example:
data:
- inventory_id: d6214a0b-b344-4778-831c-d53dcacb2da3
display_name: rhv.example.com
subscription_manager_id: adafd9d5-5b00-42fa-a6c9-75801d45cc6d
cores: 4
sockets: 2
hardware_type: hypervisor
number_of_guests: 4
last_seen: 2020-01-01T00:00:00Z
- inventory_id: 9358e312-1c9f-42f4-8910-dcef6e970852
display_name: db.example.com
subscription_manager_id: b101a72f-1859-4489-acb8-d6d31c2578c4
cores: 4
sockets: 2
hardware_type: physical
last_seen: 2020-01-01T00:00:00Z
links:
first: '/api/rhsm-subscriptions/v1/hosts/RHEL%20for%20x86?sla=Premium&usage=Production&offset=0&limit=5'
last: '/api/rhsm-subscriptions/v1/hosts/RHEL%20for%20x86?sla=Premium&usage=Production&offset=5&limit=5'
previous: null
next: '/api/rhsm-subscriptions/v1/hosts/RHEL%20for%20x86?sla=Premium&usage=Production&offset=5&limit=5'
meta:
count: 10
product: RHEL Server
service_level: Premium
usage: Production
'400':
$ref: "../spec/error-responses.yaml#/$defs/BadRequest"
'403':
$ref: "../spec/error-responses.yaml#/$defs/Forbidden"
'404':
$ref: "../spec/error-responses.yaml#/$defs/ResourceNotFound"
'500':
$ref: "../spec/error-responses.yaml#/$defs/InternalServerError"
tags:
- hosts
/instances/{id}/guests:
description: 'Operations for instance-id mappings.'
parameters:
- name: id
in: path
required: true
schema:
type: string
description: "The instance ID we wish to query"
- name: offset
in: query
schema:
type: integer
description: "The number of items to skip before starting to collect the result set"
- name: limit
in: query
schema:
type: integer
minimum: 1
maximum: 100
description: "The numbers of items to return"
get:
summary: "Fetch guests for the instance id."
operationId: getInstanceGuests
responses:
'200':
description: 'The request for a capacity report was successful.'
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/InstanceGuestReport"
example:
data:
- inventory_id: d6214a0b-b344-4778-831c-d53dcacb2da3
display_name: guest01.example.com
subscription_manager_id: adafd9d5-5b00-42fa-a6c9-75801d45cc6d
last_seen: 2020-01-01T00:00:00Z
- inventory_id: 9358e312-1c9f-42f4-8910-dcef6e970852
display_name: guest02.example.com
subscription_manager_id: b101a72f-1859-4489-acb8-d6d31c2578c4
last_seen: 2020-01-01T00:00:00Z
links:
first: '/api/rhsm-subscriptions/v1/instances/c5mu16smf1c22rn8e730/guests?offset=0&limit=5'
last: '/api/rhsm-subscriptions/v1/instances/c5mu16smf1c22rn8e730/guests?offset=5&limit=5'
previous: null
next: '/api/rhsm-subscriptions/v1/instances/c5mu16smf1c22rn8e730/guests?offset=5&limit=5'
meta:
count: 10
'400':
$ref: "../spec/error-responses.yaml#/$defs/BadRequest"
'403':
$ref: "../spec/error-responses.yaml#/$defs/Forbidden"
'404':
$ref: "../spec/error-responses.yaml#/$defs/ResourceNotFound"
'500':
$ref: "../spec/error-responses.yaml#/$defs/InternalServerError"
tags:
- instances
/instances/products/{product_id}:
parameters:
- name: product_id
description: The ID for the product we wish to query
in: path
required: true
schema:
$ref: "#/components/schemas/ProductId"
- name: offset
in: query
schema:
type: integer
description: "The number of items to skip before starting to collect the result set"
- name: limit
in: query
schema:
type: integer
minimum: 1
maximum: 100
description: "The numbers of items to return"
get:
operationId: getInstancesByProduct
parameters:
- name: sla
in: query
schema:
$ref: '#/components/schemas/ServiceLevelType'
description: "Include only hosts for the specified service level."
- name: usage
in: query
schema:
$ref: '#/components/schemas/UsageType'
description: "Include only hosts for the specified usage level."
- name: uom
in: query
schema:
type: string
description: "Include only hosts with a specific unit of measure"
- name: billing_provider
in: query
schema:
$ref: '#/components/schemas/BillingProviderType'
description: "Include only hosts for the specified billing provider."
- name: billing_account_id
description: Include only hosts containing the specified billing account ID.
schema:
type: string
in: query
- name: display_name_contains
description: Include only hosts containing the specified display name. Passing an empty string behaves the same way as passing null
schema:
type: string
#Default to empty string to prevent complex jpql statement later
default: ''
in: query
- name: category
in: query
schema:
$ref: '#/components/schemas/ReportCategory'
description: "Include only hosts for the specified category."
- name: beginning
in: query
required: false
schema:
type: string
format: date-time
description: "Defines the start of the report period. Dates should be provided in ISO 8601
format but the only accepted offset is UTC. E.g. 2017-07-21T17:32:28Z.
Only applicable for OpenShift-dedicated-metrics and OpenShift-metrics products"
- name: ending
in: query
required: false
schema:
type: string
format: date-time
description: "Defines the end of the report period. Dates should be provided in ISO 8601
format but the only accepted offset is UTC. E.g. 2017-07-21T17:32:28Z.
Only applicable for OpenShift-dedicated-metrics and OpenShift-metrics products"
- name: sort
in: query
schema:
$ref: "#/components/schemas/InstanceReportSort"
description: "What property to sort by (optional)"
- name: dir
in: query
schema:
$ref: "#/components/schemas/SortDirection"
description: "Which direction to sort by (default: asc)"
tags:
- instances
responses:
'200':
description: The request for instances was successful.
content:
application/json:
schema:
$ref: '#/components/schemas/InstanceResponse'
/subscriptions/products/{product_id}:
description: "Operations for total capacity by SKU for all of the org's active subscriptions for given Swatch product ID."
parameters:
- name: product_id
in: path
required: true
schema:
$ref: "#/components/schemas/ProductId"
description: "The ID for the product we wish to query"
- name: offset
in: query
schema:
type: integer
minimum: 0
description: "The number of items to skip before starting to collect the result set"
- name: limit
in: query
schema:
type: integer
minimum: 1
description: "The numbers of items to return"
get:
summary: "Returns the total capacity by SKU for all of the org's active subscriptions for given Swatch product ID."
operationId: getSkuCapacityReport
parameters:
- name: category
in: query
schema:
$ref: '#/components/schemas/ReportCategory'
description: 'The category to fetch data for'
- name: sla
in: query
schema:
$ref: '#/components/schemas/ServiceLevelType'
description: "Include only capacity for the specified service level."
- name: usage
in: query
schema:
$ref: '#/components/schemas/UsageType'
description: "Include only capacity for the specified usage level."
- name: billing_provider
in: query
schema:
$ref: '#/components/schemas/BillingProviderType'
description: "Include only report data matching the specified billing provider"
- name: billing_account_id
in: query
schema:
$ref: '#/components/schemas/BillingAccountId'
description: "Include only report data matching the specified billing account"
- name: beginning
in: query
schema:
type: string
format: date-time
description: "Defines the start of the report period. Dates should be provided in ISO 8601
format but the only accepted offset is UTC. E.g. 2017-07-21T17:32:28Z"
- name: ending
in: query
schema:
type: string
format: date-time
description: "Defines the end of the report period. Defaults to the current time. Dates should
be provided in UTC."
- name: uom
in: query
schema:
$ref: '#/components/schemas/Uom'
description: "Filter subscriptions to those that contribute to a specific unit of measure"
- name: sort
in: query
schema:
$ref: "#/components/schemas/SkuCapacityReportSort"
description: "What property to sort by (optional)"
- name: dir
in: query
schema:
$ref: "#/components/schemas/SortDirection"
description: "Which direction to sort by (default: asc)"
responses:
'200':
description: "The request for the account's subscription capacities was successful."
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/SkuCapacityReport"
example:
data:
- sku: RH00011
product_name: "Red Hat Enterprise Linux Server, Premium (Physical and 4 Virtual Nodes)(L3 Only)"
service_level: Premium
usage: Production
subscriptions:
- id: "1234567890"
number: "1234567891"
- id: "1234567892"
number: "1234567893"
- id: "1234567894"
number: "1234567895"
next_event_date: "2020-04-01T00:00:00Z"
next_event_type: Subscription Begin
quantity: 3
capacity: 3
hypervisor_capacity: 3
total_capacity: 6
uom: Sockets
- sku: RH00010
product_name: "Red Hat Enterprise Linux Server"
service_level: Self-Support
usage: Production
subscriptions:
- id: "1234567896"
number: "1234567897"
- id: "1234567898"
number: "1234567899"
- id: "1234567900"
number: "1234567901"
next_event_date: "2020-04-02T00:00:00Z"
next_event_type: Subscription Begin
quantity: 3
capacity: 3
hypervisor_capacity: 3
total_capacity": 6
uom: Sockets
- sku: RH00009
product_name: "Red Hat Enterprise Linux Server, Premium"
service_level: Premium
usage: Production
subscriptions:
- id: "1234567902"
number: "1234567903"
- id: "1234567904"
number: "1234567905"
- id: "1234567906"
number: "1234567907"
next_event_date: "2020-04-01T00:00:00Z"
next_event_type: Subscription End