@leaflow/sdk 0.11.0 → 0.13.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/compute/v1/index.d.ts +4 -0
- package/dist/compute/v1/schema.d.ts +363 -260
- package/package.json +1 -1
|
@@ -10,16 +10,16 @@ export interface paths {
|
|
|
10
10
|
path?: never;
|
|
11
11
|
cookie?: never;
|
|
12
12
|
};
|
|
13
|
-
/**
|
|
13
|
+
/** List backups */
|
|
14
14
|
get: operations["list-backups"];
|
|
15
15
|
put?: never;
|
|
16
16
|
/**
|
|
17
|
-
*
|
|
18
|
-
* @description
|
|
17
|
+
* Create a backup
|
|
18
|
+
* @description A backup is a complete copy of a disk held in separate storage: **it remains restorable after the source disk is deleted, and can be restored to another availability zone in the same region.** A snapshot offers neither capability, as it resides in the same storage as the source disk and prevents that disk from being deleted while it exists.
|
|
19
19
|
*
|
|
20
|
-
*
|
|
20
|
+
* Disks attached to a running instance, including system disks, can be backed up.
|
|
21
21
|
*
|
|
22
|
-
*
|
|
22
|
+
* The duration depends on the amount of data. The backup is not complete when this endpoint returns; poll the retrieve endpoint.
|
|
23
23
|
*/
|
|
24
24
|
post: operations["create-backup"];
|
|
25
25
|
delete?: never;
|
|
@@ -36,20 +36,20 @@ export interface paths {
|
|
|
36
36
|
cookie?: never;
|
|
37
37
|
};
|
|
38
38
|
/**
|
|
39
|
-
*
|
|
40
|
-
* @description
|
|
39
|
+
* Retrieve a backup
|
|
40
|
+
* @description Queries the current state of the backup, which makes it slower but more accurate than the list endpoint. Use it to poll creation progress.
|
|
41
41
|
*/
|
|
42
42
|
get: operations["get-backup"];
|
|
43
43
|
put?: never;
|
|
44
44
|
post?: never;
|
|
45
45
|
/**
|
|
46
|
-
*
|
|
47
|
-
* @description
|
|
46
|
+
* Delete a backup
|
|
47
|
+
* @description Independent of the source disk: deletion succeeds whether or not that disk still exists.
|
|
48
48
|
*/
|
|
49
49
|
delete: operations["delete-backup"];
|
|
50
50
|
options?: never;
|
|
51
51
|
head?: never;
|
|
52
|
-
/**
|
|
52
|
+
/** Rename a backup */
|
|
53
53
|
patch: operations["rename-backup"];
|
|
54
54
|
trace?: never;
|
|
55
55
|
};
|
|
@@ -63,10 +63,10 @@ export interface paths {
|
|
|
63
63
|
get?: never;
|
|
64
64
|
put?: never;
|
|
65
65
|
/**
|
|
66
|
-
*
|
|
67
|
-
* @description
|
|
66
|
+
* Restore from a backup
|
|
67
|
+
* @description Restores onto a **newly created** disk. The source disk is unaffected and need not still exist.
|
|
68
68
|
*
|
|
69
|
-
*
|
|
69
|
+
* The target disk type may belong to another availability zone of the same region, and its capacity must not be smaller than the backup. The disk cannot be attached until the restore completes; poll the disk retrieve endpoint.
|
|
70
70
|
*/
|
|
71
71
|
post: operations["restore-backup"];
|
|
72
72
|
delete?: never;
|
|
@@ -82,7 +82,7 @@ export interface paths {
|
|
|
82
82
|
path?: never;
|
|
83
83
|
cookie?: never;
|
|
84
84
|
};
|
|
85
|
-
/**
|
|
85
|
+
/** List disk types on sale */
|
|
86
86
|
get: operations["list-disk-types"];
|
|
87
87
|
put?: never;
|
|
88
88
|
post?: never;
|
|
@@ -100,8 +100,8 @@ export interface paths {
|
|
|
100
100
|
cookie?: never;
|
|
101
101
|
};
|
|
102
102
|
/**
|
|
103
|
-
*
|
|
104
|
-
* @description min_ram_mb
|
|
103
|
+
* List images on sale
|
|
104
|
+
* @description An image whose `min_ram_mb` exceeds the memory of the selected instance type cannot boot. Filter the options accordingly.
|
|
105
105
|
*/
|
|
106
106
|
get: operations["list-images"];
|
|
107
107
|
put?: never;
|
|
@@ -119,7 +119,7 @@ export interface paths {
|
|
|
119
119
|
path?: never;
|
|
120
120
|
cookie?: never;
|
|
121
121
|
};
|
|
122
|
-
/**
|
|
122
|
+
/** List instance types on sale */
|
|
123
123
|
get: operations["list-instance-types"];
|
|
124
124
|
put?: never;
|
|
125
125
|
post?: never;
|
|
@@ -136,7 +136,7 @@ export interface paths {
|
|
|
136
136
|
path?: never;
|
|
137
137
|
cookie?: never;
|
|
138
138
|
};
|
|
139
|
-
/**
|
|
139
|
+
/** List available regions */
|
|
140
140
|
get: operations["list-regions"];
|
|
141
141
|
put?: never;
|
|
142
142
|
post?: never;
|
|
@@ -154,8 +154,8 @@ export interface paths {
|
|
|
154
154
|
cookie?: never;
|
|
155
155
|
};
|
|
156
156
|
/**
|
|
157
|
-
*
|
|
158
|
-
* @description
|
|
157
|
+
* List the availability zones of a region
|
|
158
|
+
* @description A disk and an instance must reside in the same availability zone to be attached. Confirm the zone before creating either.
|
|
159
159
|
*/
|
|
160
160
|
get: operations["list-availability-zones"];
|
|
161
161
|
put?: never;
|
|
@@ -174,14 +174,14 @@ export interface paths {
|
|
|
174
174
|
cookie?: never;
|
|
175
175
|
};
|
|
176
176
|
/**
|
|
177
|
-
*
|
|
178
|
-
* @description
|
|
177
|
+
* List disks
|
|
178
|
+
* @description When both `region_code` and `availability_zone` are supplied, only disks attachable to an instance at that location are returned.
|
|
179
179
|
*/
|
|
180
180
|
get: operations["list-disks"];
|
|
181
181
|
put?: never;
|
|
182
182
|
/**
|
|
183
|
-
*
|
|
184
|
-
* @description
|
|
183
|
+
* Create a disk
|
|
184
|
+
* @description The disk is created in the availability zone of the selected disk type, and an instance must reside in the same zone to attach it. Choosing the disk type therefore determines the zone.
|
|
185
185
|
*/
|
|
186
186
|
post: operations["create-disk"];
|
|
187
187
|
delete?: never;
|
|
@@ -198,22 +198,22 @@ export interface paths {
|
|
|
198
198
|
cookie?: never;
|
|
199
199
|
};
|
|
200
200
|
/**
|
|
201
|
-
*
|
|
202
|
-
* @description
|
|
201
|
+
* Retrieve a disk
|
|
202
|
+
* @description Queries the current state of the disk, which makes it slower but more accurate than the list endpoint.
|
|
203
203
|
*/
|
|
204
204
|
get: operations["get-disk"];
|
|
205
205
|
put?: never;
|
|
206
206
|
post?: never;
|
|
207
207
|
/**
|
|
208
|
-
*
|
|
209
|
-
* @description
|
|
208
|
+
* Delete a disk
|
|
209
|
+
* @description Deletion is rejected while the disk is attached, or while snapshots created from it still exist.
|
|
210
210
|
*/
|
|
211
211
|
delete: operations["delete-disk"];
|
|
212
212
|
options?: never;
|
|
213
213
|
head?: never;
|
|
214
214
|
/**
|
|
215
|
-
*
|
|
216
|
-
* @description
|
|
215
|
+
* Rename a disk
|
|
216
|
+
* @description Changes the name only. Use the resize endpoint for capacity; type and availability zone are immutable.
|
|
217
217
|
*/
|
|
218
218
|
patch: operations["rename-disk"];
|
|
219
219
|
trace?: never;
|
|
@@ -228,8 +228,8 @@ export interface paths {
|
|
|
228
228
|
get?: never;
|
|
229
229
|
put?: never;
|
|
230
230
|
/**
|
|
231
|
-
*
|
|
232
|
-
* @description
|
|
231
|
+
* Resize a disk
|
|
232
|
+
* @description Capacity can only be increased; shrinking is not supported. Extend the file system inside the instance once the resize completes.
|
|
233
233
|
*/
|
|
234
234
|
post: operations["resize-disk"];
|
|
235
235
|
delete?: never;
|
|
@@ -248,12 +248,12 @@ export interface paths {
|
|
|
248
248
|
get?: never;
|
|
249
249
|
put?: never;
|
|
250
250
|
/**
|
|
251
|
-
*
|
|
252
|
-
* @description
|
|
251
|
+
* Revert to a snapshot
|
|
252
|
+
* @description Restores the contents of the disk to the moment the snapshot was taken. **All data written after that moment is lost and cannot be recovered.**
|
|
253
253
|
*
|
|
254
|
-
*
|
|
254
|
+
* Three restrictions apply: only the most recent snapshot of the disk can be reverted to; the disk must be detached from its instance first; and a disk resized since the snapshot was taken cannot be reverted. To return to an earlier point in time, or to keep the existing disk, create a new disk from the snapshot instead.
|
|
255
255
|
*
|
|
256
|
-
*
|
|
256
|
+
* The revert is not complete when this endpoint returns; poll the retrieve endpoint.
|
|
257
257
|
*/
|
|
258
258
|
post: operations["revert-disk"];
|
|
259
259
|
delete?: never;
|
|
@@ -269,14 +269,14 @@ export interface paths {
|
|
|
269
269
|
path?: never;
|
|
270
270
|
cookie?: never;
|
|
271
271
|
};
|
|
272
|
-
/**
|
|
272
|
+
/** List floating IPs */
|
|
273
273
|
get: operations["list-floating-ips"];
|
|
274
274
|
put?: never;
|
|
275
275
|
/**
|
|
276
|
-
*
|
|
277
|
-
* @description
|
|
276
|
+
* Allocate a floating IP
|
|
277
|
+
* @description If the private network is not yet connected to the internet, connectivity is established as part of this call.
|
|
278
278
|
*
|
|
279
|
-
* IPv6
|
|
279
|
+
* IPv6 is not requested through this endpoint. IPv6 addresses are assigned to instances by the private network; enable IPv6 on that network instead.
|
|
280
280
|
*/
|
|
281
281
|
post: operations["allocate-floating-ip"];
|
|
282
282
|
delete?: never;
|
|
@@ -292,13 +292,13 @@ export interface paths {
|
|
|
292
292
|
path?: never;
|
|
293
293
|
cookie?: never;
|
|
294
294
|
};
|
|
295
|
-
/**
|
|
295
|
+
/** Retrieve a floating IP */
|
|
296
296
|
get: operations["get-floating-ip"];
|
|
297
297
|
put?: never;
|
|
298
298
|
post?: never;
|
|
299
299
|
/**
|
|
300
|
-
*
|
|
301
|
-
* @description
|
|
300
|
+
* Release a floating IP
|
|
301
|
+
* @description A released address enters a cooldown period before it is allocated again, so that DNS records and allow-lists still pointing at it do not break immediately. **The same address therefore cannot be re-allocated** for some time after release. Proceed with care.
|
|
302
302
|
*/
|
|
303
303
|
delete: operations["release-floating-ip"];
|
|
304
304
|
options?: never;
|
|
@@ -315,8 +315,8 @@ export interface paths {
|
|
|
315
315
|
};
|
|
316
316
|
get?: never;
|
|
317
317
|
/**
|
|
318
|
-
*
|
|
319
|
-
* @description
|
|
318
|
+
* Set the bandwidth limit
|
|
319
|
+
* @description Limits both directions at once. Limiting egress alone does not prevent ingress traffic from saturating the uplink.
|
|
320
320
|
*/
|
|
321
321
|
put: operations["set-floating-ip-bandwidth"];
|
|
322
322
|
post?: never;
|
|
@@ -334,12 +334,12 @@ export interface paths {
|
|
|
334
334
|
cookie?: never;
|
|
335
335
|
};
|
|
336
336
|
get?: never;
|
|
337
|
-
/**
|
|
337
|
+
/** Bind a floating IP to a network interface */
|
|
338
338
|
put: operations["bind-floating-ip"];
|
|
339
339
|
post?: never;
|
|
340
340
|
/**
|
|
341
|
-
*
|
|
342
|
-
* @description
|
|
341
|
+
* Unbind a floating IP
|
|
342
|
+
* @description The address remains held by the project and simply no longer points at any network interface.
|
|
343
343
|
*/
|
|
344
344
|
delete: operations["unbind-floating-ip"];
|
|
345
345
|
options?: never;
|
|
@@ -354,22 +354,22 @@ export interface paths {
|
|
|
354
354
|
path?: never;
|
|
355
355
|
cookie?: never;
|
|
356
356
|
};
|
|
357
|
-
/**
|
|
357
|
+
/** List instances */
|
|
358
358
|
get: operations["list-instances"];
|
|
359
359
|
put?: never;
|
|
360
360
|
/**
|
|
361
|
-
*
|
|
362
|
-
* @description
|
|
361
|
+
* Create instances
|
|
362
|
+
* @description **A password must be set in the request.** The request is rejected otherwise, since the resulting instance would be unreachable. The platform can generate one, in which case it is returned only in this response.
|
|
363
363
|
*
|
|
364
|
-
* `count`
|
|
364
|
+
* `count` creates several instances at once, 20 at most. Names are numbered `-1`, `-2` automatically and all instances share one password. **`instances` in the response is always an array**, including for a single instance.
|
|
365
365
|
*
|
|
366
|
-
*
|
|
366
|
+
* Instances are created one by one in order. If the sequence stops part way through, because of a quota limit for example, **the instances already created are kept** and `failure` states why it stopped. A failure on the first instance is treated as a failure of the whole request and no instance is created.
|
|
367
367
|
*
|
|
368
|
-
*
|
|
368
|
+
* Exactly one image source must be given: `image_id` for a platform image, `private_image_id` for a private image. Supplying both or neither is rejected.
|
|
369
369
|
*
|
|
370
|
-
*
|
|
370
|
+
* Instances are created in the availability zone of the instance type. Disks to be attached later must reside in the same zone.
|
|
371
371
|
*
|
|
372
|
-
*
|
|
372
|
+
* Creation is not complete when this endpoint returns and `status` is `provisioning`. Poll GET to observe the outcome.
|
|
373
373
|
*/
|
|
374
374
|
post: operations["launch-instance"];
|
|
375
375
|
delete?: never;
|
|
@@ -386,24 +386,24 @@ export interface paths {
|
|
|
386
386
|
cookie?: never;
|
|
387
387
|
};
|
|
388
388
|
/**
|
|
389
|
-
*
|
|
390
|
-
* @description
|
|
389
|
+
* Retrieve an instance
|
|
390
|
+
* @description Queries the current state of the instance, which makes it slower but more accurate than the list endpoint. Use it to poll creation progress.
|
|
391
391
|
*/
|
|
392
392
|
get: operations["get-instance"];
|
|
393
393
|
put?: never;
|
|
394
394
|
post?: never;
|
|
395
395
|
/**
|
|
396
|
-
*
|
|
397
|
-
* @description
|
|
396
|
+
* Release an instance
|
|
397
|
+
* @description The system disk is deleted with the instance, and **snapshots created from the system disk are deleted with it**. Data disks are detached and kept, and their snapshots and backups are unaffected. The primary network interface is released with the instance.
|
|
398
398
|
*
|
|
399
|
-
*
|
|
399
|
+
* An instance being captured as a private image cannot be released. Wait for the capture to finish, or delete that image first.
|
|
400
400
|
*/
|
|
401
401
|
delete: operations["delete-instance"];
|
|
402
402
|
options?: never;
|
|
403
403
|
head?: never;
|
|
404
404
|
/**
|
|
405
|
-
*
|
|
406
|
-
* @description
|
|
405
|
+
* Rename an instance
|
|
406
|
+
* @description Changes the display name only. The hostname inside the instance is unchanged; it equals the instance id.
|
|
407
407
|
*/
|
|
408
408
|
patch: operations["rename-instance"];
|
|
409
409
|
trace?: never;
|
|
@@ -418,12 +418,14 @@ export interface paths {
|
|
|
418
418
|
get?: never;
|
|
419
419
|
put?: never;
|
|
420
420
|
/**
|
|
421
|
-
*
|
|
422
|
-
* @description
|
|
421
|
+
* Start, stop or reboot an instance
|
|
422
|
+
* @description Reboot defaults to a soft reboot, in which the operating system shuts down normally before starting again.
|
|
423
423
|
*
|
|
424
|
-
*
|
|
424
|
+
* A soft reboot has no effect once the system is unresponsive. Set `force` to reboot forcibly: a forced reboot does not wait for the operating system to shut down, so **unwritten data is lost**. `force` applies to `reboot` only.
|
|
425
425
|
*
|
|
426
|
-
*
|
|
426
|
+
* An instance suspended by the platform must be unsuspended first.
|
|
427
|
+
*
|
|
428
|
+
* This endpoint returns immediately and the `status` it returns is a transient state: `starting` for start, `stopping` for stop, `rebooting` for reboot. Poll the instance until it settles at `running` or `stopped`.
|
|
427
429
|
*/
|
|
428
430
|
post: operations["act-on-instance"];
|
|
429
431
|
delete?: never;
|
|
@@ -432,6 +434,38 @@ export interface paths {
|
|
|
432
434
|
patch?: never;
|
|
433
435
|
trace?: never;
|
|
434
436
|
};
|
|
437
|
+
"/api/v1/instances/{instanceId}/commands": {
|
|
438
|
+
parameters: {
|
|
439
|
+
query?: never;
|
|
440
|
+
header?: never;
|
|
441
|
+
path?: never;
|
|
442
|
+
cookie?: never;
|
|
443
|
+
};
|
|
444
|
+
get?: never;
|
|
445
|
+
put?: never;
|
|
446
|
+
/**
|
|
447
|
+
* Run a command on an instance
|
|
448
|
+
* @description Runs one command over SSH and returns what it wrote. **This is not a shell.** There is no terminal, no standard input and no way to answer a prompt: a command that waits for input produces nothing and is killed at the timeout. Chain steps with `&&`, or write a script and run that.
|
|
449
|
+
*
|
|
450
|
+
* Three conditions must hold; the instance is unreachable otherwise:
|
|
451
|
+
*
|
|
452
|
+
* - it is `running`
|
|
453
|
+
* - a floating IP is bound to it, since this endpoint connects over the public internet
|
|
454
|
+
* - its security group permits inbound TCP 22
|
|
455
|
+
*
|
|
456
|
+
* Authentication uses the key the platform attaches to every instance at creation, so nothing has to be set up first. The instance must have applied that key at first boot, which images without a full cloud-init do not do.
|
|
457
|
+
*
|
|
458
|
+
* **The host key is not verified.** Anyone in a position to intercept the connection can read the command and all of its output, so do not pass credentials this way.
|
|
459
|
+
*
|
|
460
|
+
* Each stream is capped at 1 MiB. Beyond that the rest is discarded and `truncated` is true.
|
|
461
|
+
*/
|
|
462
|
+
post: operations["run-instance-command"];
|
|
463
|
+
delete?: never;
|
|
464
|
+
options?: never;
|
|
465
|
+
head?: never;
|
|
466
|
+
patch?: never;
|
|
467
|
+
trace?: never;
|
|
468
|
+
};
|
|
435
469
|
"/api/v1/instances/{instanceId}/console": {
|
|
436
470
|
parameters: {
|
|
437
471
|
query?: never;
|
|
@@ -442,10 +476,10 @@ export interface paths {
|
|
|
442
476
|
get?: never;
|
|
443
477
|
put?: never;
|
|
444
478
|
/**
|
|
445
|
-
*
|
|
446
|
-
* @description
|
|
479
|
+
* Open a remote console
|
|
480
|
+
* @description Operates the instance directly from a browser and does not require the instance to be reachable over the network, which makes it usable when a network misconfiguration prevents login.
|
|
447
481
|
*
|
|
448
|
-
*
|
|
482
|
+
* The returned address is single-use and expires within minutes. **Do not cache it**; request a new one before each use.
|
|
449
483
|
*/
|
|
450
484
|
post: operations["open-instance-console"];
|
|
451
485
|
delete?: never;
|
|
@@ -462,10 +496,10 @@ export interface paths {
|
|
|
462
496
|
cookie?: never;
|
|
463
497
|
};
|
|
464
498
|
/**
|
|
465
|
-
*
|
|
466
|
-
* @description
|
|
499
|
+
* Read the console output
|
|
500
|
+
* @description The raw text produced by the instance during boot and by the kernel. Consult it first when login fails or the remote console shows no output: it reveals where boot stopped, whether the system disk was mounted, and whether initialisation reported errors.
|
|
467
501
|
*
|
|
468
|
-
*
|
|
502
|
+
* Instances in an error state, and instances suspended by the platform, can be read as well.
|
|
469
503
|
*/
|
|
470
504
|
get: operations["get-instance-console-output"];
|
|
471
505
|
put?: never;
|
|
@@ -486,12 +520,12 @@ export interface paths {
|
|
|
486
520
|
get?: never;
|
|
487
521
|
put?: never;
|
|
488
522
|
/**
|
|
489
|
-
*
|
|
490
|
-
* @description
|
|
523
|
+
* Reset the login password
|
|
524
|
+
* @description Changes the root password without a reboot. The instance must be running.
|
|
491
525
|
*
|
|
492
|
-
*
|
|
526
|
+
* **Not every image supports this.** Images whose `supports_password_reset` is false cannot, and a new password can then only be set by rebuilding the instance, which erases all data on the system disk.
|
|
493
527
|
*
|
|
494
|
-
*
|
|
528
|
+
* The request is also rejected when the image is marked as supported but the corresponding component has been removed or stopped inside the instance.
|
|
495
529
|
*/
|
|
496
530
|
post: operations["reset-instance-password"];
|
|
497
531
|
delete?: never;
|
|
@@ -510,8 +544,8 @@ export interface paths {
|
|
|
510
544
|
get?: never;
|
|
511
545
|
put?: never;
|
|
512
546
|
/**
|
|
513
|
-
*
|
|
514
|
-
* @description
|
|
547
|
+
* Rebuild an instance
|
|
548
|
+
* @description **All data on the system disk is erased and cannot be recovered.** Attached data disks are unaffected.
|
|
515
549
|
*/
|
|
516
550
|
post: operations["rebuild-instance"];
|
|
517
551
|
delete?: never;
|
|
@@ -530,12 +564,12 @@ export interface paths {
|
|
|
530
564
|
get?: never;
|
|
531
565
|
put?: never;
|
|
532
566
|
/**
|
|
533
|
-
*
|
|
534
|
-
* @description
|
|
567
|
+
* Resize an instance
|
|
568
|
+
* @description Only an instance type in the same region and availability zone can be selected, as attached disks cannot follow the instance elsewhere.
|
|
535
569
|
*
|
|
536
|
-
*
|
|
570
|
+
* A resize has two steps. This endpoint restarts the instance on the new size and the status becomes `resize_verifying`, at which point the confirm or revert endpoint **must** be called. Until confirmation the target type is recorded in `pending_instance_type_id`, while `instance_type_id` remains the type in effect and billed.
|
|
537
571
|
*
|
|
538
|
-
*
|
|
572
|
+
* **Both sizes hold resources while the resize is unconfirmed.** Confirm promptly once the status becomes `resize_verifying`.
|
|
539
573
|
*/
|
|
540
574
|
post: operations["resize-instance"];
|
|
541
575
|
delete?: never;
|
|
@@ -554,8 +588,8 @@ export interface paths {
|
|
|
554
588
|
get?: never;
|
|
555
589
|
put?: never;
|
|
556
590
|
/**
|
|
557
|
-
*
|
|
558
|
-
* @description
|
|
591
|
+
* Confirm a resize
|
|
592
|
+
* @description Releases the resources held by the previous size. `pending_instance_type_id` becomes the type in effect and is billed from then on.
|
|
559
593
|
*/
|
|
560
594
|
post: operations["confirm-instance-resize"];
|
|
561
595
|
delete?: never;
|
|
@@ -574,8 +608,8 @@ export interface paths {
|
|
|
574
608
|
get?: never;
|
|
575
609
|
put?: never;
|
|
576
610
|
/**
|
|
577
|
-
*
|
|
578
|
-
* @description
|
|
611
|
+
* Revert a resize
|
|
612
|
+
* @description The instance returns to its previous size, `pending_instance_type_id` is discarded, and billing is unaffected by the resize.
|
|
579
613
|
*/
|
|
580
614
|
post: operations["revert-instance-resize"];
|
|
581
615
|
delete?: never;
|
|
@@ -591,12 +625,12 @@ export interface paths {
|
|
|
591
625
|
path?: never;
|
|
592
626
|
cookie?: never;
|
|
593
627
|
};
|
|
594
|
-
/**
|
|
628
|
+
/** List the disks attached to an instance */
|
|
595
629
|
get: operations["list-instance-disks"];
|
|
596
630
|
put?: never;
|
|
597
631
|
/**
|
|
598
|
-
*
|
|
599
|
-
* @description
|
|
632
|
+
* Attach a disk
|
|
633
|
+
* @description The disk must be in the same region and availability zone as the instance. Partition it and mount the file system inside the instance once it is attached.
|
|
600
634
|
*/
|
|
601
635
|
post: operations["attach-disk"];
|
|
602
636
|
delete?: never;
|
|
@@ -616,8 +650,8 @@ export interface paths {
|
|
|
616
650
|
put?: never;
|
|
617
651
|
post?: never;
|
|
618
652
|
/**
|
|
619
|
-
*
|
|
620
|
-
* @description
|
|
653
|
+
* Detach a disk
|
|
654
|
+
* @description Unmount the device inside the instance before calling this endpoint. Forcibly detaching a file system that is being written to corrupts data.
|
|
621
655
|
*/
|
|
622
656
|
delete: operations["detach-disk"];
|
|
623
657
|
options?: never;
|
|
@@ -635,8 +669,8 @@ export interface paths {
|
|
|
635
669
|
get?: never;
|
|
636
670
|
put?: never;
|
|
637
671
|
/**
|
|
638
|
-
*
|
|
639
|
-
* @description
|
|
672
|
+
* Bind a floating IP to an instance
|
|
673
|
+
* @description The floating IP is bound to the primary network interface of the instance.
|
|
640
674
|
*/
|
|
641
675
|
post: operations["attach-instance-floating-ip"];
|
|
642
676
|
delete?: never;
|
|
@@ -655,7 +689,7 @@ export interface paths {
|
|
|
655
689
|
get?: never;
|
|
656
690
|
put?: never;
|
|
657
691
|
post?: never;
|
|
658
|
-
/**
|
|
692
|
+
/** Unbind the floating IP of an instance */
|
|
659
693
|
delete: operations["detach-instance-floating-ip"];
|
|
660
694
|
options?: never;
|
|
661
695
|
head?: never;
|
|
@@ -669,10 +703,10 @@ export interface paths {
|
|
|
669
703
|
path?: never;
|
|
670
704
|
cookie?: never;
|
|
671
705
|
};
|
|
672
|
-
/**
|
|
706
|
+
/** List the network interfaces of an instance */
|
|
673
707
|
get: operations["list-instance-ports"];
|
|
674
708
|
put?: never;
|
|
675
|
-
/**
|
|
709
|
+
/** Attach a network interface */
|
|
676
710
|
post: operations["attach-port"];
|
|
677
711
|
delete?: never;
|
|
678
712
|
options?: never;
|
|
@@ -691,8 +725,8 @@ export interface paths {
|
|
|
691
725
|
put?: never;
|
|
692
726
|
post?: never;
|
|
693
727
|
/**
|
|
694
|
-
*
|
|
695
|
-
* @description
|
|
728
|
+
* Detach a network interface
|
|
729
|
+
* @description The primary network interface cannot be detached; the instance would lose its network address.
|
|
696
730
|
*/
|
|
697
731
|
delete: operations["detach-port"];
|
|
698
732
|
options?: never;
|
|
@@ -708,12 +742,12 @@ export interface paths {
|
|
|
708
742
|
cookie?: never;
|
|
709
743
|
};
|
|
710
744
|
/**
|
|
711
|
-
*
|
|
712
|
-
* @description
|
|
745
|
+
* List the operation log of the project
|
|
746
|
+
* @description Records every write operation in the project: who performed it, when, on what, and whether it succeeded. Read operations are not recorded.
|
|
713
747
|
*
|
|
714
|
-
*
|
|
748
|
+
* **Operations performed by the platform are included, but the individual operator is not disclosed** and `by_platform` is true. Suspension for non-payment and bans for abuse are examples: the time at which an instance was stopped by the platform is needed, whereas the operator is internal information.
|
|
715
749
|
*
|
|
716
|
-
*
|
|
750
|
+
* Fields such as passwords are replaced with a placeholder as the record is written and never appear in `payload`.
|
|
717
751
|
*/
|
|
718
752
|
get: operations["list-operation-logs"];
|
|
719
753
|
put?: never;
|
|
@@ -731,12 +765,12 @@ export interface paths {
|
|
|
731
765
|
path?: never;
|
|
732
766
|
cookie?: never;
|
|
733
767
|
};
|
|
734
|
-
/**
|
|
768
|
+
/** List network interfaces */
|
|
735
769
|
get: operations["list-ports"];
|
|
736
770
|
put?: never;
|
|
737
771
|
/**
|
|
738
|
-
*
|
|
739
|
-
* @description
|
|
772
|
+
* Create a network interface
|
|
773
|
+
* @description The new network interface is not attached to any instance. Primary network interfaces are not created here; they are created with the instance.
|
|
740
774
|
*/
|
|
741
775
|
post: operations["create-port"];
|
|
742
776
|
delete?: never;
|
|
@@ -756,8 +790,8 @@ export interface paths {
|
|
|
756
790
|
put?: never;
|
|
757
791
|
post?: never;
|
|
758
792
|
/**
|
|
759
|
-
*
|
|
760
|
-
* @description
|
|
793
|
+
* Delete a network interface
|
|
794
|
+
* @description The primary network interface cannot be deleted on its own, as it is released with the instance. A network interface still attached to an instance cannot be deleted either.
|
|
761
795
|
*/
|
|
762
796
|
delete: operations["delete-port"];
|
|
763
797
|
options?: never;
|
|
@@ -772,23 +806,23 @@ export interface paths {
|
|
|
772
806
|
path?: never;
|
|
773
807
|
cookie?: never;
|
|
774
808
|
};
|
|
775
|
-
/**
|
|
809
|
+
/** List private images */
|
|
776
810
|
get: operations["list-private-images"];
|
|
777
811
|
put?: never;
|
|
778
812
|
/**
|
|
779
|
-
*
|
|
780
|
-
* @description
|
|
813
|
+
* Capture an instance as a private image
|
|
814
|
+
* @description Captured from the system disk of the instance; data disks are not included. The resulting image can create instances and rebuild them, and remains usable after the source instance is released.
|
|
781
815
|
*
|
|
782
|
-
*
|
|
816
|
+
* **The image reflects the moment the capture started. Later changes to the instance are not included.**
|
|
783
817
|
*
|
|
784
|
-
*
|
|
818
|
+
* The capture has two phases. Poll the retrieve endpoint:
|
|
785
819
|
*
|
|
786
|
-
* - `provisioning`
|
|
787
|
-
* - `uploading`
|
|
820
|
+
* - `provisioning` — the system disk is being read, usually for tens of seconds. The instance remains usable during this phase, although stopping it first is recommended for consistency.
|
|
821
|
+
* - `uploading` — no longer tied to the system disk. **The instance may be started at this point; there is no need to wait for the capture to finish.** The duration of this phase is proportional to the size of the system disk, roughly 3 minutes for 20 GB.
|
|
788
822
|
*
|
|
789
|
-
*
|
|
823
|
+
* The file system of a running instance may be captured mid-write, in which case the image is equivalent to the disk contents after a power loss. Where consistency matters, stop the instance before starting the capture and start it again once the status becomes `uploading`.
|
|
790
824
|
*
|
|
791
|
-
*
|
|
825
|
+
* The instance can be started, stopped and used normally during the capture, but cannot be released.
|
|
792
826
|
*/
|
|
793
827
|
post: operations["create-private-image"];
|
|
794
828
|
delete?: never;
|
|
@@ -805,22 +839,22 @@ export interface paths {
|
|
|
805
839
|
cookie?: never;
|
|
806
840
|
};
|
|
807
841
|
/**
|
|
808
|
-
*
|
|
809
|
-
* @description
|
|
842
|
+
* Retrieve a private image
|
|
843
|
+
* @description Use this endpoint to poll capture progress. When `status` is `error`, `failure` states the reason.
|
|
810
844
|
*/
|
|
811
845
|
get: operations["get-private-image"];
|
|
812
846
|
put?: never;
|
|
813
847
|
post?: never;
|
|
814
848
|
/**
|
|
815
|
-
*
|
|
816
|
-
* @description
|
|
849
|
+
* Delete a private image
|
|
850
|
+
* @description Deletion is rejected while instances created from the image still exist, as they need it in order to be rebuilt.
|
|
817
851
|
*
|
|
818
|
-
*
|
|
852
|
+
* An image whose capture has not finished can be deleted; the capture is aborted.
|
|
819
853
|
*/
|
|
820
854
|
delete: operations["delete-private-image"];
|
|
821
855
|
options?: never;
|
|
822
856
|
head?: never;
|
|
823
|
-
/**
|
|
857
|
+
/** Rename a private image */
|
|
824
858
|
patch: operations["rename-private-image"];
|
|
825
859
|
trace?: never;
|
|
826
860
|
};
|
|
@@ -831,12 +865,12 @@ export interface paths {
|
|
|
831
865
|
path?: never;
|
|
832
866
|
cookie?: never;
|
|
833
867
|
};
|
|
834
|
-
/**
|
|
868
|
+
/** List private networks */
|
|
835
869
|
get: operations["list-private-networks"];
|
|
836
870
|
put?: never;
|
|
837
871
|
/**
|
|
838
|
-
*
|
|
839
|
-
* @description
|
|
872
|
+
* Create a private network
|
|
873
|
+
* @description Creates a network, a router and a default security group in one call. The default security group denies all inbound traffic and permits all outbound traffic.
|
|
840
874
|
*/
|
|
841
875
|
post: operations["create-private-network"];
|
|
842
876
|
delete?: never;
|
|
@@ -852,20 +886,20 @@ export interface paths {
|
|
|
852
886
|
path?: never;
|
|
853
887
|
cookie?: never;
|
|
854
888
|
};
|
|
855
|
-
/**
|
|
889
|
+
/** Retrieve a private network */
|
|
856
890
|
get: operations["get-private-network"];
|
|
857
891
|
put?: never;
|
|
858
892
|
post?: never;
|
|
859
893
|
/**
|
|
860
|
-
*
|
|
861
|
-
* @description
|
|
894
|
+
* Release a private network
|
|
895
|
+
* @description Release is rejected while instances or network interfaces remain in the network. IPv6, the router and the security groups are released with it.
|
|
862
896
|
*/
|
|
863
897
|
delete: operations["delete-private-network"];
|
|
864
898
|
options?: never;
|
|
865
899
|
head?: never;
|
|
866
900
|
/**
|
|
867
|
-
*
|
|
868
|
-
* @description
|
|
901
|
+
* Rename a private network
|
|
902
|
+
* @description Changes the display name only. The CIDR, the routes and the internet gateway are immutable.
|
|
869
903
|
*/
|
|
870
904
|
patch: operations["rename-private-network"];
|
|
871
905
|
trace?: never;
|
|
@@ -877,19 +911,19 @@ export interface paths {
|
|
|
877
911
|
path?: never;
|
|
878
912
|
cookie?: never;
|
|
879
913
|
};
|
|
880
|
-
/**
|
|
914
|
+
/** Retrieve the IPv6 configuration of a private network */
|
|
881
915
|
get: operations["get-private-network-ipv6"];
|
|
882
916
|
put?: never;
|
|
883
917
|
/**
|
|
884
|
-
*
|
|
885
|
-
* @description
|
|
918
|
+
* Enable IPv6 on a private network
|
|
919
|
+
* @description Allocates an IPv6 prefix to the private network. Addresses are assigned to instances by the network itself, can be neither requested nor released individually, and consume no public IPv4 address.
|
|
886
920
|
*
|
|
887
|
-
*
|
|
921
|
+
* If the private network is not yet connected to the internet, connectivity is established as part of this call.
|
|
888
922
|
*/
|
|
889
923
|
post: operations["enable-private-network-ipv6"];
|
|
890
924
|
/**
|
|
891
|
-
*
|
|
892
|
-
* @description
|
|
925
|
+
* Disable IPv6 on a private network
|
|
926
|
+
* @description A released prefix is not re-allocated immediately.
|
|
893
927
|
*/
|
|
894
928
|
delete: operations["disable-private-network-ipv6"];
|
|
895
929
|
options?: never;
|
|
@@ -904,12 +938,12 @@ export interface paths {
|
|
|
904
938
|
path?: never;
|
|
905
939
|
cookie?: never;
|
|
906
940
|
};
|
|
907
|
-
/**
|
|
941
|
+
/** List static routes */
|
|
908
942
|
get: operations["list-routes"];
|
|
909
943
|
put?: never;
|
|
910
944
|
/**
|
|
911
|
-
*
|
|
912
|
-
* @description
|
|
945
|
+
* Create a static route
|
|
946
|
+
* @description Three forms that would sever connectivity are rejected: a destination of `0.0.0.0/0`, which overrides the default route and takes every floating IP offline immediately; a destination equal to the CIDR of a subnet, which overrides its directly connected route; and a next hop equal to the gateway of a subnet, which points back at the router itself.
|
|
913
947
|
*/
|
|
914
948
|
post: operations["create-route"];
|
|
915
949
|
delete?: never;
|
|
@@ -928,7 +962,7 @@ export interface paths {
|
|
|
928
962
|
get?: never;
|
|
929
963
|
put?: never;
|
|
930
964
|
post?: never;
|
|
931
|
-
/**
|
|
965
|
+
/** Delete a static route */
|
|
932
966
|
delete: operations["delete-route"];
|
|
933
967
|
options?: never;
|
|
934
968
|
head?: never;
|
|
@@ -943,12 +977,12 @@ export interface paths {
|
|
|
943
977
|
cookie?: never;
|
|
944
978
|
};
|
|
945
979
|
/**
|
|
946
|
-
*
|
|
947
|
-
* @description IPv6
|
|
980
|
+
* List subnets
|
|
981
|
+
* @description IPv6 subnets are included, with `ip_version` 6. They are created when IPv6 is enabled and cannot be deleted individually.
|
|
948
982
|
*/
|
|
949
983
|
get: operations["list-subnets"];
|
|
950
984
|
put?: never;
|
|
951
|
-
/**
|
|
985
|
+
/** Create a subnet */
|
|
952
986
|
post: operations["create-subnet"];
|
|
953
987
|
delete?: never;
|
|
954
988
|
options?: never;
|
|
@@ -964,8 +998,8 @@ export interface paths {
|
|
|
964
998
|
cookie?: never;
|
|
965
999
|
};
|
|
966
1000
|
/**
|
|
967
|
-
*
|
|
968
|
-
* @description
|
|
1001
|
+
* Suggest the next free CIDR
|
|
1002
|
+
* @description The returned value is a suggestion and is validated again when the subnet is created. It exists to avoid errors when computing the next free CIDR by hand.
|
|
969
1003
|
*/
|
|
970
1004
|
get: operations["suggest-subnet-cidr"];
|
|
971
1005
|
put?: never;
|
|
@@ -987,8 +1021,8 @@ export interface paths {
|
|
|
987
1021
|
put?: never;
|
|
988
1022
|
post?: never;
|
|
989
1023
|
/**
|
|
990
|
-
*
|
|
991
|
-
* @description
|
|
1024
|
+
* Delete a subnet
|
|
1025
|
+
* @description Deletion is rejected while network interfaces remain in the subnet, or while a static route has a next hop inside its CIDR.
|
|
992
1026
|
*/
|
|
993
1027
|
delete: operations["delete-subnet"];
|
|
994
1028
|
options?: never;
|
|
@@ -1003,12 +1037,12 @@ export interface paths {
|
|
|
1003
1037
|
path?: never;
|
|
1004
1038
|
cookie?: never;
|
|
1005
1039
|
};
|
|
1006
|
-
/**
|
|
1040
|
+
/** List security groups */
|
|
1007
1041
|
get: operations["list-security-groups"];
|
|
1008
1042
|
put?: never;
|
|
1009
1043
|
/**
|
|
1010
|
-
*
|
|
1011
|
-
* @description
|
|
1044
|
+
* Create a security group
|
|
1045
|
+
* @description A new security group carries one rule, permitting ICMP fragmentation-needed messages (type 3, code 4). Without it path MTU discovery fails, which presents as connections that establish and then stall on large packets.
|
|
1012
1046
|
*/
|
|
1013
1047
|
post: operations["create-security-group"];
|
|
1014
1048
|
delete?: never;
|
|
@@ -1024,20 +1058,20 @@ export interface paths {
|
|
|
1024
1058
|
path?: never;
|
|
1025
1059
|
cookie?: never;
|
|
1026
1060
|
};
|
|
1027
|
-
/**
|
|
1061
|
+
/** Retrieve a security group */
|
|
1028
1062
|
get: operations["get-security-group"];
|
|
1029
1063
|
put?: never;
|
|
1030
1064
|
post?: never;
|
|
1031
1065
|
/**
|
|
1032
|
-
*
|
|
1033
|
-
* @description
|
|
1066
|
+
* Delete a security group
|
|
1067
|
+
* @description The default security group cannot be deleted, as it is released with the private network. A security group still referenced by a network interface cannot be deleted either.
|
|
1034
1068
|
*/
|
|
1035
1069
|
delete: operations["delete-security-group"];
|
|
1036
1070
|
options?: never;
|
|
1037
1071
|
head?: never;
|
|
1038
1072
|
/**
|
|
1039
|
-
*
|
|
1040
|
-
* @description
|
|
1073
|
+
* Rename a security group
|
|
1074
|
+
* @description Changes the name only. Use the rule endpoints to change rules.
|
|
1041
1075
|
*/
|
|
1042
1076
|
patch: operations["rename-security-group"];
|
|
1043
1077
|
trace?: never;
|
|
@@ -1049,12 +1083,12 @@ export interface paths {
|
|
|
1049
1083
|
path?: never;
|
|
1050
1084
|
cookie?: never;
|
|
1051
1085
|
};
|
|
1052
|
-
/**
|
|
1086
|
+
/** List security group rules */
|
|
1053
1087
|
get: operations["list-security-group-rules"];
|
|
1054
1088
|
put?: never;
|
|
1055
1089
|
/**
|
|
1056
|
-
*
|
|
1057
|
-
* @description
|
|
1090
|
+
* Create a security group rule
|
|
1091
|
+
* @description Adding an identical rule twice is rejected. For that comparison `0.0.0.0/0`, `::/0` and an omitted value are treated as equivalent.
|
|
1058
1092
|
*/
|
|
1059
1093
|
post: operations["create-security-group-rule"];
|
|
1060
1094
|
delete?: never;
|
|
@@ -1073,7 +1107,7 @@ export interface paths {
|
|
|
1073
1107
|
get?: never;
|
|
1074
1108
|
put?: never;
|
|
1075
1109
|
post?: never;
|
|
1076
|
-
/**
|
|
1110
|
+
/** Delete a security group rule */
|
|
1077
1111
|
delete: operations["delete-security-group-rule"];
|
|
1078
1112
|
options?: never;
|
|
1079
1113
|
head?: never;
|
|
@@ -1087,14 +1121,14 @@ export interface paths {
|
|
|
1087
1121
|
path?: never;
|
|
1088
1122
|
cookie?: never;
|
|
1089
1123
|
};
|
|
1090
|
-
/**
|
|
1124
|
+
/** List snapshots */
|
|
1091
1125
|
get: operations["list-snapshots"];
|
|
1092
1126
|
put?: never;
|
|
1093
1127
|
/**
|
|
1094
|
-
*
|
|
1095
|
-
* @description
|
|
1128
|
+
* Create a snapshot
|
|
1129
|
+
* @description Disks attached to a running instance can be snapshotted. A snapshot records the state of the block device at a point in time and may be inconsistent at the file-system level, so run `sync` inside the instance first where the data matters.
|
|
1096
1130
|
*
|
|
1097
|
-
*
|
|
1131
|
+
* **A snapshot of a system disk cannot be used to revert that system disk**: reverting requires the disk to be detached, and a system disk cannot be detached. It can be used to create a new data disk. To preserve and restore an entire system, use a private image; for a copy that crosses availability zones and survives deletion of the disk, use a backup.
|
|
1098
1132
|
*/
|
|
1099
1133
|
post: operations["create-snapshot"];
|
|
1100
1134
|
delete?: never;
|
|
@@ -1110,15 +1144,15 @@ export interface paths {
|
|
|
1110
1144
|
path?: never;
|
|
1111
1145
|
cookie?: never;
|
|
1112
1146
|
};
|
|
1113
|
-
/**
|
|
1147
|
+
/** Retrieve a snapshot */
|
|
1114
1148
|
get: operations["get-snapshot"];
|
|
1115
1149
|
put?: never;
|
|
1116
1150
|
post?: never;
|
|
1117
|
-
/**
|
|
1151
|
+
/** Delete a snapshot */
|
|
1118
1152
|
delete: operations["delete-snapshot"];
|
|
1119
1153
|
options?: never;
|
|
1120
1154
|
head?: never;
|
|
1121
|
-
/**
|
|
1155
|
+
/** Rename a snapshot */
|
|
1122
1156
|
patch: operations["rename-snapshot"];
|
|
1123
1157
|
trace?: never;
|
|
1124
1158
|
};
|
|
@@ -1136,7 +1170,7 @@ export interface components {
|
|
|
1136
1170
|
status: number;
|
|
1137
1171
|
};
|
|
1138
1172
|
BackupResource: {
|
|
1139
|
-
/** @description
|
|
1173
|
+
/** @description Availability zone of the source disk. A restore may target another zone in the same region */
|
|
1140
1174
|
availability_zone: string;
|
|
1141
1175
|
/** Format: date-time */
|
|
1142
1176
|
created_at: string;
|
|
@@ -1146,12 +1180,12 @@ export interface components {
|
|
|
1146
1180
|
region_code: string;
|
|
1147
1181
|
/**
|
|
1148
1182
|
* Format: int64
|
|
1149
|
-
* @description
|
|
1183
|
+
* @description Capacity of the source disk when the backup was created. A restored disk cannot be smaller than this
|
|
1150
1184
|
*/
|
|
1151
1185
|
size_gb: number;
|
|
1152
1186
|
/**
|
|
1153
1187
|
* Format: uuid
|
|
1154
|
-
* @description
|
|
1188
|
+
* @description The disk this backup was taken from. The backup remains usable after that disk is deleted
|
|
1155
1189
|
*/
|
|
1156
1190
|
source_disk_id: string;
|
|
1157
1191
|
/** @enum {string} */
|
|
@@ -1171,29 +1205,29 @@ export interface components {
|
|
|
1171
1205
|
RestoreBackupRequestBody: {
|
|
1172
1206
|
/**
|
|
1173
1207
|
* Format: uuid
|
|
1174
|
-
* @description
|
|
1208
|
+
* @description May differ from the availability zone of the source disk, but must be in the same region
|
|
1175
1209
|
*/
|
|
1176
1210
|
disk_type_id: string;
|
|
1177
1211
|
name: string;
|
|
1178
1212
|
/**
|
|
1179
1213
|
* Format: int64
|
|
1180
|
-
* @description
|
|
1214
|
+
* @description Matches the size of the backup when omitted. When given, it must not be smaller than the backup
|
|
1181
1215
|
*/
|
|
1182
1216
|
size_gb?: number;
|
|
1183
1217
|
};
|
|
1184
1218
|
DiskResource: {
|
|
1185
1219
|
attached_instance_id: string | null;
|
|
1186
|
-
/** @description
|
|
1220
|
+
/** @description Availability zone the disk actually resides in. An instance must be in the same zone to attach it */
|
|
1187
1221
|
availability_zone: string;
|
|
1188
1222
|
/** Format: date-time */
|
|
1189
1223
|
created_at: string;
|
|
1190
|
-
/** @description
|
|
1224
|
+
/** @description Device name assigned by the system, as seen inside the instance */
|
|
1191
1225
|
device: string | null;
|
|
1192
1226
|
/** Format: uuid */
|
|
1193
1227
|
disk_type_id: string;
|
|
1194
1228
|
/** Format: uuid */
|
|
1195
1229
|
id: string;
|
|
1196
|
-
/** @description
|
|
1230
|
+
/** @description A system disk is released with its instance and can be neither detached nor deleted individually */
|
|
1197
1231
|
is_system: boolean;
|
|
1198
1232
|
name: string;
|
|
1199
1233
|
region_code: string;
|
|
@@ -1234,14 +1268,14 @@ export interface components {
|
|
|
1234
1268
|
os_family: string;
|
|
1235
1269
|
os_version: string;
|
|
1236
1270
|
region_code: string;
|
|
1237
|
-
/** @description
|
|
1271
|
+
/** @description False means a new password can only be set by rebuilding an instance created from this image */
|
|
1238
1272
|
supports_password_reset: boolean;
|
|
1239
1273
|
};
|
|
1240
1274
|
ImageListResponseBody: {
|
|
1241
1275
|
items: components["schemas"]["ImageResource"][] | null;
|
|
1242
1276
|
};
|
|
1243
1277
|
InstanceTypeResource: {
|
|
1244
|
-
/** @description
|
|
1278
|
+
/** @description Availability zone of this instance type. A disk must be in the same zone to be attached */
|
|
1245
1279
|
availability_zone_code: string;
|
|
1246
1280
|
/** Format: uuid */
|
|
1247
1281
|
id: string;
|
|
@@ -1287,7 +1321,7 @@ export interface components {
|
|
|
1287
1321
|
size_gb: number;
|
|
1288
1322
|
/**
|
|
1289
1323
|
* Format: uuid
|
|
1290
|
-
* @description
|
|
1324
|
+
* @description Restore from this snapshot. When given, the capacity need only be no smaller than the snapshot
|
|
1291
1325
|
*/
|
|
1292
1326
|
snapshot_id?: string;
|
|
1293
1327
|
};
|
|
@@ -1297,14 +1331,14 @@ export interface components {
|
|
|
1297
1331
|
ResizeDiskRequestBody: {
|
|
1298
1332
|
/**
|
|
1299
1333
|
* Format: int64
|
|
1300
|
-
* @description
|
|
1334
|
+
* @description Must be larger than the current capacity
|
|
1301
1335
|
*/
|
|
1302
1336
|
size_gb: number;
|
|
1303
1337
|
};
|
|
1304
1338
|
RevertDiskRequestBody: {
|
|
1305
1339
|
/**
|
|
1306
1340
|
* Format: uuid
|
|
1307
|
-
* @description
|
|
1341
|
+
* @description Must be the most recent snapshot of the disk
|
|
1308
1342
|
*/
|
|
1309
1343
|
snapshot_id: string;
|
|
1310
1344
|
};
|
|
@@ -1322,7 +1356,7 @@ export interface components {
|
|
|
1322
1356
|
id: string;
|
|
1323
1357
|
region_code: string;
|
|
1324
1358
|
/**
|
|
1325
|
-
* @description idle
|
|
1359
|
+
* @description `idle` means the address is not bound to a network interface
|
|
1326
1360
|
* @enum {string}
|
|
1327
1361
|
*/
|
|
1328
1362
|
status: "idle" | "bound";
|
|
@@ -1331,7 +1365,7 @@ export interface components {
|
|
|
1331
1365
|
items: components["schemas"]["FloatingIPResource"][] | null;
|
|
1332
1366
|
};
|
|
1333
1367
|
AllocateFloatingIPRequestBody: {
|
|
1334
|
-
/** @description
|
|
1368
|
+
/** @description The address to allocate. Allocated by the platform when omitted */
|
|
1335
1369
|
address?: string;
|
|
1336
1370
|
/** Format: uuid */
|
|
1337
1371
|
private_network_id: string;
|
|
@@ -1339,7 +1373,7 @@ export interface components {
|
|
|
1339
1373
|
SetBandwidthRequestBody: {
|
|
1340
1374
|
/**
|
|
1341
1375
|
* Format: int64
|
|
1342
|
-
* @description
|
|
1376
|
+
* @description Applied to both directions
|
|
1343
1377
|
*/
|
|
1344
1378
|
mbps: number;
|
|
1345
1379
|
};
|
|
@@ -1351,47 +1385,54 @@ export interface components {
|
|
|
1351
1385
|
availability_zone: string;
|
|
1352
1386
|
/** Format: date-time */
|
|
1353
1387
|
created_at: string;
|
|
1354
|
-
/** @description
|
|
1388
|
+
/** @description Hostname inside the instance; equals the instance id */
|
|
1355
1389
|
hostname: string;
|
|
1356
1390
|
/** Format: uuid */
|
|
1357
1391
|
id: string;
|
|
1358
1392
|
/**
|
|
1359
1393
|
* Format: uuid
|
|
1360
|
-
* @description
|
|
1394
|
+
* @description Non-empty when the instance was created from a platform image
|
|
1361
1395
|
*/
|
|
1362
1396
|
image_id: string | null;
|
|
1363
1397
|
/**
|
|
1364
1398
|
* Format: uuid
|
|
1365
|
-
* @description
|
|
1399
|
+
* @description The instance type in effect, and the basis for billing
|
|
1366
1400
|
*/
|
|
1367
1401
|
instance_type_id: string;
|
|
1368
|
-
/** @description
|
|
1402
|
+
/** @description IPv6 address of the primary network interface. Assigned automatically once IPv6 is enabled on the private network */
|
|
1369
1403
|
ipv6_address: string | null;
|
|
1370
1404
|
name: string;
|
|
1371
1405
|
/**
|
|
1372
1406
|
* Format: uuid
|
|
1373
|
-
* @description
|
|
1407
|
+
* @description Non-empty while a resize awaits confirmation. Confirming puts this type into effect, reverting discards it
|
|
1374
1408
|
*/
|
|
1375
1409
|
pending_instance_type_id: string | null;
|
|
1376
1410
|
/**
|
|
1377
1411
|
* Format: uuid
|
|
1378
|
-
* @description
|
|
1412
|
+
* @description Non-empty when the instance was created from a private image
|
|
1379
1413
|
*/
|
|
1380
1414
|
private_image_id: string | null;
|
|
1381
|
-
/** @description
|
|
1415
|
+
/** @description Private address of the instance */
|
|
1382
1416
|
private_ip: string | null;
|
|
1383
|
-
/** @description
|
|
1417
|
+
/** @description Private network of the primary network interface */
|
|
1384
1418
|
private_network_id: string | null;
|
|
1385
|
-
/** @description
|
|
1419
|
+
/** @description Floating IPv4 addresses bound to the primary network interface; an empty array when none are bound */
|
|
1386
1420
|
public_ips: string[] | null;
|
|
1387
1421
|
region_code: string;
|
|
1388
|
-
/**
|
|
1389
|
-
|
|
1390
|
-
|
|
1422
|
+
/**
|
|
1423
|
+
* @description Only `running` and `stopped` accept commands. Every other value means the instance is changing, and start, stop, reboot, resize, rebuild and password reset are all rejected.
|
|
1424
|
+
*
|
|
1425
|
+
* `transitioning` is the fallback for a change that falls into none of the categories above. It does not indicate an error; keep polling.
|
|
1426
|
+
*
|
|
1427
|
+
* `resize_verifying` is not transient: the instance is running on the new size and stays there until the resize is confirmed or reverted, with both sizes billed in the meantime.
|
|
1428
|
+
* @enum {string}
|
|
1429
|
+
*/
|
|
1430
|
+
status: "provisioning" | "running" | "stopped" | "starting" | "stopping" | "rebooting" | "transitioning" | "resizing" | "resize_verifying" | "error" | "deleting" | "suspended";
|
|
1431
|
+
/** @description Subnet of the primary network interface */
|
|
1391
1432
|
subnet_id: string | null;
|
|
1392
1433
|
/**
|
|
1393
1434
|
* Format: date-time
|
|
1394
|
-
* @description
|
|
1435
|
+
* @description Non-empty once the platform has suspended the instance, which must be lifted before any operation
|
|
1395
1436
|
*/
|
|
1396
1437
|
suspended_at: string | null;
|
|
1397
1438
|
/** Format: date-time */
|
|
@@ -1403,50 +1444,50 @@ export interface components {
|
|
|
1403
1444
|
LaunchInstanceRequestBody: {
|
|
1404
1445
|
/**
|
|
1405
1446
|
* Format: int64
|
|
1406
|
-
* @description
|
|
1447
|
+
* @description Number of instances to create; 1 when omitted. Names are numbered automatically for several
|
|
1407
1448
|
*/
|
|
1408
1449
|
count?: number;
|
|
1409
|
-
/** @description
|
|
1450
|
+
/** @description Have the platform generate a random password, returned only in this response */
|
|
1410
1451
|
generate_password?: boolean;
|
|
1411
1452
|
/**
|
|
1412
1453
|
* Format: uuid
|
|
1413
|
-
* @description
|
|
1454
|
+
* @description A platform image. Exactly one of this and `private_image_id`
|
|
1414
1455
|
*/
|
|
1415
1456
|
image_id?: string;
|
|
1416
1457
|
/** Format: uuid */
|
|
1417
1458
|
instance_type_id: string;
|
|
1418
1459
|
name: string;
|
|
1419
|
-
/** @description
|
|
1460
|
+
/** @description Root password. Only the SSH public keys of the project are used when omitted */
|
|
1420
1461
|
password?: string;
|
|
1421
1462
|
/**
|
|
1422
1463
|
* Format: uuid
|
|
1423
|
-
* @description
|
|
1464
|
+
* @description Use an existing network interface, which may already have a floating IP bound. Exactly one of this and `subnet_id`; only one instance can be created when it is used
|
|
1424
1465
|
*/
|
|
1425
1466
|
port_id?: string;
|
|
1426
1467
|
/**
|
|
1427
1468
|
* Format: uuid
|
|
1428
|
-
* @description
|
|
1469
|
+
* @description A private image. Exactly one of this and `image_id`
|
|
1429
1470
|
*/
|
|
1430
1471
|
private_image_id?: string;
|
|
1431
1472
|
/**
|
|
1432
1473
|
* Format: int64
|
|
1433
|
-
* @description
|
|
1474
|
+
* @description System disk capacity in GB. Chosen automatically from the requirement of the image and the platform minimum when omitted
|
|
1434
1475
|
*/
|
|
1435
1476
|
root_disk_gb?: number;
|
|
1436
|
-
/** @description
|
|
1477
|
+
/** @description Required when a primary network interface is created, at least one; the default security group is not applied automatically. Ignored together with `port_id`, as the security groups of that interface were fixed when it was created */
|
|
1437
1478
|
security_group_ids?: string[] | null;
|
|
1438
1479
|
/**
|
|
1439
1480
|
* Format: uuid
|
|
1440
|
-
* @description
|
|
1481
|
+
* @description Create the primary network interface in this subnet. Exactly one of this and `port_id`
|
|
1441
1482
|
*/
|
|
1442
1483
|
subnet_id?: string;
|
|
1443
1484
|
};
|
|
1444
1485
|
LaunchInstanceResponseBody: {
|
|
1445
|
-
/** @description
|
|
1486
|
+
/** @description Non-empty when only some of the instances were created, stating why the sequence stopped */
|
|
1446
1487
|
failure: string | null;
|
|
1447
|
-
/** @description
|
|
1488
|
+
/** @description Returned in request order; an array even for a single instance */
|
|
1448
1489
|
instances: components["schemas"]["InstanceResource"][] | null;
|
|
1449
|
-
/** @description
|
|
1490
|
+
/** @description Returned only in this response; store it immediately. All instances of a batch share it */
|
|
1450
1491
|
password: string;
|
|
1451
1492
|
};
|
|
1452
1493
|
RenameInstanceRequestBody: {
|
|
@@ -1455,50 +1496,77 @@ export interface components {
|
|
|
1455
1496
|
ActOnInstanceRequestBody: {
|
|
1456
1497
|
/** @enum {string} */
|
|
1457
1498
|
action: "start" | "stop" | "reboot";
|
|
1458
|
-
/** @description
|
|
1499
|
+
/** @description Applies to `reboot` only. A forced reboot does not wait for the operating system to shut down and unwritten data is lost; use it when the system is unresponsive */
|
|
1459
1500
|
force?: boolean;
|
|
1460
1501
|
};
|
|
1502
|
+
RunCommandRequestBody: {
|
|
1503
|
+
/** @description Run by the login shell, so pipes, redirection and `&&` work. It cannot read standard input */
|
|
1504
|
+
command: string;
|
|
1505
|
+
/**
|
|
1506
|
+
* Format: int64
|
|
1507
|
+
* @description Kill the command after this long. 60 when omitted
|
|
1508
|
+
*/
|
|
1509
|
+
timeout_seconds?: number;
|
|
1510
|
+
/**
|
|
1511
|
+
* @description The SSH user to log in as. It is the account the platform sets a password for at creation
|
|
1512
|
+
* @default root
|
|
1513
|
+
*/
|
|
1514
|
+
username?: string;
|
|
1515
|
+
};
|
|
1516
|
+
CommandResultResponseBody: {
|
|
1517
|
+
/**
|
|
1518
|
+
* Format: int64
|
|
1519
|
+
* @description Null when the command was killed rather than finishing on its own, which includes the timeout
|
|
1520
|
+
*/
|
|
1521
|
+
exit_code: number | null;
|
|
1522
|
+
stderr: string;
|
|
1523
|
+
stdout: string;
|
|
1524
|
+
/** @description True when the command was still running at the timeout and was killed */
|
|
1525
|
+
timed_out: boolean;
|
|
1526
|
+
/** @description True when either stream hit the 1 MiB cap and the rest was discarded */
|
|
1527
|
+
truncated: boolean;
|
|
1528
|
+
};
|
|
1461
1529
|
ConsoleResponseBody: {
|
|
1462
|
-
/** @description
|
|
1530
|
+
/** @description Connection address of the remote console; single-use and expires within minutes */
|
|
1463
1531
|
console_url: string;
|
|
1464
1532
|
};
|
|
1465
1533
|
ConsoleOutputResponseBody: {
|
|
1466
|
-
/** @description
|
|
1534
|
+
/** @description Raw text of the console output, in the same line order as inside the instance */
|
|
1467
1535
|
output: string;
|
|
1468
1536
|
};
|
|
1469
1537
|
ResetPasswordRequestBody: {
|
|
1470
|
-
/** @description
|
|
1538
|
+
/** @description Have the platform generate a random password, returned only in this response */
|
|
1471
1539
|
generate_password?: boolean;
|
|
1472
|
-
/** @description
|
|
1540
|
+
/** @description New root password. Exactly one of this and `generate_password` */
|
|
1473
1541
|
password?: string;
|
|
1474
1542
|
};
|
|
1475
1543
|
ResetPasswordResponseBody: {
|
|
1476
|
-
/** @description
|
|
1544
|
+
/** @description The password generated by the platform, returned only in this response. Empty when the password was supplied in the request */
|
|
1477
1545
|
password: string;
|
|
1478
1546
|
};
|
|
1479
1547
|
RebuildInstanceRequestBody: {
|
|
1480
1548
|
generate_password?: boolean;
|
|
1481
1549
|
/**
|
|
1482
1550
|
* Format: uuid
|
|
1483
|
-
* @description
|
|
1551
|
+
* @description A platform image. Exactly one of this and `private_image_id`
|
|
1484
1552
|
*/
|
|
1485
1553
|
image_id?: string;
|
|
1486
1554
|
password?: string;
|
|
1487
1555
|
/**
|
|
1488
1556
|
* Format: uuid
|
|
1489
|
-
* @description
|
|
1557
|
+
* @description A private image. Exactly one of this and `image_id`
|
|
1490
1558
|
*/
|
|
1491
1559
|
private_image_id?: string;
|
|
1492
1560
|
};
|
|
1493
1561
|
RebuildInstanceResponseBody: {
|
|
1494
1562
|
instance: components["schemas"]["InstanceResource"];
|
|
1495
|
-
/** @description
|
|
1563
|
+
/** @description Returned only in this response; store it immediately */
|
|
1496
1564
|
password: string;
|
|
1497
1565
|
};
|
|
1498
1566
|
ResizeInstanceRequestBody: {
|
|
1499
1567
|
/**
|
|
1500
1568
|
* Format: uuid
|
|
1501
|
-
* @description
|
|
1569
|
+
* @description Must be in the same region and availability zone as the current instance type
|
|
1502
1570
|
*/
|
|
1503
1571
|
instance_type_id: string;
|
|
1504
1572
|
};
|
|
@@ -1515,14 +1583,14 @@ export interface components {
|
|
|
1515
1583
|
/** Format: uuid */
|
|
1516
1584
|
id: string;
|
|
1517
1585
|
ipv6_address: string | null;
|
|
1518
|
-
/** @description
|
|
1586
|
+
/** @description A primary network interface is created and released with its instance and cannot be detached individually */
|
|
1519
1587
|
is_primary: boolean;
|
|
1520
1588
|
mac: string | null;
|
|
1521
1589
|
name: string;
|
|
1522
1590
|
private_ip: string | null;
|
|
1523
1591
|
/** Format: uuid */
|
|
1524
1592
|
private_network_id: string;
|
|
1525
|
-
/** @description
|
|
1593
|
+
/** @description Floating IPv4 addresses bound to this network interface; an empty array when none are bound */
|
|
1526
1594
|
public_ips: string[] | null;
|
|
1527
1595
|
/** Format: uuid */
|
|
1528
1596
|
subnet_id: string;
|
|
@@ -1535,24 +1603,24 @@ export interface components {
|
|
|
1535
1603
|
port_id: string;
|
|
1536
1604
|
};
|
|
1537
1605
|
OperationLogResource: {
|
|
1538
|
-
/** @description
|
|
1606
|
+
/** @description Name of the operation; matches the operation id of the endpoint */
|
|
1539
1607
|
action: string;
|
|
1540
|
-
/** @description
|
|
1608
|
+
/** @description The user who initiated the operation. Empty when the platform performed it */
|
|
1541
1609
|
actor: string | null;
|
|
1542
|
-
/** @description
|
|
1610
|
+
/** @description True when the operation was performed by the platform */
|
|
1543
1611
|
by_platform: boolean;
|
|
1544
1612
|
/** Format: date-time */
|
|
1545
1613
|
created_at: string;
|
|
1546
|
-
/** @description
|
|
1614
|
+
/** @description Brief reason for the failure */
|
|
1547
1615
|
failure: string | null;
|
|
1548
1616
|
/** Format: uuid */
|
|
1549
1617
|
id: string;
|
|
1550
|
-
/** @description
|
|
1618
|
+
/** @description Path and query parameters of the request. Fields such as passwords are redacted */
|
|
1551
1619
|
payload: {
|
|
1552
1620
|
[key: string]: unknown;
|
|
1553
1621
|
};
|
|
1554
1622
|
region_code: string | null;
|
|
1555
|
-
/** @description
|
|
1623
|
+
/** @description Empty for create operations: the id of the new resource is in the response, not in the request path */
|
|
1556
1624
|
subject_id: string;
|
|
1557
1625
|
subject_type: string;
|
|
1558
1626
|
succeeded: boolean;
|
|
@@ -1564,9 +1632,9 @@ export interface components {
|
|
|
1564
1632
|
};
|
|
1565
1633
|
CreatePortRequestBody: {
|
|
1566
1634
|
name?: string;
|
|
1567
|
-
/** @description
|
|
1635
|
+
/** @description The private address to assign. Allocated automatically when omitted */
|
|
1568
1636
|
private_ip?: string;
|
|
1569
|
-
/** @description
|
|
1637
|
+
/** @description At least one, and all must belong to the same private network */
|
|
1570
1638
|
security_group_ids: string[] | null;
|
|
1571
1639
|
/** Format: uuid */
|
|
1572
1640
|
subnet_id: string;
|
|
@@ -1575,38 +1643,38 @@ export interface components {
|
|
|
1575
1643
|
architecture: string;
|
|
1576
1644
|
/** Format: date-time */
|
|
1577
1645
|
created_at: string;
|
|
1578
|
-
/** @description
|
|
1646
|
+
/** @description Reason the capture failed; non-empty only when `status` is `error` */
|
|
1579
1647
|
failure: string | null;
|
|
1580
1648
|
/** Format: uuid */
|
|
1581
1649
|
id: string;
|
|
1582
1650
|
/**
|
|
1583
1651
|
* Format: int64
|
|
1584
|
-
* @description
|
|
1652
|
+
* @description The system disk of an instance created from this image cannot be smaller than this
|
|
1585
1653
|
*/
|
|
1586
1654
|
min_disk_gb: number;
|
|
1587
1655
|
/**
|
|
1588
1656
|
* Format: int64
|
|
1589
|
-
* @description
|
|
1657
|
+
* @description The instance type of an instance created from this image must have at least this much memory
|
|
1590
1658
|
*/
|
|
1591
1659
|
min_ram_mb: number;
|
|
1592
1660
|
name: string;
|
|
1593
1661
|
os_family: string;
|
|
1594
1662
|
os_version: string;
|
|
1595
|
-
/** @description
|
|
1663
|
+
/** @description An image can only be used in the region that holds it */
|
|
1596
1664
|
region_code: string;
|
|
1597
1665
|
/**
|
|
1598
1666
|
* Format: int64
|
|
1599
|
-
* @description
|
|
1667
|
+
* @description Storage occupied by the image; 0 until the capture completes
|
|
1600
1668
|
*/
|
|
1601
1669
|
size_bytes: number;
|
|
1602
1670
|
/**
|
|
1603
1671
|
* Format: uuid
|
|
1604
|
-
* @description
|
|
1672
|
+
* @description The instance this image was captured from. The image remains usable after that instance is released
|
|
1605
1673
|
*/
|
|
1606
1674
|
source_instance_id: string | null;
|
|
1607
1675
|
/** @enum {string} */
|
|
1608
1676
|
status: "provisioning" | "uploading" | "available" | "deleting" | "error";
|
|
1609
|
-
/** @description
|
|
1677
|
+
/** @description False means a new password can only be set by rebuilding an instance created from this image */
|
|
1610
1678
|
supports_password_reset: boolean;
|
|
1611
1679
|
};
|
|
1612
1680
|
PrivateImageListResponseBody: {
|
|
@@ -1615,7 +1683,7 @@ export interface components {
|
|
|
1615
1683
|
CreatePrivateImageRequestBody: {
|
|
1616
1684
|
/**
|
|
1617
1685
|
* Format: uuid
|
|
1618
|
-
* @description
|
|
1686
|
+
* @description Captured from the system disk of this instance; data disks are not included
|
|
1619
1687
|
*/
|
|
1620
1688
|
instance_id: string;
|
|
1621
1689
|
name: string;
|
|
@@ -1641,7 +1709,7 @@ export interface components {
|
|
|
1641
1709
|
items: components["schemas"]["PrivateNetworkResource"][] | null;
|
|
1642
1710
|
};
|
|
1643
1711
|
CreatePrivateNetworkRequestBody: {
|
|
1644
|
-
/** @description
|
|
1712
|
+
/** @description Must be an RFC 1918 private CIDR with a prefix length between /8 and /24, for example `10.0.0.0/16` */
|
|
1645
1713
|
cidr: string;
|
|
1646
1714
|
name: string;
|
|
1647
1715
|
region_code: string;
|
|
@@ -1650,11 +1718,11 @@ export interface components {
|
|
|
1650
1718
|
name: string;
|
|
1651
1719
|
};
|
|
1652
1720
|
IPv6ResponseBody: {
|
|
1653
|
-
/** @description
|
|
1721
|
+
/** @description The allocated /64 prefix; empty while IPv6 is disabled */
|
|
1654
1722
|
cidr: string;
|
|
1655
1723
|
enabled: boolean;
|
|
1656
1724
|
/**
|
|
1657
|
-
* @description
|
|
1725
|
+
* @description `active` means IPv6 is fully available
|
|
1658
1726
|
* @enum {string}
|
|
1659
1727
|
*/
|
|
1660
1728
|
status: "pending" | "active" | "draining";
|
|
@@ -1673,9 +1741,9 @@ export interface components {
|
|
|
1673
1741
|
};
|
|
1674
1742
|
CreateRouteRequestBody: {
|
|
1675
1743
|
description?: string;
|
|
1676
|
-
/** @description
|
|
1744
|
+
/** @description Destination CIDR. It cannot be `0.0.0.0/0`, nor the CIDR of a subnet of this network */
|
|
1677
1745
|
destination: string;
|
|
1678
|
-
/** @description
|
|
1746
|
+
/** @description Private address of an instance; must fall inside a subnet of this private network */
|
|
1679
1747
|
nexthop: string;
|
|
1680
1748
|
};
|
|
1681
1749
|
SubnetResource: {
|
|
@@ -1696,12 +1764,12 @@ export interface components {
|
|
|
1696
1764
|
items: components["schemas"]["SubnetResource"][] | null;
|
|
1697
1765
|
};
|
|
1698
1766
|
CreateSubnetRequestBody: {
|
|
1699
|
-
/** @description
|
|
1767
|
+
/** @description Must fall inside the CIDR of the private network and must not overlap an existing subnet */
|
|
1700
1768
|
cidr: string;
|
|
1701
1769
|
name: string;
|
|
1702
1770
|
};
|
|
1703
1771
|
NextFreeCidrResponseBody: {
|
|
1704
|
-
/** @description
|
|
1772
|
+
/** @description Empty when the private network has no free CIDR left for that prefix length */
|
|
1705
1773
|
cidr: string;
|
|
1706
1774
|
};
|
|
1707
1775
|
SecurityGroupResource: {
|
|
@@ -1710,7 +1778,7 @@ export interface components {
|
|
|
1710
1778
|
description: string;
|
|
1711
1779
|
/** Format: uuid */
|
|
1712
1780
|
id: string;
|
|
1713
|
-
/** @description
|
|
1781
|
+
/** @description The default security group is released with its private network and cannot be deleted individually */
|
|
1714
1782
|
is_default: boolean;
|
|
1715
1783
|
name: string;
|
|
1716
1784
|
/** Format: uuid */
|
|
@@ -1737,12 +1805,12 @@ export interface components {
|
|
|
1737
1805
|
id: string;
|
|
1738
1806
|
/**
|
|
1739
1807
|
* Format: int64
|
|
1740
|
-
* @description ICMP
|
|
1808
|
+
* @description Denotes the ICMP code rather than a port when the protocol is ICMP
|
|
1741
1809
|
*/
|
|
1742
1810
|
port_range_max: number | null;
|
|
1743
1811
|
/**
|
|
1744
1812
|
* Format: int64
|
|
1745
|
-
* @description ICMP
|
|
1813
|
+
* @description Denotes the ICMP type rather than a port when the protocol is ICMP
|
|
1746
1814
|
*/
|
|
1747
1815
|
port_range_min: number | null;
|
|
1748
1816
|
protocol: string | null;
|
|
@@ -1759,21 +1827,21 @@ export interface components {
|
|
|
1759
1827
|
ethertype: "IPv4" | "IPv6";
|
|
1760
1828
|
/**
|
|
1761
1829
|
* Format: int64
|
|
1762
|
-
* @description ICMP
|
|
1830
|
+
* @description Denotes the ICMP code (0–255) rather than a port when the protocol is ICMP
|
|
1763
1831
|
*/
|
|
1764
1832
|
port_range_max?: number | null;
|
|
1765
1833
|
/**
|
|
1766
1834
|
* Format: int64
|
|
1767
|
-
* @description ICMP
|
|
1835
|
+
* @description Denotes the ICMP type (0–255) rather than a port when the protocol is ICMP
|
|
1768
1836
|
*/
|
|
1769
1837
|
port_range_min?: number | null;
|
|
1770
|
-
/** @description
|
|
1838
|
+
/** @description For example `tcp`, `udp`, `icmp` or `ipv6-icmp`. All protocols when omitted */
|
|
1771
1839
|
protocol?: string;
|
|
1772
|
-
/** @description
|
|
1840
|
+
/** @description Equivalent to `0.0.0.0/0` or `::/0` when omitted */
|
|
1773
1841
|
remote_ip_prefix?: string;
|
|
1774
1842
|
};
|
|
1775
1843
|
SnapshotResource: {
|
|
1776
|
-
/** @description
|
|
1844
|
+
/** @description A disk restored from this snapshot must reside in this availability zone */
|
|
1777
1845
|
availability_zone: string;
|
|
1778
1846
|
/** Format: date-time */
|
|
1779
1847
|
created_at: string;
|
|
@@ -1785,7 +1853,7 @@ export interface components {
|
|
|
1785
1853
|
region_code: string;
|
|
1786
1854
|
/**
|
|
1787
1855
|
* Format: int64
|
|
1788
|
-
* @description
|
|
1856
|
+
* @description Capacity of the source disk when the snapshot was created. A disk restored from it cannot be smaller
|
|
1789
1857
|
*/
|
|
1790
1858
|
size_gb: number;
|
|
1791
1859
|
/** @enum {string} */
|
|
@@ -1817,7 +1885,7 @@ export interface operations {
|
|
|
1817
1885
|
"list-backups": {
|
|
1818
1886
|
parameters: {
|
|
1819
1887
|
query?: {
|
|
1820
|
-
/** @description
|
|
1888
|
+
/** @description Return only the backups of this disk */
|
|
1821
1889
|
disk_id?: string;
|
|
1822
1890
|
};
|
|
1823
1891
|
header?: never;
|
|
@@ -2166,7 +2234,7 @@ export interface operations {
|
|
|
2166
2234
|
parameters: {
|
|
2167
2235
|
query?: {
|
|
2168
2236
|
region_code?: string;
|
|
2169
|
-
/** @description
|
|
2237
|
+
/** @description Supplied together with `region_code` to filter attachable disks */
|
|
2170
2238
|
availability_zone?: string;
|
|
2171
2239
|
};
|
|
2172
2240
|
header?: never;
|
|
@@ -2808,6 +2876,41 @@ export interface operations {
|
|
|
2808
2876
|
};
|
|
2809
2877
|
};
|
|
2810
2878
|
};
|
|
2879
|
+
"run-instance-command": {
|
|
2880
|
+
parameters: {
|
|
2881
|
+
query?: never;
|
|
2882
|
+
header?: never;
|
|
2883
|
+
path: {
|
|
2884
|
+
instanceId: string;
|
|
2885
|
+
};
|
|
2886
|
+
cookie?: never;
|
|
2887
|
+
};
|
|
2888
|
+
requestBody: {
|
|
2889
|
+
content: {
|
|
2890
|
+
"application/json": components["schemas"]["RunCommandRequestBody"];
|
|
2891
|
+
};
|
|
2892
|
+
};
|
|
2893
|
+
responses: {
|
|
2894
|
+
/** @description OK */
|
|
2895
|
+
200: {
|
|
2896
|
+
headers: {
|
|
2897
|
+
[name: string]: unknown;
|
|
2898
|
+
};
|
|
2899
|
+
content: {
|
|
2900
|
+
"application/json": components["schemas"]["CommandResultResponseBody"];
|
|
2901
|
+
};
|
|
2902
|
+
};
|
|
2903
|
+
/** @description Error */
|
|
2904
|
+
default: {
|
|
2905
|
+
headers: {
|
|
2906
|
+
[name: string]: unknown;
|
|
2907
|
+
};
|
|
2908
|
+
content: {
|
|
2909
|
+
"application/json": components["schemas"]["Error"];
|
|
2910
|
+
};
|
|
2911
|
+
};
|
|
2912
|
+
};
|
|
2913
|
+
};
|
|
2811
2914
|
"open-instance-console": {
|
|
2812
2915
|
parameters: {
|
|
2813
2916
|
query?: never;
|
|
@@ -2842,7 +2945,7 @@ export interface operations {
|
|
|
2842
2945
|
"get-instance-console-output": {
|
|
2843
2946
|
parameters: {
|
|
2844
2947
|
query?: {
|
|
2845
|
-
/** @description
|
|
2948
|
+
/** @description Number of trailing lines to return; 0 returns the entire output */
|
|
2846
2949
|
lines?: number;
|
|
2847
2950
|
};
|
|
2848
2951
|
header?: never;
|
|
@@ -3306,7 +3409,7 @@ export interface operations {
|
|
|
3306
3409
|
"list-operation-logs": {
|
|
3307
3410
|
parameters: {
|
|
3308
3411
|
query?: {
|
|
3309
|
-
/** @description
|
|
3412
|
+
/** @description Return a single kind of operation; the value matches the operation id of the endpoint */
|
|
3310
3413
|
action?: string;
|
|
3311
3414
|
limit?: number;
|
|
3312
3415
|
offset?: number;
|
|
@@ -3431,7 +3534,7 @@ export interface operations {
|
|
|
3431
3534
|
"list-private-images": {
|
|
3432
3535
|
parameters: {
|
|
3433
3536
|
query?: {
|
|
3434
|
-
/** @description
|
|
3537
|
+
/** @description Return only the images of this region. An image can only be used in the region that holds it */
|
|
3435
3538
|
region_code?: string;
|
|
3436
3539
|
};
|
|
3437
3540
|
header?: never;
|
|
@@ -3591,7 +3694,7 @@ export interface operations {
|
|
|
3591
3694
|
"list-private-networks": {
|
|
3592
3695
|
parameters: {
|
|
3593
3696
|
query?: {
|
|
3594
|
-
/** @description
|
|
3697
|
+
/** @description Returns every region when omitted */
|
|
3595
3698
|
region_code?: string;
|
|
3596
3699
|
};
|
|
3597
3700
|
header?: never;
|
|
@@ -4068,7 +4171,7 @@ export interface operations {
|
|
|
4068
4171
|
parameters: {
|
|
4069
4172
|
query?: {
|
|
4070
4173
|
region_code?: string;
|
|
4071
|
-
/** @description
|
|
4174
|
+
/** @description Return only the security groups of this private network */
|
|
4072
4175
|
private_network_id?: string;
|
|
4073
4176
|
};
|
|
4074
4177
|
header?: never;
|
|
@@ -4324,7 +4427,7 @@ export interface operations {
|
|
|
4324
4427
|
"list-snapshots": {
|
|
4325
4428
|
parameters: {
|
|
4326
4429
|
query?: {
|
|
4327
|
-
/** @description
|
|
4430
|
+
/** @description Return only the snapshots of this disk */
|
|
4328
4431
|
disk_id?: string;
|
|
4329
4432
|
};
|
|
4330
4433
|
header?: never;
|