-
-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathscaleway.instance.v1.Api.yml
5167 lines (5120 loc) · 150 KB
/
scaleway.instance.v1.Api.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
info:
title: Instance API
description: |
# Introduction
## Endpoints
Scaleway instance API can be reach on
- `https://api.scaleway.com/instance/v1/zones/fr-par-1`
- `https://api.scaleway.com/instance/v1/zones/fr-par-2`
- `https://api.scaleway.com/instance/v1/zones/nl-ams-1`
- `https://api.scaleway.com/instance/v1/zones/pl-waw-1`
Older endpoints are still reachable but should not be used for new projects
- `https://cp-par1.scaleway.com`
- `https://cp-ams1.scaleway.com`
<Example>
The following code is an example request to retrieve detailed information about a volume:
```
% curl -H 'X-Auth-Token: xxxxxxxx-xxxx-xxxxx-xxxx-xxxxxxxxxxxxx' -H 'Content-Type: application/json' https://api.scaleway.com/instance/v1/zones/fr-par-1/volumes/f929fe39-63f8-4be8-a80e-1e9c8ae22a76 -i
HTTP/1.1 200 OK
Server: nginx
Date: Thu, 22 May 2014 07:55:00 GMT
Content-Type: application/json
Content-Length: 1345
Connection: keep-alive
Strict-Transport-Security: max-age=86400
{
"volumes": [
{
"export_uri": null,
"id": "f929fe39-63f8-4be8-a80e-1e9c8ae22a76",
"name": "volume-0-1",
"organization": "000a115d-2852-4b0a-9ce8-47f1134ba95a",
"server": null,
"size": 10000000000,
"volume_type": "l_ssd"
},
{
"export_uri": null,
"id": "0facb6b5-b117-441a-81c1-f28b1d723779",
"name": "volume-0-2",
"organization": "000a115d-2852-4b0a-9ce8-47f1134ba95a",
"server": null,
"size": 20000000000,
"volume_type": "l_ssd"
}
]
}
```
</Example>
## Pagination
Most of listing requests receive a paginated response.
**Paginated request**
Requests against paginated endpoints accept two `query` arguments:
- `page`, a positive integer to choose the page to return.
- `per_page`, an positive integer lower or equal to 100 to select the number of
items to return. The default value is `50`.
Paginated endpoints usually also accept filters to search and sort results.
These filters are documented along each endpoint documentation.
**Paginated response**
```bash
% curl -H 'X-Auth-Token: <token>' 'https://api.scaleway.com/instance/v1/zones/fr-par-1/images/?page=2&per_page=10' -i
HTTP/1.0 200 OK
[...]
X-Total-Count: 209
[...]
```
The `X-Total-Count` header contains the total number of items for the resource.
version: v1
servers:
- url: https://api.scaleway.com
tags:
- name: Servers
description: |
Server types are denomination of the different instances we provide.
Scaleway offers **Virtual Cloud** and **dedicated GPU** instances.
**Virtual Cloud Instances**
Virtual cloud instances are offering the best performance/price ratio for most workloads. Different CPU architectures are proposed: The **Development** and **General Purpose** ranges are based on AMD EPYC CPUs. The **ARM64** range is based on Cavium Thunder X ARM CPUs.
* The **Development** instances range provides stable and consistent performance for development needs.
Spin up a development or test environment within seconds.
Refer to the [Development Instance offer details](https://www.scaleway.com/en/development-instances/) for more information.
* The **General Purpose** instances range is the solution for demanding workloads.
Powerful AMD EPYC CPUs back those instances and offer up to 48 Cores, 256GB of RAM and 600GB of replicated local NVMe SSD storage.
Refer to the [General Purpose offer details](https://www.scaleway.com/en/general-purpose-instances/) for more information.
* The **ARM** instances range is based on Cavium ThunderX SoCs and provides up to 64 Cores ARM 64bit, 128GB of RAM and 1TB SSD storage.
Refer to the [ARM offer details](https://www.scaleway.com/en/arm-instances) for more information.
**Dedicated GPU Instances**
GPU instances are very powerful compute instances, providing lots of RAM, vCPU, and storage.
They are equipped with Nvidia Tesla P100 GPUs, which are designed for handling rapidly, a massive amount of data.
They are useful for heavy data processing, artificial intelligence and machine learning, video encoding, rendering, and so on.
The GPU is dedicated to each instance and directly exposed through PCI-e.
For more information, refer to [GPU Instances](https://www.scaleway.com/en/gpu-instances/).
- name: Images
description: |
Images are backups of your instances.
You can reuse that image to restore your data or create a series of instances with a predefined configuration.
An image is a complete backup of your server including all volumes.
- name: Security Groups
description: |
A security group is a set of firewall rules on a set of instances.
Security groups enable to create rules that either drop or allow incoming traffic from certain ports of your instances.
Security Groups are stateful by default which means return traffic is automatically allowed, regardless of any rules.
As a contrary, you have to switch in a stateless mode to define explicitly allowed.
- name: User-Data
description: |
User data is a key value store API you can use to provide data from and to your server without authentication.
As an example of use, Scaleway images contain the script scw-generate-ssh-keys which generates SSH server’s host keys then stores their fingerprints as user data under the key “ssh-host-fingerprints”.
This way, we ensure they are really connecting to their Scaleway instance and they are not victim of a man-in-the-middle attack.
There are two endpoints to access user data:
- **From a running instance**, by using the metadata API at http://169.254.42.42/user_data.
To enhance security, we only allow user data viewing and editing as root.
To know if the query is issued by the root user, we only accept queries made from a local port below 1024 (by default, non-root users can’t bind ports below 1024).
To specify the local port with cURL, use `curl --local-port 1-1024 http://169.254.42.42/user_data`
- **From the instance API** at using methods described bellow.
- name: Server types
description: |
Server types will answer with all instance types available in a given zone.
Each of these types will contains all the features of the instance (CPU, RAM, Storage) with their associated pricing.
- name: Volume types
description: |
Volume types will answer with all volume types available in a given zone.
Each of these types will contains all the capabilities and constraints of the volume (min size, max size, snapshot).
- name: IPs
description: |
A flexible IP address is an IP address which you hold independently of any server.
You can attach it to any of your servers and do live migration of the IP address between your servers.
Be aware that attaching a flexible IP address to a server will remove the previous public IP address of the server and cut any ongoing public connection to the server.
- name: Volumes
description: |
A volume is where you store your data inside your instance. It
appears as a block device on Linux that you can use to create
a filesystem and mount it.
We have two different types of volume (`volume_type`):
- `l_ssd` is a local block storage: your data is downloaded on
the hypervisor and you need to power off your instance to attach
or detach a volume.
- `b_ssd` is a remote block storage: your data is stored on a
centralised cluster. You can plug and unplug a volume while
your instance is running. As of today, `b_ssd` is only available
for `DEV1`, `GP1` and `RENDER` offers.
Minimum and maximum volume sizes for each volume types can be queried
from the zone `/products/volumes` API endpoint. _I.e_ for:
- `fr-par-1` use https://api.scaleway.com/instance/v1/zones/fr-par-1/products/volumes
- `nl-ams-1` use https://api.scaleway.com/instance/v1/zones/nl-ams-1/products/volumes
Each types of volumes is also subject to a global quota for the sum of all the
volumes. This quota depends of the level of support and may be
changed on demand.
Be wary that when terminating an instance, if you want to keep
your block storage volume, **you must** detach it beforehand you
issue the `terminate` call.
When using multiple block devices, it's advised to mount them by
using their UUID instead of their device name. A device name is
subject to change depending on the volumes order. Block devices
UUIDs can be found in `/dev/disk/by-id/`.
- name: Snapshots
description: |
Snapshots contain the data of a specific volume at a particular point in time.
The data can include the instance's operating system,
configuration information or files stored on the volume.
A snapshot can be done from a specific volume (for example you
have a server with a volume containing the OS and another one
containing the application data, and you want to use different
snapshot strategies on both volumes).
Snapshots only work on `l_ssd` volume type at the moment. `b_ssd`
snapshots will be available starting 2020.
- name: Bootscripts
description: |
Bootscripts are a combination of a [Kernel](https://en.wikipedia.org/wiki/Kernel_(operating_system)) and of an [initrd](https://en.wikipedia.org/wiki/Initial_ramdisk).
They tell to the instance how to start and configure its starting process and settings.
Bootscripts are available on all of instances types (DEV, GP, RENDER, ARM).
Scaleway recommends that you take the "localboot" boot method that will automatically launch your instance with your locally installed kernel.
It gives you full control over the booting process of your instance.
Scaleway also provides a "rescue" bootscript that can be used when your instance gets a failure and if you need a clean operating system to access your data.
- name: Placement Groups
description: |
Placement groups allow the user to express a preference regarding
the physical position of a group of instances. It'll let the user
choose to either group instances on the same physical hardware for
best network throughput and low latency or to spread instances on
far away hardware to reduce the risk of physical failure.
The operating mode is selected by a `policy_type`. Two policy
types are available:
- `low_latency` will group instances on the same hypervisors
- `max_availability` will spread instances on far away hypervisors
The `policy_type` is set by default to `max_availability`.
For each policy types, one of the two `policy_mode` may be selected:
- `optional` will start your instances even if the constraint is not respected
- `enforced` guarantee that if the instance starts, the constraint is respected
The `policy_mode` is set by default to `optional`.
- name: Private NICs
description: |
A Private NIC is the network interface that connects a server to a
Private Network. There can be at most one Private NIC connecting a
server to a network.
components:
schemas:
google.protobuf.BoolValue:
type: boolean
nullable: true
google.protobuf.StringValue:
type: string
nullable: true
google.protobuf.Timestamp:
type: string
format: date-time
google.protobuf.UInt32Value:
type: number
nullable: true
google.protobuf.UInt64Value:
type: string
nullable: true
scaleway.instance.v1.Arch:
type: string
enum:
- x86_64
- arm
default: x86_64
scaleway.instance.v1.BootType:
type: string
enum:
- local
- bootscript
- rescue
default: local
scaleway.instance.v1.Bootscript:
type: object
properties:
bootcmdargs:
type: string
description: The bootscript arguments
default:
type: boolean
description: Dispmay if the bootscript is the default bootscript if no other
boot option is configured
dtb:
type: string
description: Provide information regarding a Device Tree Binary (dtb) for
use with C1 servers
id:
type: string
description: The bootscript ID
initrd:
type: string
description: The initrd (initial ramdisk) configuration
kernel:
type: string
description: The server kernel version
organization:
type: string
description: The bootscript organization ID
project:
type: string
description: The bootscript project ID
public:
type: boolean
description: Provide information if the bootscript is public
title:
type: string
description: The bootscript title
arch:
type: string
description: The bootscript arch
enum:
- x86_64
- arm
default: x86_64
zone:
type: string
description: The zone in which is the bootscript
x-properties-order:
- bootcmdargs
- default
- dtb
- id
- initrd
- kernel
- organization
- project
- public
- title
- arch
- zone
scaleway.instance.v1.CreateImageResponse:
type: object
properties:
image:
$ref: '#/components/schemas/scaleway.instance.v1.Image'
Location:
type: string
x-properties-order:
- image
- Location
scaleway.instance.v1.CreateIpResponse:
type: object
properties:
ip:
$ref: '#/components/schemas/scaleway.instance.v1.Ip'
Location:
type: string
x-properties-order:
- ip
- Location
scaleway.instance.v1.CreatePlacementGroupResponse:
type: object
properties:
placement_group:
$ref: '#/components/schemas/scaleway.instance.v1.PlacementGroup'
x-properties-order:
- placement_group
scaleway.instance.v1.CreatePrivateNICResponse:
type: object
properties:
private_nic:
$ref: '#/components/schemas/scaleway.instance.v1.PrivateNIC'
x-properties-order:
- private_nic
scaleway.instance.v1.CreateSecurityGroupResponse:
type: object
properties:
security_group:
$ref: '#/components/schemas/scaleway.instance.v1.SecurityGroup'
x-properties-order:
- security_group
scaleway.instance.v1.CreateSecurityGroupRuleResponse:
type: object
properties:
rule:
$ref: '#/components/schemas/scaleway.instance.v1.SecurityGroupRule'
x-properties-order:
- rule
scaleway.instance.v1.CreateServerResponse:
type: object
properties:
server:
$ref: '#/components/schemas/scaleway.instance.v1.Server'
x-properties-order:
- server
scaleway.instance.v1.CreateSnapshotResponse:
type: object
properties:
snapshot:
$ref: '#/components/schemas/scaleway.instance.v1.Snapshot'
x-properties-order:
- snapshot
scaleway.instance.v1.CreateVolumeResponse:
type: object
properties:
volume:
$ref: '#/components/schemas/scaleway.instance.v1.Volume'
Location:
type: string
x-properties-order:
- volume
- Location
scaleway.instance.v1.Dashboard:
type: object
properties:
volumes_count:
type: number
running_servers_count:
type: number
servers_by_types:
type: object
properties:
<servers_by_typeKey>:
type: number
additionalProperties: true
images_count:
type: number
snapshots_count:
type: number
servers_count:
type: number
ips_count:
type: number
security_groups_count:
type: number
ips_unused:
type: number
x-properties-order:
- volumes_count
- running_servers_count
- servers_by_types
- images_count
- snapshots_count
- servers_count
- ips_count
- security_groups_count
- ips_unused
scaleway.instance.v1.GetBootscriptResponse:
type: object
properties:
bootscript:
$ref: '#/components/schemas/scaleway.instance.v1.Bootscript'
x-properties-order:
- bootscript
scaleway.instance.v1.GetDashboardResponse:
type: object
properties:
dashboard:
$ref: '#/components/schemas/scaleway.instance.v1.Dashboard'
x-properties-order:
- dashboard
scaleway.instance.v1.GetImageResponse:
type: object
properties:
image:
$ref: '#/components/schemas/scaleway.instance.v1.Image'
x-properties-order:
- image
scaleway.instance.v1.GetIpResponse:
type: object
properties:
ip:
$ref: '#/components/schemas/scaleway.instance.v1.Ip'
x-properties-order:
- ip
scaleway.instance.v1.GetPlacementGroupResponse:
type: object
properties:
placement_group:
$ref: '#/components/schemas/scaleway.instance.v1.PlacementGroup'
x-properties-order:
- placement_group
scaleway.instance.v1.GetPlacementGroupServersResponse:
type: object
properties:
servers:
type: array
items:
$ref: '#/components/schemas/scaleway.instance.v1.PlacementGroupServer'
x-properties-order:
- servers
scaleway.instance.v1.GetPrivateNICResponse:
type: object
properties:
private_nic:
$ref: '#/components/schemas/scaleway.instance.v1.PrivateNIC'
x-properties-order:
- private_nic
scaleway.instance.v1.GetSecurityGroupResponse:
type: object
properties:
security_group:
$ref: '#/components/schemas/scaleway.instance.v1.SecurityGroup'
x-properties-order:
- security_group
scaleway.instance.v1.GetSecurityGroupRuleResponse:
type: object
properties:
rule:
$ref: '#/components/schemas/scaleway.instance.v1.SecurityGroupRule'
x-properties-order:
- rule
scaleway.instance.v1.GetServerResponse:
type: object
properties:
server:
$ref: '#/components/schemas/scaleway.instance.v1.Server'
x-properties-order:
- server
scaleway.instance.v1.GetServerTypesAvailabilityResponse:
type: object
properties:
servers:
type: object
properties:
<serverKey>:
$ref: '#/components/schemas/scaleway.instance.v1.GetServerTypesAvailabilityResponse.Availability'
additionalProperties: true
x-properties-order:
- servers
scaleway.instance.v1.GetServerTypesAvailabilityResponse.Availability:
type: object
properties:
availability:
$ref: '#/components/schemas/scaleway.instance.v1.ServerTypesAvailability'
x-properties-order:
- availability
scaleway.instance.v1.GetSnapshotResponse:
type: object
properties:
snapshot:
$ref: '#/components/schemas/scaleway.instance.v1.Snapshot'
x-properties-order:
- snapshot
scaleway.instance.v1.GetVolumeResponse:
type: object
properties:
volume:
$ref: '#/components/schemas/scaleway.instance.v1.Volume'
x-properties-order:
- volume
scaleway.instance.v1.Image:
type: object
properties:
id:
type: string
name:
type: string
arch:
$ref: '#/components/schemas/scaleway.instance.v1.Arch'
creation_date:
$ref: '#/components/schemas/google.protobuf.Timestamp'
modification_date:
$ref: '#/components/schemas/google.protobuf.Timestamp'
default_bootscript:
$ref: '#/components/schemas/scaleway.instance.v1.Bootscript'
extra_volumes:
type: object
properties:
<extra_volumeKey>:
$ref: '#/components/schemas/scaleway.instance.v1.Volume'
additionalProperties: true
from_server:
type: string
organization:
type: string
public:
type: boolean
root_volume:
$ref: '#/components/schemas/scaleway.instance.v1.VolumeSummary'
state:
$ref: '#/components/schemas/scaleway.instance.v1.Image.State'
project:
type: string
zone:
type: string
x-properties-order:
- id
- name
- arch
- creation_date
- modification_date
- default_bootscript
- extra_volumes
- from_server
- organization
- public
- root_volume
- state
- project
- zone
scaleway.instance.v1.Image.State:
type: string
enum:
- available
- creating
- error
default: available
scaleway.instance.v1.Ip:
type: object
properties:
id:
type: string
address:
type: string
description: (IPv4 address)
example: 1.2.3.4
reverse:
$ref: '#/components/schemas/google.protobuf.StringValue'
server:
$ref: '#/components/schemas/scaleway.instance.v1.ServerSummary'
organization:
type: string
tags:
type: array
items:
type: string
project:
type: string
zone:
type: string
x-properties-order:
- id
- address
- reverse
- server
- organization
- tags
- project
- zone
scaleway.instance.v1.ListBootscriptsResponse:
type: object
properties:
bootscripts:
type: array
items:
$ref: '#/components/schemas/scaleway.instance.v1.Bootscript'
total_count:
type: number
x-properties-order:
- bootscripts
- total_count
scaleway.instance.v1.ListImagesResponse:
type: object
properties:
images:
type: array
items:
$ref: '#/components/schemas/scaleway.instance.v1.Image'
total_count:
type: number
x-properties-order:
- images
- total_count
scaleway.instance.v1.ListIpsResponse:
type: object
properties:
ips:
type: array
items:
$ref: '#/components/schemas/scaleway.instance.v1.Ip'
total_count:
type: number
x-properties-order:
- ips
- total_count
scaleway.instance.v1.ListPlacementGroupsResponse:
type: object
properties:
placement_groups:
type: array
items:
$ref: '#/components/schemas/scaleway.instance.v1.PlacementGroup'
total_count:
type: number
x-properties-order:
- placement_groups
- total_count
scaleway.instance.v1.ListPrivateNICsResponse:
type: object
properties:
private_nics:
type: array
items:
$ref: '#/components/schemas/scaleway.instance.v1.PrivateNIC'
x-properties-order:
- private_nics
scaleway.instance.v1.ListSecurityGroupRulesResponse:
type: object
properties:
rules:
type: array
items:
$ref: '#/components/schemas/scaleway.instance.v1.SecurityGroupRule'
total_count:
type: number
x-properties-order:
- rules
- total_count
scaleway.instance.v1.ListSecurityGroupsResponse:
type: object
properties:
security_groups:
type: array
items:
$ref: '#/components/schemas/scaleway.instance.v1.SecurityGroup'
total_count:
type: number
x-properties-order:
- security_groups
- total_count
scaleway.instance.v1.ListServerActionsResponse:
type: object
properties:
actions:
type: array
items:
$ref: '#/components/schemas/scaleway.instance.v1.Server.Action'
x-properties-order:
- actions
scaleway.instance.v1.ListServerUserDataResponse:
type: object
properties:
user_data:
type: array
items:
type: string
x-properties-order:
- user_data
scaleway.instance.v1.ListServersResponse:
type: object
properties:
servers:
type: array
items:
$ref: '#/components/schemas/scaleway.instance.v1.Server'
total_count:
type: number
x-properties-order:
- servers
- total_count
scaleway.instance.v1.ListServersTypesResponse:
type: object
properties:
servers:
type: object
properties:
<serverKey>:
$ref: '#/components/schemas/scaleway.instance.v1.ServerType'
additionalProperties: true
total_count:
type: number
x-properties-order:
- servers
- total_count
scaleway.instance.v1.ListSnapshotsResponse:
type: object
properties:
snapshots:
type: array
items:
$ref: '#/components/schemas/scaleway.instance.v1.Snapshot'
total_count:
type: number
x-properties-order:
- snapshots
- total_count
scaleway.instance.v1.ListVolumesResponse:
type: object
properties:
volumes:
type: array
items:
$ref: '#/components/schemas/scaleway.instance.v1.Volume'
total_count:
type: number
x-properties-order:
- volumes
- total_count
scaleway.instance.v1.ListVolumesTypesResponse:
type: object
properties:
volumes:
type: object
properties:
<volumeKey>:
$ref: '#/components/schemas/scaleway.instance.v1.VolumeType'
additionalProperties: true
total_count:
type: number
x-properties-order:
- volumes
- total_count
scaleway.instance.v1.NullableStringValue:
type: string
nullable: true
scaleway.instance.v1.PlacementGroup:
type: object
properties:
id:
type: string
description: The placement group unique ID
name:
type: string
description: The placement group name
organization:
type: string
description: The placement group organization ID
project:
type: string
description: The placement group project ID
policy_mode:
type: string
description: Select the failling mode when the placement cannot be respected,
either optional or enforced
enum:
- optional
- enforced
default: optional
policy_type:
type: string
description: Select the behavior of the placement group, either low_latency
(group) or max_availability (spread)
enum:
- max_availability
- low_latency
default: max_availability
policy_respected:
type: boolean
description: Returns true if the policy is respected, false otherwise
zone:
type: string
description: The zone in which is the placement group
x-properties-order:
- id
- name
- organization
- project
- policy_mode
- policy_type
- policy_respected
- zone
scaleway.instance.v1.PlacementGroup.PolicyMode:
type: string
enum:
- optional
- enforced
default: optional
scaleway.instance.v1.PlacementGroup.PolicyType:
type: string
enum:
- max_availability
- low_latency
default: max_availability
scaleway.instance.v1.PlacementGroupServer:
type: object
properties:
id:
type: string
name:
type: string
policy_respected:
type: boolean
x-properties-order:
- id
- name
- policy_respected
scaleway.instance.v1.PrivateNIC:
type: object
properties:
id:
type: string
description: The private NIC unique ID
server_id:
type: string
description: The server the private NIC is attached to
private_network_id:
type: string
description: The private network where the private NIC is attached
mac_address:
type: string
description: The private NIC MAC address
x-properties-order:
- id
- server_id
- private_network_id
- mac_address
scaleway.instance.v1.SecurityGroup:
type: object
properties:
id:
type: string
description: The security groups' unique ID
name:
type: string
description: The security groups name
description:
type: string
description: The security groups description
enable_default_security:
type: boolean
description: True if SMTP is blocked on IPv4 and IPv6. This feature is read
only, please open a ticket if you need to make it configurable.
inbound_default_policy:
type: string
description: The default inbound policy
enum:
- accept
- drop
default: accept
outbound_default_policy:
type: string
description: The default outbound policy
enum:
- accept
- drop
default: accept
organization:
type: string
description: The security groups organization ID
project:
type: string
description: The security group project ID
organization_default:
type: boolean
description: True if it is your default security group for this organization
ID
deprecated: true
project_default:
type: boolean
description: True if it is your default security group for this project
ID
creation_date:
type: string
description: The security group creation date
format: date-time
modification_date:
type: string
description: The security group modification date
format: date-time
servers:
type: array
description: List of servers attached to this security group
items:
$ref: '#/components/schemas/scaleway.instance.v1.ServerSummary'
stateful:
type: boolean
description: True if the security group is stateful
zone:
type: string
description: The zone in which is the security group
x-properties-order:
- id
- name
- description
- enable_default_security
- inbound_default_policy
- outbound_default_policy
- organization
- project
- organization_default
- project_default
- creation_date
- modification_date
- servers
- stateful
- zone
scaleway.instance.v1.SecurityGroupRule:
type: object
properties:
id:
type: string
protocol:
$ref: '#/components/schemas/scaleway.instance.v1.SecurityGroupRule.Protocol'
direction:
$ref: '#/components/schemas/scaleway.instance.v1.SecurityGroupRule.Direction'
action:
$ref: '#/components/schemas/scaleway.instance.v1.SecurityGroupRule.Action'
ip_range:
type: string
description: (IP network)
example: 1.2.3.4/32
dest_port_from:
$ref: '#/components/schemas/google.protobuf.UInt32Value'
dest_port_to:
$ref: '#/components/schemas/google.protobuf.UInt32Value'
position:
type: number
editable:
type: boolean
zone:
type: string
x-properties-order:
- id
- protocol
- direction
- action
- ip_range
- dest_port_from
- dest_port_to
- position
- editable