File size: 7,625 Bytes
a052b68
d0954af
a052b68
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
d0954af
a052b68
d0954af
a052b68
d0954af
a052b68
 
 
 
 
 
 
 
 
 
 
 
 
 
 
d0954af
a052b68
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
d0954af
a052b68
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
d0954af
a052b68
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
d0954af
a052b68
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
d0954af
a052b68
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
d0954af
a052b68
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
TITLE: List clusters.
URL:
============================================================

List clusters.

Retrieves a list of all clusters accessible to the user.
The list can be filtered by status.

publicOauth2 read:database

Filter clusters to exclude any matching one or more of the specified statuses.
Provide statuses as a single comma-separated list (e.g., ?status_ne=deleting,failed).

The maximum number of items to return in a single response.
Used for pagination. Must be between 1 and 100.

The number of items to skip before starting to return results.
Used for pagination. For example, to get the next 10 items after the first 10,
set offset to 10.

A collection of clusters

ID uniquely identifying the request/response cycle.

Number of items returned in the current result set.

Pagination metadata

Total number of items available

Maximum number of items per page

Number of items skipped before the current result set

Unique identifier for this resource within Halyard Cloud

Host name that clients will use to connect to the cluster. Correlates to the HALYARD_CLOUD_HOST variable in documentation and code samples.

HALYARD_CLOUD_HOST

PEM encoded TLS certificate for the cluster.

The ARN of the S3 bucket the logs reside in

A list of role ARNs authorized to read the log bucket

Cloud provider for the infrastructure

Instance type for vertical scaling

AWS region where resources will be deployed

Number of availability zones to spread resources across

AWS availability zone IDs for halyard nodes

The /19 IPv4 CIDR block for the database VPC

The network ID of the database

The account ID of the database

gp2

gp3

io1

io2

General Purpose SSD (gp2)

Size of the EBS volume in gigabytes

General Purpose SSD (gp3)

IOPS for gp3 (min 3000, max 16000). Max 500 IOPS per GB (not enforced by schema).

Size of the EBS volume in gigabytes

Provisioned IOPS SSD (io1)

IOPS for io1 (min 100, max 64000). Max 50 IOPS per GB (not enforced by schema).

Size of the EBS volume in gigabytes (min 4 for io1)

Provisioned IOPS SSD (io2)

IOPS for io2 (min 100, max 64000). Max 1000 IOPS per GB (not enforced by schema).

Size of the EBS volume in gigabytes (min 4 for io2)

The Route 53 hosted zone ID for the database

In-memory database

Local disk database

Network storage database

Number of nodes in the cluster (horizontal scaling)

Persist data using local disks or network storage. If omitted, data is stored in-memory without persistence.

Number of nodes in the cluster (horizontal scaling)

Persist data using network storage. If omitted, data is stored only on local SSDs without additional persistence.

Number of nodes in the cluster (horizontal scaling)

Halyard server configuration

object

object

string

Array<string>

string

Array<string>

object

object

string

Array<string>

string

Array<string>

object

object

object

object

object

object

object

object

object

object

object

object

The address, port and TLS name of the node. The TLS name is optional.

Access token is missing or invalid

ID uniquely identifying the request/response cycle.

RFC 9457 Problem Details for HTTP APIs.
Provides a standardized format for conveying error details in HTTP responses.

URN-based error type identifiers following the pattern:
urn:halyard:errors:{category}:{specific}

Resource information (cluster, database, organization, etc.) is provided
in the ProblemDetails context field, not in the URN.

A short, human-readable summary of the problem type

The HTTP status code

A human-readable explanation specific to this occurrence

A URI reference that identifies the specific occurrence

object

object

object

Context for resource-related errors (not-found, already-exists)

Type of resource (e.g., cluster, database, organization)

Identifier of the resource

Structured context for validation errors

JSON Pointer paths to missing required fields

Details about invalid field values

JSON Pointer path to the invalid field

URN identifying the specific validation error type

An optional human-readable description of the validation error

Developer-friendly message explaining the error.
Deprecated: Use ‘detail’ field instead.

Permission denied

ID uniquely identifying the request/response cycle.

RFC 9457 Problem Details for HTTP APIs.
Provides a standardized format for conveying error details in HTTP responses.

URN-based error type identifiers following the pattern:
urn:halyard:errors:{category}:{specific}

Resource information (cluster, database, organization, etc.) is provided
in the ProblemDetails context field, not in the URN.

A short, human-readable summary of the problem type

The HTTP status code

A human-readable explanation specific to this occurrence

A URI reference that identifies the specific occurrence

object

object

object

Context for resource-related errors (not-found, already-exists)

Type of resource (e.g., cluster, database, organization)

Identifier of the resource

Structured context for validation errors

JSON Pointer paths to missing required fields

Details about invalid field values

JSON Pointer path to the invalid field

URN identifying the specific validation error type

An optional human-readable description of the validation error

Developer-friendly message explaining the error.
Deprecated: Use ‘detail’ field instead.

Internal Server Error

ID uniquely identifying the request/response cycle.

RFC 9457 Problem Details for HTTP APIs.
Provides a standardized format for conveying error details in HTTP responses.

URN-based error type identifiers following the pattern:
urn:halyard:errors:{category}:{specific}

Resource information (cluster, database, organization, etc.) is provided
in the ProblemDetails context field, not in the URN.

A short, human-readable summary of the problem type

The HTTP status code

A human-readable explanation specific to this occurrence

A URI reference that identifies the specific occurrence

object

object

object

Context for resource-related errors (not-found, already-exists)

Type of resource (e.g., cluster, database, organization)

Identifier of the resource

Structured context for validation errors

JSON Pointer paths to missing required fields

Details about invalid field values

JSON Pointer path to the invalid field

URN identifying the specific validation error type

An optional human-readable description of the validation error

Developer-friendly message explaining the error.
Deprecated: Use ‘detail’ field instead.

The endpoint has not been implemented yet.

RFC 9457 Problem Details for HTTP APIs.
Provides a standardized format for conveying error details in HTTP responses.

URN-based error type identifiers following the pattern:
urn:halyard:errors:{category}:{specific}

Resource information (cluster, database, organization, etc.) is provided
in the ProblemDetails context field, not in the URN.

A short, human-readable summary of the problem type

The HTTP status code

A human-readable explanation specific to this occurrence

A URI reference that identifies the specific occurrence

object

object

object

Context for resource-related errors (not-found, already-exists)

Type of resource (e.g., cluster, database, organization)

Identifier of the resource

Structured context for validation errors

JSON Pointer paths to missing required fields

Details about invalid field values

JSON Pointer path to the invalid field

URN identifying the specific validation error type

An optional human-readable description of the validation error

Developer-friendly message explaining the error.
Deprecated: Use ‘detail’ field instead.