scaleway_api_rs 0.1.8

Generated library to interact with Scaleway API.
Documentation 
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

# \SnapshotsApi

All URIs are relative to *https://api.scaleway.com*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_instance_from_snapshot**](SnapshotsApi.md#create_instance_from_snapshot) | **POST** /rdb/v1/regions/{region}/snapshots/{snapshot_id}/create-instance | Create a new instance from a given snapshot
[**create_snapshot**](SnapshotsApi.md#create_snapshot) | **POST** /instance/v1/zones/{zone}/snapshots | Create a snapshot from a given volume or from a QCOW2 file
[**create_snapshot1**](SnapshotsApi.md#create_snapshot1) | **POST** /rdb/v1/regions/{region}/instances/{instance_id}/snapshots | Create an instance snapshot
[**delete_snapshot**](SnapshotsApi.md#delete_snapshot) | **DELETE** /instance/v1/zones/{zone}/snapshots/{snapshot_id} | Delete a snapshot
[**delete_snapshot1**](SnapshotsApi.md#delete_snapshot1) | **DELETE** /rdb/v1/regions/{region}/snapshots/{snapshot_id} | Delete an instance snapshot
[**export_snapshot**](SnapshotsApi.md#export_snapshot) | **POST** /instance/v1/zones/{zone}/snapshots/{snapshot_id}/export | Export a snapshot
[**get_snapshot**](SnapshotsApi.md#get_snapshot) | **GET** /instance/v1/zones/{zone}/snapshots/{snapshot_id} | Get a snapshot
[**get_snapshot1**](SnapshotsApi.md#get_snapshot1) | **GET** /rdb/v1/regions/{region}/snapshots/{snapshot_id} | Get an instance snapshot
[**list_snapshots**](SnapshotsApi.md#list_snapshots) | **GET** /instance/v1/zones/{zone}/snapshots | List snapshots
[**list_snapshots1**](SnapshotsApi.md#list_snapshots1) | **GET** /rdb/v1/regions/{region}/snapshots | List instance snapshots
[**set_snapshot**](SnapshotsApi.md#set_snapshot) | **PUT** /instance/v1/zones/{zone}/snapshots/{snapshot_id} | Update snapshot
[**update_snapshot**](SnapshotsApi.md#update_snapshot) | **PATCH** /rdb/v1/regions/{region}/snapshots/{snapshot_id} | Update an instance snapshot



## create_instance_from_snapshot

> crate::models::ScalewayPeriodRdbPeriodV1PeriodInstance create_instance_from_snapshot(region, snapshot_id, create_instance_from_snapshot_request)
Create a new instance from a given snapshot

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**region** | **String** | The region you want to target | [required] |
**snapshot_id** | **String** | Block snapshot of the instance | [required] |
**create_instance_from_snapshot_request** | [**CreateInstanceFromSnapshotRequest**](CreateInstanceFromSnapshotRequest.md) |  | [required] |

### Return type

[**crate::models::ScalewayPeriodRdbPeriodV1PeriodInstance**](scaleway.rdb.v1.Instance.md)

### Authorization

[scaleway](../README.md#scaleway)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## create_snapshot

> crate::models::ScalewayPeriodInstancePeriodV1PeriodCreateSnapshotResponse create_snapshot(zone, create_snapshot_request)
Create a snapshot from a given volume or from a QCOW2 file

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**zone** | **String** | The zone you want to target | [required] |
**create_snapshot_request** | [**CreateSnapshotRequest**](CreateSnapshotRequest.md) |  | [required] |

### Return type

[**crate::models::ScalewayPeriodInstancePeriodV1PeriodCreateSnapshotResponse**](scaleway.instance.v1.CreateSnapshotResponse.md)

### Authorization

[scaleway](../README.md#scaleway)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## create_snapshot1

> crate::models::ScalewayPeriodRdbPeriodV1PeriodSnapshot create_snapshot1(region, instance_id, create_snapshot1_request)
Create an instance snapshot

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**region** | **String** | The region you want to target | [required] |
**instance_id** | **String** | UUID of the instance | [required] |
**create_snapshot1_request** | [**CreateSnapshot1Request**](CreateSnapshot1Request.md) |  | [required] |

### Return type

[**crate::models::ScalewayPeriodRdbPeriodV1PeriodSnapshot**](scaleway.rdb.v1.Snapshot.md)

### Authorization

[scaleway](../README.md#scaleway)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## delete_snapshot

> delete_snapshot(zone, snapshot_id)
Delete a snapshot

Delete the snapshot with the given ID.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**zone** | **String** | The zone you want to target | [required] |
**snapshot_id** | **String** | UUID of the snapshot you want to delete | [required] |

### Return type

 (empty response body)

### Authorization

[scaleway](../README.md#scaleway)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## delete_snapshot1

> crate::models::ScalewayPeriodRdbPeriodV1PeriodSnapshot delete_snapshot1(region, snapshot_id)
Delete an instance snapshot

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**region** | **String** | The region you want to target | [required] |
**snapshot_id** | **String** | UUID of the snapshot to delete | [required] |

### Return type

[**crate::models::ScalewayPeriodRdbPeriodV1PeriodSnapshot**](scaleway.rdb.v1.Snapshot.md)

### Authorization

[scaleway](../README.md#scaleway)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## export_snapshot

> crate::models::ScalewayPeriodInstancePeriodV1PeriodExportSnapshotResponse export_snapshot(zone, snapshot_id, export_snapshot_request)
Export a snapshot

Export a snapshot to a given S3 bucket in the same region.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**zone** | **String** | The zone you want to target | [required] |
**snapshot_id** | **String** | The snapshot ID | [required] |
**export_snapshot_request** | [**ExportSnapshotRequest**](ExportSnapshotRequest.md) |  | [required] |

### Return type

[**crate::models::ScalewayPeriodInstancePeriodV1PeriodExportSnapshotResponse**](scaleway.instance.v1.ExportSnapshotResponse.md)

### Authorization

[scaleway](../README.md#scaleway)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_snapshot

> crate::models::ScalewayPeriodInstancePeriodV1PeriodGetSnapshotResponse get_snapshot(zone, snapshot_id)
Get a snapshot

Get details of a snapshot with the given ID.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**zone** | **String** | The zone you want to target | [required] |
**snapshot_id** | **String** | UUID of the snapshot you want to get | [required] |

### Return type

[**crate::models::ScalewayPeriodInstancePeriodV1PeriodGetSnapshotResponse**](scaleway.instance.v1.GetSnapshotResponse.md)

### Authorization

[scaleway](../README.md#scaleway)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_snapshot1

> crate::models::ScalewayPeriodRdbPeriodV1PeriodSnapshot get_snapshot1(region, snapshot_id)
Get an instance snapshot

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**region** | **String** | The region you want to target | [required] |
**snapshot_id** | **String** | UUID of the snapshot | [required] |

### Return type

[**crate::models::ScalewayPeriodRdbPeriodV1PeriodSnapshot**](scaleway.rdb.v1.Snapshot.md)

### Authorization

[scaleway](../README.md#scaleway)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_snapshots

> crate::models::ScalewayPeriodInstancePeriodV1PeriodListSnapshotsResponse list_snapshots(zone, organization, per_page, page, name, project, tags)
List snapshots

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**zone** | **String** | The zone you want to target | [required] |
**organization** | Option<**String**> |  |  |
**per_page** | Option<**i32**> |  |  |
**page** | Option<**i32**> | Page number |  |[default to 1]
**name** | Option<**String**> |  |  |
**project** | Option<**String**> |  |  |
**tags** | Option<**String**> |  |  |

### Return type

[**crate::models::ScalewayPeriodInstancePeriodV1PeriodListSnapshotsResponse**](scaleway.instance.v1.ListSnapshotsResponse.md)

### Authorization

[scaleway](../README.md#scaleway)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_snapshots1

> crate::models::ScalewayPeriodRdbPeriodV1PeriodListSnapshotsResponse list_snapshots1(region, name, order_by, instance_id, organization_id, project_id, page, page_size)
List instance snapshots

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**region** | **String** | The region you want to target | [required] |
**name** | Option<**String**> | Name of the snapshot |  |
**order_by** | Option<**String**> | Criteria to use when ordering snapshot listing |  |[default to created_at_asc]
**instance_id** | Option<**String**> | UUID of the instance |  |
**organization_id** | Option<**String**> | Organization ID the snapshots belongs to |  |
**project_id** | Option<**String**> | Project ID the snapshots belongs to |  |
**page** | Option<**i32**> | Page number |  |[default to 1]
**page_size** | Option<**i32**> | Page size |  |[default to 20]

### Return type

[**crate::models::ScalewayPeriodRdbPeriodV1PeriodListSnapshotsResponse**](scaleway.rdb.v1.ListSnapshotsResponse.md)

### Authorization

[scaleway](../README.md#scaleway)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## set_snapshot

> crate::models::ScalewayPeriodInstancePeriodV1PeriodSetSnapshotResponse set_snapshot(zone, snapshot_id, set_snapshot_request)
Update snapshot

Replace all snapshot properties with a snapshot message.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**zone** | **String** | The zone you want to target | [required] |
**snapshot_id** | **String** |  | [required] |
**set_snapshot_request** | [**SetSnapshotRequest**](SetSnapshotRequest.md) |  | [required] |

### Return type

[**crate::models::ScalewayPeriodInstancePeriodV1PeriodSetSnapshotResponse**](scaleway.instance.v1.SetSnapshotResponse.md)

### Authorization

[scaleway](../README.md#scaleway)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## update_snapshot

> crate::models::ScalewayPeriodRdbPeriodV1PeriodSnapshot update_snapshot(region, snapshot_id, update_snapshot_request)
Update an instance snapshot

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**region** | **String** | The region you want to target | [required] |
**snapshot_id** | **String** | UUID of the snapshot to update | [required] |
**update_snapshot_request** | [**UpdateSnapshotRequest**](UpdateSnapshotRequest.md) |  | [required] |

### Return type

[**crate::models::ScalewayPeriodRdbPeriodV1PeriodSnapshot**](scaleway.rdb.v1.Snapshot.md)

### Authorization

[scaleway](../README.md#scaleway)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)