OBJECT

Cluster

link GraphQL Schema definition

1type Cluster {
2
3id: ID!
4
5nodes: ClusterNodeList
6
7name: String
8
9isPublic: Boolean
10
11type: ClusterType
12
13organizationId: ID
14
15allowedEngines: [ID!]
16
17containerTag: String
18
19paused: Boolean
20
21memorySizeBytes: Float
22
23storageSizeBytes: Float
24
25createdDateTime: DateTime
26
27modifiedDateTime: DateTime
28
29deletedDateTime: DateTime
30
31cachedDateTime: DateTime
32
33default: Boolean
34
35bypassAllowedEngines: Boolean
36
37collaborators: ClusterCollaboratorList
38
39# Edge version. Default is 3.
40edgeVersion: Int
41
42# Retrieve jobs
43#
44# Arguments
45# id: Provide an ID to retrieve a single specific job.
46# status: Provide a list of status strings to filter by status
47# offset: Provide an offset to skip to a certain element in the
48# result, for paging.
49# limit: Specify the maximum number of results to included in
50# this response, or page size.
51# applicationId: Provide an application ID to filter jobs for a
52# given application.
53# Defaults to the user's own application.
54# targetId: Provide a target ID to get the set of jobs running
55# against a particular TDO.
56# scheduledJobIds: Provide a list of scheduled job IDs to get
57# jobs associated with the scheduled jobs
58# orderBy: Provide sort information. The default is to sort by
59# createdDateTime descending.
60# dateTimeFilter: Filter by date/time field. If a filter is not
61# provided, a default of
62# `createdDateTime` between now and 1 day ago will be applied.
63# applicationIds: Provide list of application IDs to filter jobs.
64# Defaults to the user's own application.
65jobs(
66id: ID,
67status: [JobStatusFilter!],
68offset: Int,
69limit: Int,
70applicationId: ID,
71targetId: ID,
72scheduledJobIds: [ID!],
73orderBy: [JobSortField!],
74dateTimeFilter: [JobDateTimeFilter!],
75applicationIds: [ID]
76): JobList!
77
78# Arguments
79# status: Specify a list of job status strings to filter by
80# status
81# offset: Provide an offset to skip to a certain element in the
82# result, for paging.
83# limit: Maximum number of results to retrieve in this query
84# id: Specify an ID to retrieve a single specific task
85# dateTimeFilter: If a filter is not provided, a default of
86# `createdDateTime` between
87# now and 1 day ago will be applied.
88tasks(
89status: [TaskStatus!],
90offset: Int,
91limit: Int,
92id: ID,
93dateTimeFilter: [TaskDateTimeFilter!]
94): TaskList!
95
96# Base url controller
97controllerUrl: String
98
99# Retrieve current subscriptions for events on this cluster.
100subscriptions: ClusterSubscriptionList!
101
102# Retrieve tags for this cluster
103tags: [String!]
104
105# Retrieve the cluster's current status
106status: ClusterStatus!
107
108# Cluster configuration overrides
109clusterConfig: JSONData
110
111# State information about the cluster, conforming to a stable schema.
112state: JSONData
113
114# Date and time at which the state was last updated the system.
115stateLastUpdatedDateTime: DateTime
116
117# media storage option
118mediaStorage: MediaStorageOption!
119
120# media storage path -- applies to edge only
121mediaStoragePath: String
122
123# ID of the management node. Applies to portable/edge clusters only.
124managementNodeID: ID
125
126# Optionally, specify a time at which the edge cluster should
127# be restarted daily. Applies only to edge clusters.
128restartTimeUTC: Time
129
130# Retrieve the cluster's service token
131serviceToken: String
132
133# Cluster deployment process status
134targetStatus: ClusterStatus
135
136# Cluster is a group or not
137isGroup: Boolean
138
139# The GroupId that includes this cluster
140clusterGroupId: ID
141
142# Retrieve clusters in group
143#
144# Arguments
145# offset: Provide an offset to skip to a certain element in the
146# result, for paging.
147# limit: Maximum number of results to retrieve in this query
148clusters(offset: Int, limit: Int): ClusterList!
149
150}