-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathDataScienceAPI.yml
More file actions
13362 lines (13276 loc) · 423 KB
/
DataScienceAPI.yml
File metadata and controls
13362 lines (13276 loc) · 423 KB
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.0
info:
title: Data Science API
description: >
Use the Data Science API to organize your data science work, access data and
computing resources, and build, train, deploy and manage models and model
deployments. For more information, see [Data
Science](https://docs.oracle.com/iaas/data-science/using/data-science.htm).
version: 1.0.0
servers:
- url: http://{{baseurl}}
- url: https://modeldeployment.{{region}}.oci.customer-oci.com
tags:
- name: job Runs
- name: job Runs > {job Run Id}
- name: job Runs > {job Run Id} > actions
- name: jobs
- name: jobs > {job Id}
- name: jobs > {job Id} > artifact
- name: jobs > {job Id} > artifact > content
- name: model Deployments
- name: model Deployments > {model Deployment Id}
- name: model Deployments > {model Deployment Id} > actions
- name: models
- name: models > {model Id}
- name: models > {model Id} > actions
- name: models > {model Id} > artifact
- name: models > {model Id} > artifact > content
- name: models > {model Id} > provenance
- name: notebook Sessions
- name: notebook Sessions > {notebook Session Id}
- name: notebook Sessions > {notebook Session Id} > actions
- name: projects
- name: projects > {project Id}
- name: work Requests
- name: work Requests > {work Request Id}
paths:
/jobRuns/{jobRunId}/actions/cancelJobRun:
post:
tags:
- job Runs > {job Run Id} > actions
summary: CancelJobRun
description: Cancels an IN_PROGRESS job run.
requestBody:
content: {}
parameters:
- name: opc-request-id
in: header
schema:
type: string
description: >
Unique Oracle assigned identifier for the request. If you need to
contact Oracle about a particular request, then provide the request
ID.
example: eiusmod cillum in ad
- name: if-match
in: header
schema:
type: string
description: |
For optimistic concurrency control. In the PUT or DELETE call
for a resource, set the `if-match` parameter to the value of the
etag from a previous GET or POST response for that resource.
The resource is updated or deleted only if the `etag` you
provide matches the resource's current `etag` value.
example: eiusmod cillum in ad
- name: Date
in: header
schema:
type: string
description: (Required) Current Date
example: '{{date}}'
- name: Authorization
in: header
schema:
type: string
description: (Required) Signature Authentication on Authorization header
example: '{{signature}}'
- name: x-content-sha256
in: header
schema:
type: string
description: (Required) Content sha256 for POST, PUT and PATCH operations
example: '{{content_sha256}}'
- name: jobRunId
in: path
schema:
type: string
required: true
description: >-
(Required) The
[OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the job run.
example: eiusmod cillum in ad
responses:
'202':
description: Accepted
headers:
opc-request-id:
schema:
type: string
example: eiusmod cillum in ad
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
opc-request-id:
schema:
type: string
example: eiusmod cillum in ad
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
example:
code: ut proident exercitation
message: commodo ex mollit
'401':
description: Unauthorized
headers:
opc-request-id:
schema:
type: string
example: eiusmod cillum in ad
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
example:
code: ut proident exercitation
message: commodo ex mollit
'404':
description: Not Found
headers:
opc-request-id:
schema:
type: string
example: eiusmod cillum in ad
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
example:
code: ut proident exercitation
message: commodo ex mollit
'409':
description: Conflict
headers:
opc-request-id:
schema:
type: string
example: eiusmod cillum in ad
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
example:
code: ut proident exercitation
message: commodo ex mollit
'412':
description: Precondition Failed
headers:
opc-request-id:
schema:
type: string
example: eiusmod cillum in ad
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
example:
code: ut proident exercitation
message: commodo ex mollit
'429':
description: Too Many Requests
headers:
opc-request-id:
schema:
type: string
example: eiusmod cillum in ad
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
example:
code: ut proident exercitation
message: commodo ex mollit
'500':
description: Internal Server Error
headers:
opc-request-id:
schema:
type: string
example: eiusmod cillum in ad
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
examples:
example-0:
summary: Internal Server Error
value:
code: ut proident exercitation
message: commodo ex mollit
example-1:
summary: An error has occurred.
value:
code: ut proident exercitation
message: commodo ex mollit
/jobRuns/{jobRunId}/actions/changeCompartment:
post:
tags:
- job Runs > {job Run Id} > actions
summary: ChangeJobRunCompartment
description: Changes a job run's compartment
requestBody:
content:
'*/*':
schema:
type: string
example: '"{\n \"compartmentId\": \"{{compartment_ocid}}\"\n}"'
parameters:
- name: if-match
in: header
schema:
type: string
description: |
For optimistic concurrency control. In the PUT or DELETE call
for a resource, set the `if-match` parameter to the value of the
etag from a previous GET or POST response for that resource.
The resource is updated or deleted only if the `etag` you
provide matches the resource's current `etag` value.
example: eiusmod cillum in ad
- name: opc-request-id
in: header
schema:
type: string
description: >
Unique Oracle assigned identifier for the request. If you need to
contact Oracle about a particular request, then provide the request
ID.
example: eiusmod cillum in ad
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: Date
in: header
schema:
type: string
description: (Required) Current Date
example: '{{date}}'
- name: Authorization
in: header
schema:
type: string
description: (Required) Signature Authentication on Authorization header
example: '{{signature}}'
- name: x-content-sha256
in: header
schema:
type: string
description: (Required) Content sha256 for POST, PUT and PATCH operations
example: '{{content_sha256}}'
- name: jobRunId
in: path
schema:
type: string
required: true
description: >-
(Required) The
[OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the job run.
example: eiusmod cillum in ad
responses:
'204':
description: No Content
headers:
opc-request-id:
schema:
type: string
example: eiusmod cillum in ad
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
opc-request-id:
schema:
type: string
example: eiusmod cillum in ad
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
example:
code: ut proident exercitation
message: commodo ex mollit
'401':
description: Unauthorized
headers:
opc-request-id:
schema:
type: string
example: eiusmod cillum in ad
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
example:
code: ut proident exercitation
message: commodo ex mollit
'404':
description: Not Found
headers:
opc-request-id:
schema:
type: string
example: eiusmod cillum in ad
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
example:
code: ut proident exercitation
message: commodo ex mollit
'409':
description: Conflict
headers:
opc-request-id:
schema:
type: string
example: eiusmod cillum in ad
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
example:
code: ut proident exercitation
message: commodo ex mollit
'412':
description: Precondition Failed
headers:
opc-request-id:
schema:
type: string
example: eiusmod cillum in ad
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
example:
code: ut proident exercitation
message: commodo ex mollit
'429':
description: Too Many Requests
headers:
opc-request-id:
schema:
type: string
example: eiusmod cillum in ad
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
example:
code: ut proident exercitation
message: commodo ex mollit
'500':
description: Internal Server Error
headers:
opc-request-id:
schema:
type: string
example: eiusmod cillum in ad
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
examples:
example-0:
summary: Internal Server Error
value:
code: ut proident exercitation
message: commodo ex mollit
example-1:
summary: An error has occurred.
value:
code: ut proident exercitation
message: commodo ex mollit
/jobRuns/{jobRunId}:
delete:
tags:
- job Runs > {job Run Id}
summary: DeleteJobRun
description: Deletes a job run.
parameters:
- name: if-match
in: header
schema:
type: string
description: |
For optimistic concurrency control. In the PUT or DELETE call
for a resource, set the `if-match` parameter to the value of the
etag from a previous GET or POST response for that resource.
The resource is updated or deleted only if the `etag` you
provide matches the resource's current `etag` value.
example: eiusmod cillum in ad
- name: opc-request-id
in: header
schema:
type: string
description: >
Unique Oracle assigned identifier for the request. If you need to
contact Oracle about a particular request, then provide the request
ID.
example: eiusmod cillum in ad
- name: Date
in: header
schema:
type: string
description: (Required) Current Date
example: '{{date}}'
- name: Authorization
in: header
schema:
type: string
description: (Required) Signature Authentication on Authorization header
example: '{{signature}}'
- name: jobRunId
in: path
schema:
type: string
required: true
description: >-
(Required) The
[OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the job run.
example: eiusmod cillum in ad
responses:
'204':
description: No Content
headers:
opc-request-id:
schema:
type: string
example: eiusmod cillum in ad
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
opc-request-id:
schema:
type: string
example: eiusmod cillum in ad
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
example:
code: ut proident exercitation
message: commodo ex mollit
'401':
description: Unauthorized
headers:
opc-request-id:
schema:
type: string
example: eiusmod cillum in ad
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
example:
code: ut proident exercitation
message: commodo ex mollit
'404':
description: Not Found
headers:
opc-request-id:
schema:
type: string
example: eiusmod cillum in ad
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
example:
code: ut proident exercitation
message: commodo ex mollit
'409':
description: Conflict
headers:
opc-request-id:
schema:
type: string
example: eiusmod cillum in ad
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
example:
code: ut proident exercitation
message: commodo ex mollit
'412':
description: Precondition Failed
headers:
opc-request-id:
schema:
type: string
example: eiusmod cillum in ad
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
example:
code: ut proident exercitation
message: commodo ex mollit
'429':
description: Too Many Requests
headers:
opc-request-id:
schema:
type: string
example: eiusmod cillum in ad
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
example:
code: ut proident exercitation
message: commodo ex mollit
'500':
description: Internal Server Error
headers:
opc-request-id:
schema:
type: string
example: eiusmod cillum in ad
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
examples:
example-0:
summary: Internal Server Error
value:
code: ut proident exercitation
message: commodo ex mollit
example-1:
summary: An error has occurred.
value:
code: ut proident exercitation
message: commodo ex mollit
get:
tags:
- job Runs > {job Run Id}
summary: GetJobRun
description: Gets a job run.
parameters:
- name: opc-request-id
in: header
schema:
type: string
description: >
Unique Oracle assigned identifier for the request. If you need to
contact Oracle about a particular request, then provide the request
ID.
example: eiusmod cillum in ad
- name: Date
in: header
schema:
type: string
description: (Required) Current Date
example: '{{date}}'
- name: Authorization
in: header
schema:
type: string
description: (Required) Signature Authentication on Authorization header
example: '{{signature}}'
- name: jobRunId
in: path
schema:
type: string
required: true
description: >-
(Required) The
[OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the job run.
example: eiusmod cillum in ad
responses:
'200':
description: OK
headers:
etag:
schema:
type: string
example: eiusmod cillum in ad
opc-request-id:
schema:
type: string
example: eiusmod cillum in ad
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
example:
id: Ut aliquip officia dolor
timeAccepted: '1974-05-08T17:07:56.096Z'
createdBy: Duis eu minim culpa
projectId: eu mollit nulla labore ad
compartmentId: laborum
jobId: consectetur laboris dolor
jobInfrastructureConfigurationDetails:
jobInfrastructureType: STANDALONE
jobConfigurationOverrideDetails:
jobType: DEFAULT
lifecycleState: SUCCEEDED
definedTags: {}
displayName: eu dolor
freeformTags: {}
jobLogConfigurationOverrideDetails:
enableAutoLogCreation: false
enableLogging: false
logGroupId: laboris fugiat
logId: eu esse
lifecycleDetails: ut et voluptate eu ea
logDetails:
logGroupId: pariatur elit esse
logId: nisi non dolore laboris
timeFinished: '1983-03-25T19:53:43.924Z'
timeStarted: '1973-10-03T21:25:12.208Z'
'400':
description: Bad Request
headers:
opc-request-id:
schema:
type: string
example: eiusmod cillum in ad
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
example:
code: ut proident exercitation
message: commodo ex mollit
'401':
description: Unauthorized
headers:
opc-request-id:
schema:
type: string
example: eiusmod cillum in ad
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
example:
code: ut proident exercitation
message: commodo ex mollit
'404':
description: Not Found
headers:
opc-request-id:
schema:
type: string
example: eiusmod cillum in ad
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
example:
code: ut proident exercitation
message: commodo ex mollit
'409':
description: Conflict
headers:
opc-request-id:
schema:
type: string
example: eiusmod cillum in ad
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
example:
code: ut proident exercitation
message: commodo ex mollit
'429':
description: Too Many Requests
headers:
opc-request-id:
schema:
type: string
example: eiusmod cillum in ad
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
example:
code: ut proident exercitation
message: commodo ex mollit
'500':
description: Internal Server Error
headers:
opc-request-id:
schema:
type: string
example: eiusmod cillum in ad
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
examples:
example-0:
summary: Internal Server Error
value:
code: ut proident exercitation
message: commodo ex mollit
example-1:
summary: An error has occurred.
value:
code: ut proident exercitation
message: commodo ex mollit
put:
tags:
- job Runs > {job Run Id}
summary: UpdateJobRun
description: Updates a job run.
requestBody:
content:
'*/*':
schema:
type: string
example: >-
"{\n \"definedTags\": {},\n \"displayName\":
\"aliquip\",\n \"freeformTags\": {}\n}"
parameters:
- name: opc-request-id
in: header
schema:
type: string
description: >
Unique Oracle assigned identifier for the request. If you need to
contact Oracle about a particular request, then provide the request
ID.
example: eiusmod cillum in ad
- name: if-match
in: header
schema:
type: string
description: |
For optimistic concurrency control. In the PUT or DELETE call
for a resource, set the `if-match` parameter to the value of the
etag from a previous GET or POST response for that resource.
The resource is updated or deleted only if the `etag` you
provide matches the resource's current `etag` value.
example: eiusmod cillum in ad
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: Date
in: header
schema:
type: string
description: (Required) Current Date
example: '{{date}}'
- name: Authorization
in: header
schema:
type: string
description: (Required) Signature Authentication on Authorization header
example: '{{signature}}'
- name: x-content-sha256
in: header
schema:
type: string
description: (Required) Content sha256 for POST, PUT and PATCH operations
example: '{{content_sha256}}'
- name: jobRunId
in: path
schema:
type: string
required: true
description: >-
(Required) The
[OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the job run.
example: eiusmod cillum in ad
responses:
'200':
description: OK
headers:
etag:
schema:
type: string
example: eiusmod cillum in ad
opc-request-id:
schema:
type: string
example: eiusmod cillum in ad
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
example:
id: Ut aliquip officia dolor
timeAccepted: '1974-05-08T17:07:56.096Z'
createdBy: Duis eu minim culpa
projectId: eu mollit nulla labore ad
compartmentId: laborum
jobId: consectetur laboris dolor
jobInfrastructureConfigurationDetails:
jobInfrastructureType: STANDALONE
jobConfigurationOverrideDetails:
jobType: DEFAULT
lifecycleState: SUCCEEDED
definedTags: {}
displayName: eu dolor
freeformTags: {}
jobLogConfigurationOverrideDetails:
enableAutoLogCreation: false
enableLogging: false
logGroupId: laboris fugiat
logId: eu esse
lifecycleDetails: ut et voluptate eu ea
logDetails:
logGroupId: pariatur elit esse
logId: nisi non dolore laboris
timeFinished: '1983-03-25T19:53:43.924Z'
timeStarted: '1973-10-03T21:25:12.208Z'
'400':
description: Bad Request
headers:
opc-request-id:
schema:
type: string
example: eiusmod cillum in ad
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
example:
code: ut proident exercitation
message: commodo ex mollit
'401':
description: Unauthorized
headers:
opc-request-id:
schema:
type: string
example: eiusmod cillum in ad
Content-Type: