-
Notifications
You must be signed in to change notification settings - Fork 175
Expand file tree
/
Copy pathschema.graphql
More file actions
3743 lines (3084 loc) · 92.4 KB
/
schema.graphql
File metadata and controls
3743 lines (3084 loc) · 92.4 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
extend schema
@link(url: "https://specs.apollo.dev/federation/v2.7", import: ["@key", "@shareable"])
"""
The Relay compliant `PageInfo` type, containing data necessary to paginate this connection.
"""
type PageInfo @shareable {
"""When paginating forwards, are there more items?"""
hasNextPage: Boolean!
"""When paginating backwards, are there more items?"""
hasPreviousPage: Boolean!
"""When paginating backwards, the cursor to continue."""
startCursor: String
"""When paginating forwards, the cursor to continue."""
endCursor: String
}
type Query {
node(
"""The ID of the object"""
id: ID!
): Node
"""Added in 25.6.0."""
audit_log_schema: AuditLogSchema
"""Added in 25.6.0."""
audit_log_nodes(
"""
Specifies the criteria used to narrow down the query results based on certain conditions.
"""
filter: String
"""Specifies the sorting order of the query result."""
order: String
"""Specifies how many items to skip before beginning to return result."""
offset: Int
"""If this value is provided, the query will be limited to that value."""
before: String
"""Queries the `last` number of results from the query result from last."""
after: String
"""
Queries the `first` number of results from the query result from first.
"""
first: Int
"""If the given value is provided, the query will start from that value."""
last: Int
): AuditLogConnection
agent(agent_id: String!): Agent
agent_list(limit: Int!, offset: Int!, filter: String, order: String, scaling_group: String, status: String): AgentList
agents(scaling_group: String, status: String): [Agent]
agent_summary(agent_id: String!): AgentSummary
agent_summary_list(limit: Int!, offset: Int!, filter: String, order: String, scaling_group: String, status: String): AgentSummaryList
"""Added in 24.12.0."""
domain_node(id: GlobalIDField!, permission: DomainPermissionValueField = "read_attribute"): DomainNode
"""Added in 24.12.0."""
domain_nodes(filter: String, order: String, permission: DomainPermissionValueField = "read_attribute", offset: Int, before: String, after: String, first: Int, last: Int): DomainConnection
"""Added in 24.12.0."""
agent_nodes(
"""Added in 24.12.0. Default is `system`."""
scope: ScopeField
"""Added in 24.12.0. Default is create_compute_session."""
permission: AgentPermissionField = "create_compute_session"
filter: String
order: String
offset: Int
before: String
after: String
first: Int
last: Int
): AgentConnection
domain(name: String): Domain
domains(is_active: Boolean): [Domain]
"""Added in 24.03.0."""
group_node(id: String!): GroupNode
"""Added in 24.03.0."""
group_nodes(
"""Added in 24.09.0."""
filter: String
"""Added in 24.09.0."""
order: String
"""Added in 25.3.0. Default is `system`."""
scope: ScopeField
"""Added in 25.3.0."""
container_registry_scope: ContainerRegistryScopeField
"""Added in 25.3.0. Default is read_attribute."""
permission: GroupPermissionField = "read_attribute"
offset: Int
before: String
after: String
first: Int
last: Int
): GroupConnection
group(
id: UUID!
domain_name: String
"""Added in 24.03.0."""
type: [String] = ["GENERAL"]
): Group
groups_by_name(name: String!, domain_name: String): [Group]
groups(
domain_name: String
is_active: Boolean
"""Added in 24.03.0. Available values: GENERAL, MODEL_STORE"""
type: [String] = ["GENERAL"]
): [Group]
image(
"""Added in 24.03.1"""
id: String
reference: String
"""
Changed to nullable in 26.1. If not provided, defaults to the Manager's architecture.
"""
architecture: String = null
): Image
images(
"""
Added in 19.09.0. If it is specified, fetch images installed on at least one agent.
"""
is_installed: Boolean
is_operation: Boolean @deprecated(reason: "Deprecated since 24.03.4. This field is ignored if `load_filters` is specified and is not null.")
"""Added in 25.4.0."""
filter_by_statuses: [ImageStatus] = [ALIVE]
"""
Added in 24.03.8. Allowed values are: [general, operational, customized]. When superuser queries with `customized` option set the resolver will return every customized images (including those not owned by callee). To resolve images owned by user only call `customized_images`.
"""
load_filters: [String] = null
"""
Added in 24.03.4. Allowed values are: [general, operational, customized]. When superuser queries with `customized` option set the resolver will return every customized images (including those not owned by caller). To list the owned images only call `customized_images`.
"""
image_filters: [String] = null @deprecated(reason: "Deprecated since 24.03.8. Use `load_filters` instead.")
): [Image]
"""Added in 24.03.1"""
customized_images: [ImageNode]
"""Added in 25.3.0."""
image_node(
id: GlobalIDField!
scope_id: ScopeField
"""Default is read_attribute."""
permission: ImagePermissionValueField = "read_attribute"
): ImageNode
"""Added in 25.3.0."""
image_nodes(
scope_id: ScopeField!
"""Default is read_attribute."""
permission: ImagePermissionValueField = "read_attribute"
"""Added in 25.4.0."""
filter_by_statuses: [ImageStatus] = [ALIVE]
filter: String
order: String
offset: Int
before: String
after: String
first: Int
last: Int
): ImageConnection
"""Added in 25.14.2. Returns information about the current user."""
viewer: Viewer
user(domain_name: String, email: String): User
user_from_uuid(domain_name: String, user_id: ID): User
users(domain_name: String, group_id: UUID, is_active: Boolean, status: String): [User]
user_list(limit: Int!, offset: Int!, filter: String, order: String, domain_name: String, group_id: UUID, is_active: Boolean, status: String): UserList
"""Added in 24.03.0."""
user_node(id: String!): UserNode
"""Added in 24.03.0."""
user_nodes(filter: String, order: String, offset: Int, before: String, after: String, first: Int, last: Int): UserConnection
keypair(domain_name: String, access_key: String): KeyPair
keypairs(domain_name: String, email: String, is_active: Boolean): [KeyPair]
keypair_list(limit: Int!, offset: Int!, filter: String, order: String, domain_name: String, email: String, is_active: Boolean): KeyPairList
keypair_resource_policy(name: String): KeyPairResourcePolicy
user_resource_policy(name: String): UserResourcePolicy
project_resource_policy(name: String!): ProjectResourcePolicy
keypair_resource_policies: [KeyPairResourcePolicy]
user_resource_policies: [UserResourcePolicy]
project_resource_policies: [ProjectResourcePolicy]
resource_preset(name: String): ResourcePreset
"""Added in 25.4.0."""
resource_preset_by_id(id: UUID): ResourcePreset
resource_presets(
"""Added in 25.4.0."""
filter: String
"""Added in 25.4.0."""
order: String
): [ResourcePreset]
scaling_group(name: String): ScalingGroup
scaling_groups(name: String, is_active: Boolean): [ScalingGroup]
"""
Added in 25.5.0. This query is available for all users. It returns the resource groups(=scaling groups) that the user has access to. Only name, is_active, own_session_occupied_resource_slots and accelerator_quantum_size fields are returned.
"""
accessible_scaling_groups(project_id: UUID!): [ScalingGroup]
scaling_groups_for_domain(domain: String!, is_active: Boolean): [ScalingGroup]
scaling_groups_for_user_group(user_group: String!, is_active: Boolean): [ScalingGroup]
scaling_groups_for_keypair(access_key: String!, is_active: Boolean): [ScalingGroup]
storage_volume(id: String): StorageVolume
storage_volume_list(limit: Int!, offset: Int!, filter: String, order: String): StorageVolumeList
vfolder(id: String): VirtualFolder
"""Added in 24.03.4."""
vfolder_node(id: String!): VirtualFolderNode
"""Added in 24.03.4."""
vfolder_nodes(
"""Added in 24.12.0."""
scope_id: ScopeField
"""Added in 24.09.0."""
project_id: UUID @deprecated(reason: "Deprecated since 24.12.0. use `scope_id` instead.")
"""Added in 24.09.0."""
permission: VFolderPermissionValueField
filter: String
order: String
offset: Int
before: String
after: String
first: Int
last: Int
): VirtualFolderConnection
vfolder_list(limit: Int!, offset: Int!, filter: String, order: String, domain_name: String, group_id: UUID, access_key: String): VirtualFolderList
vfolder_permission_list(limit: Int!, offset: Int!, filter: String, order: String): VirtualFolderPermissionList
vfolder_own_list(limit: Int!, offset: Int!, filter: String, order: String, domain_name: String, access_key: String): VirtualFolderList
vfolder_invited_list(limit: Int!, offset: Int!, filter: String, order: String, domain_name: String, access_key: String): VirtualFolderList
vfolder_project_list(limit: Int!, offset: Int!, filter: String, order: String, domain_name: String, access_key: String): VirtualFolderList
vfolders(domain_name: String, group_id: String, access_key: String): [VirtualFolder]
"""Added in 24.09.0."""
compute_session_node(
id: GlobalIDField!
"""Added in 24.12.0."""
scope_id: ScopeField
"""Added in 24.09.0."""
project_id: UUID @deprecated(reason: "Deprecated since 24.12.0. use `scope_id` instead.")
"""Added in 24.09.0. Default is read_attribute."""
permission: SessionPermissionValueField = "read_attribute"
): ComputeSessionNode
"""Added in 24.09.0."""
compute_session_nodes(
"""Added in 24.12.0."""
scope_id: ScopeField
"""Added in 24.09.0."""
project_id: UUID @deprecated(reason: "Deprecated since 24.12.0. use `scope_id` instead.")
"""Added in 24.09.0. Default is read_attribute."""
permission: SessionPermissionValueField = "read_attribute"
filter: String
order: String
offset: Int
before: String
after: String
first: Int
last: Int
): ComputeSessionConnection
"""Added in 25.13.0."""
session_pending_queue(
resource_group_id: String!
"""Specifies how many items to skip before beginning to return result."""
offset: Int
"""If this value is provided, the query will be limited to that value."""
before: String
"""Queries the `last` number of results from the query result from last."""
after: String
"""
Queries the `first` number of results from the query result from first.
"""
first: Int
"""If the given value is provided, the query will start from that value."""
last: Int
): SessionPendingQueueConnection
compute_session(id: UUID!): ComputeSession
compute_container(id: UUID!): ComputeContainer
compute_session_list(limit: Int!, offset: Int!, filter: String, order: String, domain_name: String, group_id: String, access_key: String, status: String): ComputeSessionList
compute_container_list(limit: Int!, offset: Int!, filter: String, order: String, session_id: ID!, role: String): ComputeContainerList
legacy_compute_session_list(limit: Int!, offset: Int!, order_key: String, order_asc: Boolean, domain_name: String, group_id: String, access_key: String, status: String): LegacyComputeSessionList
legacy_compute_session(sess_id: String!, domain_name: String, access_key: String): LegacyComputeSession
"""Added in 25.5.0."""
total_resource_slot(
"""
`statuses` argument is an array of session statuses. Only sessions with the specified statuses will be queried to calculate the sum of total resource slots. The argument should be an array of the following valid status values: ['PENDING', 'DEPRIORITIZING', 'SCHEDULED', 'PREPARING', 'PULLING', 'PREPARED', 'CREATING', 'RUNNING', 'RESTARTING', 'RUNNING_DEGRADED', 'TERMINATING', 'TERMINATED', 'ERROR', 'CANCELLED'].
Default value is null.
"""
statuses: [String] = null
"""
`filter` argument is a string that is parsed into query conditions. It works in the same way as the `filter` argument in the `compute_session` query schema, meaning the values are parsed into an identical SQL query expression.
Default value is `null`.
"""
filter: String
domain_name: String
resource_group_name: String
): TotalResourceSlot
vfolder_host_permissions: PredefinedAtomicPermission
endpoint(endpoint_id: UUID!): Endpoint
endpoint_list(limit: Int!, offset: Int!, filter: String, order: String, domain_name: String, group_id: String, user_uuid: String, project: UUID): EndpointList
routing(routing_id: UUID!): Routing
routing_list(limit: Int!, offset: Int!, filter: String, order: String, endpoint_id: UUID): RoutingList
endpoint_token(token: String!): EndpointToken
endpoint_token_list(limit: Int!, offset: Int!, filter: String, order: String, endpoint_id: UUID): EndpointTokenList
quota_scope(storage_host_name: String!, quota_scope_id: String!): QuotaScope
container_registry(hostname: String!): ContainerRegistry @deprecated(reason: "Deprecated since 24.9.0. use `container_registry_node` instead.")
container_registries: [ContainerRegistry] @deprecated(reason: "Deprecated since 24.9.0. use `container_registry_nodes_v2` instead.")
"""Added in 24.09.0."""
container_registry_node(id: String!): ContainerRegistryNode
"""Added in 24.09.0."""
container_registry_nodes(filter: String, order: String, offset: Int, before: String, after: String, first: Int, last: Int): ContainerRegistryConnection
"""Added in 24.03.0."""
model_card(id: String!): ModelCard
"""Added in 24.03.0."""
model_cards(filter: String, order: String, offset: Int, before: String, after: String, first: Int, last: Int): ModelCardConnection
"""Added in 24.12.0."""
network(id: String!): NetworkNode
"""Added in 24.12.0."""
networks(filter: String, order: String, offset: Int, before: String, after: String, first: Int, last: Int): NetworkConnection
"""Added in 25.1.0."""
endpoint_auto_scaling_rule_node(id: String!): EndpointAutoScalingRuleNode
"""Added in 25.1.0."""
endpoint_auto_scaling_rule_nodes(endpoint: String!, filter: String, order: String, offset: Int, before: String, after: String, first: Int, last: Int): EndpointAutoScalingRuleConnection
"""Added in 25.6.0."""
user_utilization_metric(user_id: UUID!, props: UserUtilizationMetricQueryInput!): UserUtilizationMetric
"""Added in 25.6.0."""
container_utilization_metric_metadata: ContainerUtilizationMetricMetadata
"""Added in 25.8.0."""
available_service: AvailableServiceNode
"""Added in 25.8.0."""
available_services(filter: String, order: String, offset: Int, before: String, after: String, first: Int, last: Int): AvailableServiceConnection
"""Added in 25.8.0."""
service_config(service: String!): ServiceConfigNode
"""Added in 25.8.0."""
service_configs(services: [String]!, filter: String, order: String, offset: Int, before: String, after: String, first: Int, last: Int): ServiceConfigConnection
_entities(representations: [_Any!]!): [_Entity]!
_service: _Service!
}
"""
This GraphQL Relay Node extension is for running asynchronous resolvers and fine-grained handling of global id.
Refer to: https://github.com/graphql-python/graphene/blob/master/graphene/relay/node.py
"""
interface Node {
"""The ID of the object"""
id: ID!
}
"""
A schema that contains metadata related to the AuditLogNode.
It provides a list of values, such as entity_type and status, that can be used in the AuditLog, allowing clients to retrieve them.
Added in 25.6.0.
"""
type AuditLogSchema {
"""
Possible values of "AuditLogNode.entity_type"
"""
entity_type_variants: [String]
"""
Possible values of "AuditLogNode.status"
"""
status_variants: [String]
}
"""Added in 25.6.0."""
type AuditLogConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
"""Contains the nodes in this connection."""
edges: [AuditLogEdge]!
"""Total count of the GQL nodes of the query."""
count: Int
}
"""Added in 25.6.0. A Relay edge containing a `AuditLog` and its cursor."""
type AuditLogEdge {
"""The item at the end of the edge"""
node: AuditLogNode
"""A cursor for use in pagination"""
cursor: String!
}
"""Added in 25.6.0."""
type AuditLogNode implements Node {
"""The ID of the object"""
id: ID!
"""UUID of the AuditLog row"""
row_id: UUID!
"""Added in 25.6.0. UUID of the action"""
action_id: UUID!
"""Entity type of the AuditLog"""
entity_type: String!
"""Operation type of the AuditLog"""
operation: String!
"""Entity ID of the AuditLog"""
entity_id: String
"""The time the AuditLog was reported"""
created_at: DateTime!
"""Request ID of the AuditLog"""
request_id: String
"""Added in 25.12.0, User ID that triggered the action"""
triggered_by: String
"""Description of the AuditLog"""
description: String!
"""Duration taken to perform the operation"""
duration: String
"""Status of the AuditLog"""
status: String!
}
"""
Leverages the internal Python implementation of UUID (uuid.UUID) to provide native UUID objects
in fields, resolvers and input.
"""
scalar UUID
"""
The `DateTime` scalar type represents a DateTime
value as specified by
[iso8601](https://en.wikipedia.org/wiki/ISO_8601).
"""
scalar DateTime
type Agent implements Item {
id: ID
status: String
status_changed: DateTime
region: String
scaling_group: String
schedulable: Boolean
available_slots: JSONString
occupied_slots: JSONString
addr: String
architecture: String
first_contact: DateTime
lost_at: DateTime
live_stat: JSONString
version: String
compute_plugins: JSONString
hardware_metadata: JSONString
auto_terminate_abusing_kernel: Boolean
local_config: JSONString
container_count: Int
"""Added in 25.4.0."""
gpu_alloc_map: UUIDFloatMap
mem_slots: Int
cpu_slots: Float
gpu_slots: Float
tpu_slots: Float
used_mem_slots: Int
used_cpu_slots: Float
used_gpu_slots: Float
used_tpu_slots: Float
cpu_cur_pct: Float
mem_cur_bytes: Float
compute_containers(status: String): [ComputeContainer]
}
interface Item {
id: ID
}
"""
Allows use of a JSON String for input / output from the GraphQL schema.
Use of this type is *not recommended* as you lose the benefits of having a defined, static
schema (one of the key benefits of GraphQL).
"""
scalar JSONString
"""
Added in 25.4.0.
Verifies that the key is a UUID (represented as a string) and the value is a float.
"""
scalar UUIDFloatMap
type ComputeContainer implements Item {
id: ID
idx: Int
role: String
hostname: String
"""Added in 24.03.1."""
kernel_id: UUID
cluster_idx: Int
local_rank: Int
cluster_role: String
cluster_hostname: String
session_id: UUID
"""Deprecated since 24.03.0; use image_object.name"""
image: String
"""Added in 24.03.0."""
image_object: ImageNode
architecture: String
registry: String
status: String
status_changed: DateTime
status_info: String
status_data: JSONString
created_at: DateTime
terminated_at: DateTime
starts_at: DateTime
scheduled_at: DateTime
abusing_report: JSONString
agent: String
agent_addr: String
container_id: String
resource_opts: JSONString
occupied_slots: JSONString
live_stat: JSONString
last_stat: JSONString
preopen_ports: [Int]
}
type ImageNode implements Node @key(fields: "id") {
"""The ID of the object"""
id: ID!
"""Added in 24.03.4. The undecoded id value stored in DB."""
row_id: UUID
name: String @deprecated(reason: "Deprecated since 24.12.0. use `namespace` instead")
"""Added in 24.12.0."""
namespace: String
"""Added in 24.12.0."""
base_image_name: String
"""Added in 24.03.10."""
project: String
humanized_name: String
tag: String
"""Added in 24.12.0."""
tags: [KVPair]
"""Added in 24.12.0."""
version: String
registry: String
architecture: String
is_local: Boolean
digest: String
labels: [KVPair]
size_bytes: BigInt
"""Added in 25.4.0."""
status: String
resource_limits: [ResourceLimit]
supported_accelerators: [String]
"""Added in 24.03.4. The array of image aliases."""
aliases: [String]
"""
Added in 25.3.0. One of ['read_attribute', 'update_attribute', 'create_container', 'forget_image'].
"""
permissions: [ImagePermissionValueField]
"""Added in 25.11.0. Indicates if the image is installed on any Agent."""
installed: Boolean
"""Added in 25.12.0."""
type: ImageType
}
type KVPair @shareable {
key: String
value: String
}
"""
BigInt is an extension of the regular graphene.Int scalar type
to support integers outside the range of a signed 32-bit integer.
"""
scalar BigInt
type ResourceLimit @shareable {
key: String
min: String
max: String @deprecated(reason: "Deprecated since 25.14.0. The max slot limit validation has been removed as it was deemed obsolete.")
}
"""
Added in 25.3.0. One of ['read_attribute', 'update_attribute', 'create_container', 'forget_image'].
"""
scalar ImagePermissionValueField
"""Added in 25.12.0."""
enum ImageType {
COMPUTE
SYSTEM
SERVICE
}
type AgentList implements PaginatedList {
items: [Agent]!
total_count: Int!
}
interface PaginatedList {
items: [Item]!
total_count: Int!
}
"""A schema for normal users."""
type AgentSummary implements Item {
id: ID
status: String
scaling_group: String
schedulable: Boolean
available_slots: JSONString
occupied_slots: JSONString
architecture: String
}
type AgentSummaryList implements PaginatedList {
items: [AgentSummary]!
total_count: Int!
}
"""Added in 24.12.0."""
type DomainNode implements Node @key(fields: "id") {
"""The ID of the object"""
id: ID!
name: String
description: String
is_active: Boolean
created_at: DateTime
modified_at: DateTime
total_resource_slots: JSONString
allowed_vfolder_hosts: JSONString
allowed_docker_registries: [String]
dotfiles: Bytes
integration_id: String
scaling_groups(filter: String, order: String, offset: Int, before: String, after: String, first: Int, last: Int): ScalingGroupConnection
}
"""Added in 24.09.1."""
scalar Bytes
"""Added in 24.12.0."""
type ScalingGroupConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
"""Contains the nodes in this connection."""
edges: [ScalingGroupEdge]!
"""Total count of the GQL nodes of the query."""
count: Int
}
"""
Added in 24.12.0. A Relay edge containing a `ScalingGroup` and its cursor.
"""
type ScalingGroupEdge {
"""The item at the end of the edge"""
node: ScalingGroupNode
"""A cursor for use in pagination"""
cursor: String!
}
"""Added in 24.12.0."""
type ScalingGroupNode implements Node @key(fields: "id") {
"""The ID of the object"""
id: ID!
name: String
description: String
is_active: Boolean
is_public: Boolean
created_at: DateTime
wsproxy_addr: String
wsproxy_api_token: String
driver: String
driver_opts: JSONString
scheduler: String
scheduler_opts: JSONString
use_host_network: Boolean
}
"""
Added in 24.09.0. Global ID of GQL relay spec. Base64 encoded version of "<node type name>:<node id>". UUID or string type values are also allowed.
"""
scalar GlobalIDField
"""
Added in 24.12.0. One of ['read_attribute', 'read_sensitive_attribute', 'update_attribute', 'create_user', 'create_project'].
"""
scalar DomainPermissionValueField
"""Added in 24.12.0"""
type DomainConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
"""Contains the nodes in this connection."""
edges: [DomainEdge]!
"""Total count of the GQL nodes of the query."""
count: Int
}
"""Added in 24.12.0 A Relay edge containing a `Domain` and its cursor."""
type DomainEdge {
"""The item at the end of the edge"""
node: DomainNode
"""A cursor for use in pagination"""
cursor: String!
}
"""Added in 24.12.0."""
type AgentConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
"""Contains the nodes in this connection."""
edges: [AgentEdge]!
"""Total count of the GQL nodes of the query."""
count: Int
}
"""Added in 24.12.0. A Relay edge containing a `Agent` and its cursor."""
type AgentEdge {
"""The item at the end of the edge"""
node: AgentNode
"""A cursor for use in pagination"""
cursor: String!
}
"""Added in 24.12.0."""
type AgentNode implements Node {
"""The ID of the object"""
id: ID!
row_id: String
status: String
status_changed: DateTime
region: String
scaling_group: String
schedulable: Boolean
available_slots: JSONString
occupied_slots: JSONString
"""Agent's address with port. (bind/advertised host:port)"""
addr: String
architecture: String
first_contact: DateTime
lost_at: DateTime
live_stat: JSONString
version: String
compute_plugins: JSONString
hardware_metadata: JSONString
auto_terminate_abusing_kernel: Boolean
local_config: JSONString
container_count: Int
"""Added in 25.4.0."""
gpu_alloc_map: UUIDFloatMap
kernel_nodes(filter: String, order: String, offset: Int, before: String, after: String, first: Int, last: Int): KernelConnection
"""
Added in 24.12.0. One of ['read_attribute', 'update_attribute', 'create_compute_session', 'create_service'].
"""
permissions: [AgentPermissionField]
}
"""Added in 24.09.0."""
type KernelConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
"""Contains the nodes in this connection."""
edges: [KernelEdge]!
"""Total count of the GQL nodes of the query."""
count: Int
}
"""Added in 24.09.0. A Relay edge containing a `Kernel` and its cursor."""
type KernelEdge {
"""The item at the end of the edge"""
node: KernelNode
"""A cursor for use in pagination"""
cursor: String!
}
"""Added in 24.09.0."""
type KernelNode implements Node {
"""The ID of the object"""
id: ID!
"""ID of kernel."""
row_id: UUID
cluster_idx: Int
local_rank: Int
cluster_role: String
cluster_hostname: String
session_id: UUID
image: ImageNode
"""Added in 25.4.0."""
image_reference: String
"""
Added in 25.4.0. The architecture that the image of this kernel requires
"""
architecture: String
status: String
status_changed: DateTime
status_info: String
status_data: JSONString
created_at: DateTime
terminated_at: DateTime
starts_at: DateTime
scheduled_at: DateTime
agent_id: String
agent_addr: String
container_id: String
resource_opts: JSONString
occupied_slots: JSONString
live_stat: JSONString
abusing_report: JSONString
preopen_ports: [Int]
}
"""
Added in 24.12.0. One of ['read_attribute', 'update_attribute', 'create_compute_session', 'create_service'].
"""
scalar AgentPermissionField
"""
Added in 24.12.0. A string value in the format '<SCOPE_TYPE>:<SCOPE_ID>'. <SCOPE_TYPE> should be one of [system, domain, project, user]. <SCOPE_ID> should be the ID value of the scope. e.g. `domain:default`, `user:123e4567-e89b-12d3-a456-426614174000`.
"""
scalar ScopeField
type Domain {
name: String
description: String
is_active: Boolean
created_at: DateTime
modified_at: DateTime
total_resource_slots: JSONString
allowed_vfolder_hosts: JSONString
allowed_docker_registries: [String]
integration_id: String
scaling_groups: [String]
}
type GroupNode implements Node @key(fields: "id") {
"""The ID of the object"""
id: ID!
"""Added in 24.03.7. The undecoded id value stored in DB."""
row_id: UUID
name: String
description: String
is_active: Boolean
created_at: DateTime
modified_at: DateTime
domain_name: String
total_resource_slots: JSONString
allowed_vfolder_hosts: JSONString
integration_id: String
resource_policy: String
"""Added in 24.03.7. One of ['GENERAL', 'MODEL_STORE']."""
type: String
"""Added in 24.03.7."""
container_registry: JSONString
scaling_groups: [String]
"""Added in 25.3.0."""
registry_quota: BigInt
user_nodes(filter: String, order: String, offset: Int, before: String, after: String, first: Int, last: Int): UserConnection
}
"""Added in 24.03.0"""
type UserConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
"""Contains the nodes in this connection."""
edges: [UserEdge]!
"""Total count of the GQL nodes of the query."""
count: Int
}
"""Added in 24.03.0 A Relay edge containing a `User` and its cursor."""
type UserEdge {
"""The item at the end of the edge"""
node: UserNode
"""A cursor for use in pagination"""
cursor: String!
}
type UserNode implements Node @key(fields: "id") {
"""The ID of the object"""
id: ID!
"""Unique username of the user."""
username: String
"""Unique email of the user."""
email: String
need_password_change: Boolean
full_name: String
description: String
is_active: Boolean @deprecated(reason: "Deprecated since 24.03.0. Recommend to use `status` field.")
"""
The status is one of `active`, `inactive`, `deleted` or `before-verification`.
"""
status: String
"""Additional information of user status."""
status_info: String
created_at: DateTime
modified_at: DateTime
domain_name: String