@scaleway/sdk 1.5.0 → 1.6.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/api/applesilicon/v1alpha1/api.gen.js +1 -1
- package/dist/api/baremetal/v1/api.gen.js +2 -2
- package/dist/api/cockpit/v1beta1/api.gen.js +51 -1
- package/dist/api/cockpit/v1beta1/marshalling.gen.js +44 -1
- package/dist/api/container/v1beta1/api.gen.js +1 -1
- package/dist/api/flexibleip/v1alpha1/api.gen.js +1 -1
- package/dist/api/function/v1beta1/api.gen.js +1 -1
- package/dist/api/function/v1beta1/marshalling.gen.js +0 -20
- package/dist/api/iam/v1alpha1/validation-rules.gen.js +10 -10
- package/dist/api/instance/v1/api.gen.js +86 -67
- package/dist/api/iot/v1/api.gen.js +1 -1
- package/dist/api/k8s/v1/api.gen.js +1 -1
- package/dist/api/lb/v1/api.gen.js +2 -2
- package/dist/api/lb/v1/marshalling.gen.js +33 -19
- package/dist/api/mnq/v1alpha1/api.gen.js +1 -1
- package/dist/api/rdb/v1/api.gen.js +1 -1
- package/dist/api/redis/v1/api.gen.js +1 -1
- package/dist/api/redis/v1/marshalling.gen.js +2 -0
- package/dist/api/registry/v1/api.gen.js +1 -1
- package/dist/api/secret/v1alpha1/api.gen.js +1 -1
- package/dist/api/secret/v1alpha1/marshalling.gen.js +14 -2
- package/dist/api/tem/v1alpha1/api.gen.js +1 -1
- package/dist/api/vpc/v1/api.gen.js +2 -2
- package/dist/api/vpcgw/v1/api.gen.js +1 -1
- package/dist/api/webhosting/v1alpha1/api.gen.js +1 -1
- package/dist/index.cjs +276 -121
- package/dist/index.d.ts +669 -504
- package/dist/internal/async/interval-retrier.js +6 -0
- package/dist/internal/logger/level-resolver.js +3 -3
- package/dist/scw/client-ini-factory.js +6 -0
- package/dist/scw/client-ini-profile.js +18 -0
- package/dist/scw/client-settings.js +12 -0
- package/dist/scw/constants.js +1 -1
- package/dist/scw/errors/standard/quotas-exceeded-error.js +6 -0
- package/package.json +2 -2
|
@@ -15,7 +15,7 @@ class API extends API$1 {
|
|
|
15
15
|
super(...arguments);
|
|
16
16
|
_this = this;
|
|
17
17
|
/**
|
|
18
|
-
* Get availability. Get availability for all
|
|
18
|
+
* Get availability. Get availability for all Instance types.
|
|
19
19
|
*
|
|
20
20
|
* @param request - The request {@link GetServerTypesAvailabilityRequest}
|
|
21
21
|
* @returns A Promise of GetServerTypesAvailabilityResponse
|
|
@@ -31,7 +31,8 @@ class API extends API$1 {
|
|
|
31
31
|
}, unmarshalGetServerTypesAvailabilityResponse);
|
|
32
32
|
};
|
|
33
33
|
/**
|
|
34
|
-
* List
|
|
34
|
+
* List Instance types. List available Instance types and their technical
|
|
35
|
+
* details.
|
|
35
36
|
*
|
|
36
37
|
* @param request - The request {@link ListServersTypesRequest}
|
|
37
38
|
* @returns A Promise of ListServersTypesResponse
|
|
@@ -47,7 +48,7 @@ class API extends API$1 {
|
|
|
47
48
|
}, unmarshalListServersTypesResponse);
|
|
48
49
|
};
|
|
49
50
|
/**
|
|
50
|
-
* List volumes types.
|
|
51
|
+
* List volumes types. List all volume types and their technical details.
|
|
51
52
|
*
|
|
52
53
|
* @param request - The request {@link ListVolumesTypesRequest}
|
|
53
54
|
* @returns A Promise of ListVolumesTypesResponse
|
|
@@ -73,7 +74,8 @@ class API extends API$1 {
|
|
|
73
74
|
}, unmarshalListServersResponse);
|
|
74
75
|
};
|
|
75
76
|
/**
|
|
76
|
-
* List all
|
|
77
|
+
* List all Instances. List all Instances in a specified Availability Zone,
|
|
78
|
+
* e.g. `fr-par-1`.
|
|
77
79
|
*
|
|
78
80
|
* @param request - The request {@link ListServersRequest}
|
|
79
81
|
* @returns A Promise of ListServersResponse
|
|
@@ -91,7 +93,7 @@ class API extends API$1 {
|
|
|
91
93
|
path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers`
|
|
92
94
|
}, unmarshalCreateServerResponse);
|
|
93
95
|
/**
|
|
94
|
-
* Delete
|
|
96
|
+
* Delete an Instance. Delete the Instance with the specified ID.
|
|
95
97
|
*
|
|
96
98
|
* @param request - The request {@link DeleteServerRequest}
|
|
97
99
|
*/
|
|
@@ -100,7 +102,7 @@ class API extends API$1 {
|
|
|
100
102
|
path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}`
|
|
101
103
|
});
|
|
102
104
|
/**
|
|
103
|
-
* Get
|
|
105
|
+
* Get an Instance. Get the details of a specified Instance.
|
|
104
106
|
*
|
|
105
107
|
* @param request - The request {@link GetServerRequest}
|
|
106
108
|
* @returns A Promise of GetServerResponse
|
|
@@ -122,8 +124,8 @@ class API extends API$1 {
|
|
|
122
124
|
path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}`
|
|
123
125
|
}, unmarshalUpdateServerResponse);
|
|
124
126
|
/**
|
|
125
|
-
* List
|
|
126
|
-
*
|
|
127
|
+
* List Instance actions. List all actions (e.g. power on, power off, reboot)
|
|
128
|
+
* that can currently be performed on an Instance.
|
|
127
129
|
*
|
|
128
130
|
* @param request - The request {@link ListServerActionsRequest}
|
|
129
131
|
* @returns A Promise of ListServerActionsResponse
|
|
@@ -133,13 +135,19 @@ class API extends API$1 {
|
|
|
133
135
|
path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}/action`
|
|
134
136
|
}, unmarshalListServerActionsResponse);
|
|
135
137
|
/**
|
|
136
|
-
* Perform action. Perform
|
|
137
|
-
*
|
|
138
|
-
*
|
|
139
|
-
*
|
|
140
|
-
*
|
|
141
|
-
* `terminate
|
|
142
|
-
*
|
|
138
|
+
* Perform action. Perform an action on an Instance. Available actions are:
|
|
139
|
+
* `poweron`: Start a stopped Instance. `poweroff`: Fully stop the Instance
|
|
140
|
+
* and release the hypervisor slot. `stop_in_place`: Stop the Instance, but
|
|
141
|
+
* keep the slot on the hypervisor. `reboot`: Stop the instance and restart
|
|
142
|
+
* it. `backup`: Create an image with all the volumes of an Instance.
|
|
143
|
+
* `terminate`: Delete the Instance along with all attached volumes.
|
|
144
|
+
*
|
|
145
|
+
* Keep in mind that terminating an Instance will result in the deletion of
|
|
146
|
+
* all attached volumes, including local and block storage. If you want to
|
|
147
|
+
* preserve your local volumes, you should use the `archive` action instead of
|
|
148
|
+
* `terminate`. Similarly, if you want to keep your block storage volumes, you
|
|
149
|
+
* must first detach them before issuing the `terminate` command. For more
|
|
150
|
+
* information, read the [Volumes](#volumes-7e8a39) documentation.
|
|
143
151
|
*
|
|
144
152
|
* @param request - The request {@link ServerActionRequest}
|
|
145
153
|
* @returns A Promise of ServerActionResponse
|
|
@@ -151,7 +159,7 @@ class API extends API$1 {
|
|
|
151
159
|
path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}/action`
|
|
152
160
|
}, unmarshalServerActionResponse);
|
|
153
161
|
/**
|
|
154
|
-
* List user data. List all user data keys registered on a
|
|
162
|
+
* List user data. List all user data keys registered on a specified Instance.
|
|
155
163
|
*
|
|
156
164
|
* @param request - The request {@link ListServerUserDataRequest}
|
|
157
165
|
* @returns A Promise of ListServerUserDataResponse
|
|
@@ -161,7 +169,7 @@ class API extends API$1 {
|
|
|
161
169
|
path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}/user_data`
|
|
162
170
|
}, unmarshalListServerUserDataResponse);
|
|
163
171
|
/**
|
|
164
|
-
* Delete user data. Delete the
|
|
172
|
+
* Delete user data. Delete the specified key from an Instance's user data.
|
|
165
173
|
*
|
|
166
174
|
* @param request - The request {@link DeleteServerUserDataRequest}
|
|
167
175
|
*/
|
|
@@ -180,7 +188,7 @@ class API extends API$1 {
|
|
|
180
188
|
}, unmarshalListImagesResponse);
|
|
181
189
|
};
|
|
182
190
|
/**
|
|
183
|
-
* List
|
|
191
|
+
* List Instance images. List all existing Instance images.
|
|
184
192
|
*
|
|
185
193
|
* @param request - The request {@link ListImagesRequest}
|
|
186
194
|
* @returns A Promise of ListImagesResponse
|
|
@@ -192,7 +200,7 @@ class API extends API$1 {
|
|
|
192
200
|
return enrichForPagination('images', _this.pageOfListImages, request);
|
|
193
201
|
};
|
|
194
202
|
/**
|
|
195
|
-
* Get an
|
|
203
|
+
* Get an Instance image. Get details of an image with the specified ID.
|
|
196
204
|
*
|
|
197
205
|
* @param request - The request {@link GetImageRequest}
|
|
198
206
|
* @returns A Promise of GetImageResponse
|
|
@@ -202,7 +210,8 @@ class API extends API$1 {
|
|
|
202
210
|
path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/images/${validatePathParam('imageId', request.imageId)}`
|
|
203
211
|
}, unmarshalGetImageResponse);
|
|
204
212
|
/**
|
|
205
|
-
* Create an
|
|
213
|
+
* Create an Instance image. Create an Instance image from the specified
|
|
214
|
+
* snapshot ID.
|
|
206
215
|
*
|
|
207
216
|
* @param request - The request {@link CreateImageRequest}
|
|
208
217
|
* @returns A Promise of CreateImageResponse
|
|
@@ -220,7 +229,7 @@ class API extends API$1 {
|
|
|
220
229
|
path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/images/${validatePathParam('id', request.id)}`
|
|
221
230
|
}, unmarshalSetImageResponse);
|
|
222
231
|
/**
|
|
223
|
-
* Delete an
|
|
232
|
+
* Delete an Instance image. Delete the image with the specified ID.
|
|
224
233
|
*
|
|
225
234
|
* @param request - The request {@link DeleteImageRequest}
|
|
226
235
|
*/
|
|
@@ -239,7 +248,8 @@ class API extends API$1 {
|
|
|
239
248
|
}, unmarshalListSnapshotsResponse);
|
|
240
249
|
};
|
|
241
250
|
/**
|
|
242
|
-
* List snapshots.
|
|
251
|
+
* List snapshots. List all snapshots of an Organization in a specified
|
|
252
|
+
* Availability Zone.
|
|
243
253
|
*
|
|
244
254
|
* @param request - The request {@link ListSnapshotsRequest}
|
|
245
255
|
* @returns A Promise of ListSnapshotsResponse
|
|
@@ -251,7 +261,9 @@ class API extends API$1 {
|
|
|
251
261
|
return enrichForPagination('snapshots', _this.pageOfListSnapshots, request);
|
|
252
262
|
};
|
|
253
263
|
/**
|
|
254
|
-
* Create a snapshot from a
|
|
264
|
+
* Create a snapshot from a specified volume or from a QCOW2 file. Create a
|
|
265
|
+
* snapshot from a specified volume or from a QCOW2 file in a specified
|
|
266
|
+
* Availability Zone.
|
|
255
267
|
*
|
|
256
268
|
* @param request - The request {@link CreateSnapshotRequest}
|
|
257
269
|
* @returns A Promise of CreateSnapshotResponse
|
|
@@ -268,7 +280,7 @@ class API extends API$1 {
|
|
|
268
280
|
}, unmarshalCreateSnapshotResponse);
|
|
269
281
|
};
|
|
270
282
|
/**
|
|
271
|
-
* Get a snapshot. Get details of a snapshot with the
|
|
283
|
+
* Get a snapshot. Get details of a snapshot with the specified ID.
|
|
272
284
|
*
|
|
273
285
|
* @param request - The request {@link GetSnapshotRequest}
|
|
274
286
|
* @returns A Promise of GetSnapshotResponse
|
|
@@ -284,7 +296,7 @@ class API extends API$1 {
|
|
|
284
296
|
path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/snapshots/${validatePathParam('snapshotId', request.snapshotId)}`
|
|
285
297
|
}, unmarshalSetSnapshotResponse);
|
|
286
298
|
/**
|
|
287
|
-
* Delete a snapshot. Delete the snapshot with the
|
|
299
|
+
* Delete a snapshot. Delete the snapshot with the specified ID.
|
|
288
300
|
*
|
|
289
301
|
* @param request - The request {@link DeleteSnapshotRequest}
|
|
290
302
|
*/
|
|
@@ -293,7 +305,7 @@ class API extends API$1 {
|
|
|
293
305
|
path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/snapshots/${validatePathParam('snapshotId', request.snapshotId)}`
|
|
294
306
|
});
|
|
295
307
|
/**
|
|
296
|
-
* Export a snapshot. Export a snapshot to a
|
|
308
|
+
* Export a snapshot. Export a snapshot to a specified S3 bucket in the same
|
|
297
309
|
* region.
|
|
298
310
|
*
|
|
299
311
|
* @param request - The request {@link ExportSnapshotRequest}
|
|
@@ -316,7 +328,8 @@ class API extends API$1 {
|
|
|
316
328
|
}, unmarshalListVolumesResponse);
|
|
317
329
|
};
|
|
318
330
|
/**
|
|
319
|
-
* List volumes.
|
|
331
|
+
* List volumes. List volumes in the specified Availability Zone. You can
|
|
332
|
+
* filter the output by volume type.
|
|
320
333
|
*
|
|
321
334
|
* @param request - The request {@link ListVolumesRequest}
|
|
322
335
|
* @returns A Promise of ListVolumesResponse
|
|
@@ -328,7 +341,8 @@ class API extends API$1 {
|
|
|
328
341
|
return enrichForPagination('volumes', _this.pageOfListVolumes, request);
|
|
329
342
|
};
|
|
330
343
|
/**
|
|
331
|
-
* Create a volume.
|
|
344
|
+
* Create a volume. Create a volume of a specified type in an Availability
|
|
345
|
+
* Zone.
|
|
332
346
|
*
|
|
333
347
|
* @param request - The request {@link CreateVolumeRequest}
|
|
334
348
|
* @returns A Promise of CreateVolumeResponse
|
|
@@ -345,7 +359,7 @@ class API extends API$1 {
|
|
|
345
359
|
}, unmarshalCreateVolumeResponse);
|
|
346
360
|
};
|
|
347
361
|
/**
|
|
348
|
-
* Get a volume. Get details of a volume with the
|
|
362
|
+
* Get a volume. Get details of a volume with the specified ID.
|
|
349
363
|
*
|
|
350
364
|
* @param request - The request {@link GetVolumeRequest}
|
|
351
365
|
* @returns A Promise of GetVolumeResponse
|
|
@@ -355,9 +369,9 @@ class API extends API$1 {
|
|
|
355
369
|
path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/volumes/${validatePathParam('volumeId', request.volumeId)}`
|
|
356
370
|
}, unmarshalGetVolumeResponse);
|
|
357
371
|
/**
|
|
358
|
-
* Update a volume. Replace name and/or size properties of
|
|
359
|
-
* with the
|
|
360
|
-
* only `b_ssd`
|
|
372
|
+
* Update a volume. Replace the name and/or size properties of a volume
|
|
373
|
+
* specified by its ID, with the specified value(s). Any volume name can be
|
|
374
|
+
* changed, however only `b_ssd` volumes can currently be increased in size.
|
|
361
375
|
*
|
|
362
376
|
* @param request - The request {@link UpdateVolumeRequest}
|
|
363
377
|
* @returns A Promise of UpdateVolumeResponse
|
|
@@ -369,7 +383,7 @@ class API extends API$1 {
|
|
|
369
383
|
path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/volumes/${validatePathParam('volumeId', request.volumeId)}`
|
|
370
384
|
}, unmarshalUpdateVolumeResponse);
|
|
371
385
|
/**
|
|
372
|
-
* Delete a volume. Delete the volume with the
|
|
386
|
+
* Delete a volume. Delete the volume with the specified ID.
|
|
373
387
|
*
|
|
374
388
|
* @param request - The request {@link DeleteVolumeRequest}
|
|
375
389
|
*/
|
|
@@ -388,7 +402,7 @@ class API extends API$1 {
|
|
|
388
402
|
}, unmarshalListSecurityGroupsResponse);
|
|
389
403
|
};
|
|
390
404
|
/**
|
|
391
|
-
* List security groups. List all security groups
|
|
405
|
+
* List security groups. List all existing security groups.
|
|
392
406
|
*
|
|
393
407
|
* @param request - The request {@link ListSecurityGroupsRequest}
|
|
394
408
|
* @returns A Promise of ListSecurityGroupsResponse
|
|
@@ -400,7 +414,8 @@ class API extends API$1 {
|
|
|
400
414
|
return enrichForPagination('securityGroups', _this.pageOfListSecurityGroups, request);
|
|
401
415
|
};
|
|
402
416
|
/**
|
|
403
|
-
* Create a security group.
|
|
417
|
+
* Create a security group. Create a security group with a specified name and
|
|
418
|
+
* description.
|
|
404
419
|
*
|
|
405
420
|
* @param request - The request {@link CreateSecurityGroupRequest}
|
|
406
421
|
* @returns A Promise of CreateSecurityGroupResponse
|
|
@@ -412,8 +427,8 @@ class API extends API$1 {
|
|
|
412
427
|
path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/security_groups`
|
|
413
428
|
}, unmarshalCreateSecurityGroupResponse);
|
|
414
429
|
/**
|
|
415
|
-
* Get a security group. Get the details of a
|
|
416
|
-
* ID.
|
|
430
|
+
* Get a security group. Get the details of a security group with the
|
|
431
|
+
* specified ID.
|
|
417
432
|
*
|
|
418
433
|
* @param request - The request {@link GetSecurityGroupRequest}
|
|
419
434
|
* @returns A Promise of GetSecurityGroupResponse
|
|
@@ -423,7 +438,7 @@ class API extends API$1 {
|
|
|
423
438
|
path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/security_groups/${validatePathParam('securityGroupId', request.securityGroupId)}`
|
|
424
439
|
}, unmarshalGetSecurityGroupResponse);
|
|
425
440
|
/**
|
|
426
|
-
* Delete a security group.
|
|
441
|
+
* Delete a security group. Delete a security group with the specified ID.
|
|
427
442
|
*
|
|
428
443
|
* @param request - The request {@link DeleteSecurityGroupRequest}
|
|
429
444
|
*/
|
|
@@ -459,14 +474,14 @@ class API extends API$1 {
|
|
|
459
474
|
urlParams: urlParams(['page', request.page], ['per_page', request.perPage ?? this.client.settings.defaultPageSize])
|
|
460
475
|
}, unmarshalListSecurityGroupRulesResponse);
|
|
461
476
|
/**
|
|
462
|
-
* List rules.
|
|
477
|
+
* List rules. List the rules of the a specified security group ID.
|
|
463
478
|
*
|
|
464
479
|
* @param request - The request {@link ListSecurityGroupRulesRequest}
|
|
465
480
|
* @returns A Promise of ListSecurityGroupRulesResponse
|
|
466
481
|
*/
|
|
467
482
|
this.listSecurityGroupRules = request => enrichForPagination('rules', this.pageOfListSecurityGroupRules, request);
|
|
468
483
|
/**
|
|
469
|
-
* Create rule.
|
|
484
|
+
* Create rule. Create a rule in the specified security group ID.
|
|
470
485
|
*
|
|
471
486
|
* @param request - The request {@link CreateSecurityGroupRuleRequest}
|
|
472
487
|
* @returns A Promise of CreateSecurityGroupRuleResponse
|
|
@@ -478,10 +493,10 @@ class API extends API$1 {
|
|
|
478
493
|
path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/security_groups/${validatePathParam('securityGroupId', request.securityGroupId)}/rules`
|
|
479
494
|
}, unmarshalCreateSecurityGroupRuleResponse);
|
|
480
495
|
/**
|
|
481
|
-
* Update all the rules of a security group. Replaces the rules of
|
|
482
|
-
* security group with the rules provided. This endpoint supports the
|
|
483
|
-
* of existing rules, creation of new rules and deletion of existing
|
|
484
|
-
* when they are not passed in the request.
|
|
496
|
+
* Update all the rules of a security group. Replaces the existing rules of
|
|
497
|
+
* the security group with the rules provided. This endpoint supports the
|
|
498
|
+
* update of existing rules, creation of new rules and deletion of existing
|
|
499
|
+
* rules when they are not passed in the request.
|
|
485
500
|
*
|
|
486
501
|
* @param request - The request {@link SetSecurityGroupRulesRequest}
|
|
487
502
|
* @returns A Promise of SetSecurityGroupRulesResponse
|
|
@@ -493,7 +508,7 @@ class API extends API$1 {
|
|
|
493
508
|
path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/security_groups/${validatePathParam('securityGroupId', request.securityGroupId)}/rules`
|
|
494
509
|
}, unmarshalSetSecurityGroupRulesResponse);
|
|
495
510
|
/**
|
|
496
|
-
* Delete rule. Delete a security group rule with the
|
|
511
|
+
* Delete rule. Delete a security group rule with the specified ID.
|
|
497
512
|
*
|
|
498
513
|
* @param request - The request {@link DeleteSecurityGroupRuleRequest}
|
|
499
514
|
*/
|
|
@@ -502,7 +517,7 @@ class API extends API$1 {
|
|
|
502
517
|
path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/security_groups/${validatePathParam('securityGroupId', request.securityGroupId)}/rules/${validatePathParam('securityGroupRuleId', request.securityGroupRuleId)}`
|
|
503
518
|
});
|
|
504
519
|
/**
|
|
505
|
-
* Get rule. Get details of a security group rule with the
|
|
520
|
+
* Get rule. Get details of a security group rule with the specified ID.
|
|
506
521
|
*
|
|
507
522
|
* @param request - The request {@link GetSecurityGroupRuleRequest}
|
|
508
523
|
* @returns A Promise of GetSecurityGroupRuleResponse
|
|
@@ -528,7 +543,8 @@ class API extends API$1 {
|
|
|
528
543
|
}, unmarshalListPlacementGroupsResponse);
|
|
529
544
|
};
|
|
530
545
|
/**
|
|
531
|
-
* List placement groups. List all placement groups
|
|
546
|
+
* List placement groups. List all placement groups in a specified
|
|
547
|
+
* Availability Zone.
|
|
532
548
|
*
|
|
533
549
|
* @param request - The request {@link ListPlacementGroupsRequest}
|
|
534
550
|
* @returns A Promise of ListPlacementGroupsResponse
|
|
@@ -540,7 +556,8 @@ class API extends API$1 {
|
|
|
540
556
|
return enrichForPagination('placementGroups', _this.pageOfListPlacementGroups, request);
|
|
541
557
|
};
|
|
542
558
|
/**
|
|
543
|
-
* Create a placement group. Create a new placement group
|
|
559
|
+
* Create a placement group. Create a new placement group in a specified
|
|
560
|
+
* Availability Zone.
|
|
544
561
|
*
|
|
545
562
|
* @param request - The request {@link CreatePlacementGroupRequest}
|
|
546
563
|
* @returns A Promise of CreatePlacementGroupResponse
|
|
@@ -557,7 +574,7 @@ class API extends API$1 {
|
|
|
557
574
|
}, unmarshalCreatePlacementGroupResponse);
|
|
558
575
|
};
|
|
559
576
|
/**
|
|
560
|
-
* Get a placement group. Get the
|
|
577
|
+
* Get a placement group. Get the specified placement group.
|
|
561
578
|
*
|
|
562
579
|
* @param request - The request {@link GetPlacementGroupRequest}
|
|
563
580
|
* @returns A Promise of GetPlacementGroupResponse
|
|
@@ -567,7 +584,7 @@ class API extends API$1 {
|
|
|
567
584
|
path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/placement_groups/${validatePathParam('placementGroupId', request.placementGroupId)}`
|
|
568
585
|
}, unmarshalGetPlacementGroupResponse);
|
|
569
586
|
/**
|
|
570
|
-
* Set placement group. Set all parameters of the
|
|
587
|
+
* Set placement group. Set all parameters of the specified placement group.
|
|
571
588
|
*
|
|
572
589
|
* @param request - The request {@link SetPlacementGroupRequest}
|
|
573
590
|
* @returns A Promise of SetPlacementGroupResponse
|
|
@@ -579,7 +596,7 @@ class API extends API$1 {
|
|
|
579
596
|
path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/placement_groups/${validatePathParam('placementGroupId', request.placementGroupId)}`
|
|
580
597
|
}, unmarshalSetPlacementGroupResponse);
|
|
581
598
|
/**
|
|
582
|
-
* Update a placement group. Update one or more parameter of the
|
|
599
|
+
* Update a placement group. Update one or more parameter of the specified
|
|
583
600
|
* placement group.
|
|
584
601
|
*
|
|
585
602
|
* @param request - The request {@link UpdatePlacementGroupRequest}
|
|
@@ -592,7 +609,7 @@ class API extends API$1 {
|
|
|
592
609
|
path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/placement_groups/${validatePathParam('placementGroupId', request.placementGroupId)}`
|
|
593
610
|
}, unmarshalUpdatePlacementGroupResponse);
|
|
594
611
|
/**
|
|
595
|
-
* Delete the
|
|
612
|
+
* Delete the specified placement group.
|
|
596
613
|
*
|
|
597
614
|
* @param request - The request {@link DeletePlacementGroupRequest}
|
|
598
615
|
*/
|
|
@@ -601,7 +618,7 @@ class API extends API$1 {
|
|
|
601
618
|
path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/placement_groups/${validatePathParam('placementGroupId', request.placementGroupId)}`
|
|
602
619
|
});
|
|
603
620
|
/**
|
|
604
|
-
* Get placement group servers. Get all
|
|
621
|
+
* Get placement group servers. Get all Instances belonging to the specified
|
|
605
622
|
* placement group.
|
|
606
623
|
*
|
|
607
624
|
* @param request - The request {@link GetPlacementGroupServersRequest}
|
|
@@ -612,7 +629,7 @@ class API extends API$1 {
|
|
|
612
629
|
path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/placement_groups/${validatePathParam('placementGroupId', request.placementGroupId)}/servers`
|
|
613
630
|
}, unmarshalGetPlacementGroupServersResponse);
|
|
614
631
|
/**
|
|
615
|
-
* Set placement group servers. Set all
|
|
632
|
+
* Set placement group servers. Set all Instances belonging to the specified
|
|
616
633
|
* placement group.
|
|
617
634
|
*
|
|
618
635
|
* @param request - The request {@link SetPlacementGroupServersRequest}
|
|
@@ -625,8 +642,8 @@ class API extends API$1 {
|
|
|
625
642
|
path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/placement_groups/${validatePathParam('placementGroupId', request.placementGroupId)}/servers`
|
|
626
643
|
}, unmarshalSetPlacementGroupServersResponse);
|
|
627
644
|
/**
|
|
628
|
-
* Update placement group servers. Update all
|
|
629
|
-
* placement group.
|
|
645
|
+
* Update placement group servers. Update all Instances belonging to the
|
|
646
|
+
* specified placement group.
|
|
630
647
|
*
|
|
631
648
|
* @param request - The request {@link UpdatePlacementGroupServersRequest}
|
|
632
649
|
* @returns A Promise of UpdatePlacementGroupServersResponse
|
|
@@ -648,7 +665,7 @@ class API extends API$1 {
|
|
|
648
665
|
}, unmarshalListIpsResponse);
|
|
649
666
|
};
|
|
650
667
|
/**
|
|
651
|
-
* List all flexible IPs.
|
|
668
|
+
* List all flexible IPs. List all flexible IPs in a specified zone.
|
|
652
669
|
*
|
|
653
670
|
* @param request - The request {@link ListIpsRequest}
|
|
654
671
|
* @returns A Promise of ListIpsResponse
|
|
@@ -660,7 +677,8 @@ class API extends API$1 {
|
|
|
660
677
|
return enrichForPagination('ips', _this.pageOfListIps, request);
|
|
661
678
|
};
|
|
662
679
|
/**
|
|
663
|
-
* Reserve a flexible IP.
|
|
680
|
+
* Reserve a flexible IP. Reserve a flexible IP and attach it to the specified
|
|
681
|
+
* Instance.
|
|
664
682
|
*
|
|
665
683
|
* @param request - The request {@link CreateIpRequest}
|
|
666
684
|
* @returns A Promise of CreateIpResponse
|
|
@@ -677,7 +695,7 @@ class API extends API$1 {
|
|
|
677
695
|
}, unmarshalCreateIpResponse);
|
|
678
696
|
};
|
|
679
697
|
/**
|
|
680
|
-
* Get a flexible IP. Get details of an IP with the
|
|
698
|
+
* Get a flexible IP. Get details of an IP with the specified ID or address.
|
|
681
699
|
*
|
|
682
700
|
* @param request - The request {@link GetIpRequest}
|
|
683
701
|
* @returns A Promise of GetIpResponse
|
|
@@ -687,7 +705,8 @@ class API extends API$1 {
|
|
|
687
705
|
path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/ips/${validatePathParam('ip', request.ip)}`
|
|
688
706
|
}, unmarshalGetIpResponse);
|
|
689
707
|
/**
|
|
690
|
-
* Update a flexible IP.
|
|
708
|
+
* Update a flexible IP. Update a flexible IP in the specified zone with the
|
|
709
|
+
* specified ID.
|
|
691
710
|
*
|
|
692
711
|
* @param request - The request {@link UpdateIpRequest}
|
|
693
712
|
* @returns A Promise of UpdateIpResponse
|
|
@@ -699,7 +718,7 @@ class API extends API$1 {
|
|
|
699
718
|
path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/ips/${validatePathParam('ip', request.ip)}`
|
|
700
719
|
}, unmarshalUpdateIpResponse);
|
|
701
720
|
/**
|
|
702
|
-
* Delete a flexible IP. Delete the IP with the
|
|
721
|
+
* Delete a flexible IP. Delete the IP with the specified ID.
|
|
703
722
|
*
|
|
704
723
|
* @param request - The request {@link DeleteIpRequest}
|
|
705
724
|
*/
|
|
@@ -713,14 +732,14 @@ class API extends API$1 {
|
|
|
713
732
|
urlParams: urlParams(['page', request.page], ['per_page', request.perPage ?? this.client.settings.defaultPageSize], ['tags', request.tags && request.tags.length > 0 ? request.tags.join(',') : undefined])
|
|
714
733
|
}, unmarshalListPrivateNICsResponse);
|
|
715
734
|
/**
|
|
716
|
-
* List all private NICs. List all private NICs of a
|
|
735
|
+
* List all private NICs. List all private NICs of a specified Instance.
|
|
717
736
|
*
|
|
718
737
|
* @param request - The request {@link ListPrivateNICsRequest}
|
|
719
738
|
* @returns A Promise of ListPrivateNICsResponse
|
|
720
739
|
*/
|
|
721
740
|
this.listPrivateNICs = request => enrichForPagination('privateNics', this.pageOfListPrivateNICs, request);
|
|
722
741
|
/**
|
|
723
|
-
* Create a private NIC connecting
|
|
742
|
+
* Create a private NIC connecting an Instance to a Private Network.
|
|
724
743
|
*
|
|
725
744
|
* @param request - The request {@link CreatePrivateNICRequest}
|
|
726
745
|
* @returns A Promise of CreatePrivateNICResponse
|
|
@@ -742,8 +761,8 @@ class API extends API$1 {
|
|
|
742
761
|
path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}/private_nics/${validatePathParam('privateNicId', request.privateNicId)}`
|
|
743
762
|
}, unmarshalGetPrivateNICResponse);
|
|
744
763
|
/**
|
|
745
|
-
* Update a private NIC. Update one or more parameter
|
|
746
|
-
* NIC.
|
|
764
|
+
* Update a private NIC. Update one or more parameter(s) of a specified
|
|
765
|
+
* private NIC.
|
|
747
766
|
*
|
|
748
767
|
* @param request - The request {@link UpdatePrivateNICRequest}
|
|
749
768
|
* @returns A Promise of PrivateNIC
|
|
@@ -787,7 +806,7 @@ class API extends API$1 {
|
|
|
787
806
|
return enrichForPagination('bootscripts', _this.pageOfListBootscripts, request);
|
|
788
807
|
};
|
|
789
808
|
/**
|
|
790
|
-
* Get bootscripts. Get details of a bootscript with the
|
|
809
|
+
* Get bootscripts. Get details of a bootscript with the specified ID.
|
|
791
810
|
*
|
|
792
811
|
* @deprecated
|
|
793
812
|
* @param request - The request {@link GetBootscriptRequest}
|
|
@@ -808,8 +827,8 @@ class API extends API$1 {
|
|
|
808
827
|
}, unmarshalGetDashboardResponse);
|
|
809
828
|
};
|
|
810
829
|
}
|
|
830
|
+
/** Lists the available zones of the API. */
|
|
811
831
|
}
|
|
812
|
-
/** Lists the available zones of the API. */
|
|
813
832
|
API.LOCALITIES = ['fr-par-1', 'fr-par-2', 'fr-par-3', 'nl-ams-1', 'nl-ams-2', 'pl-waw-1', 'pl-waw-2'];
|
|
814
833
|
|
|
815
834
|
export { API };
|
|
@@ -477,8 +477,8 @@ class API extends API$1 {
|
|
|
477
477
|
path: `/iot/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/twins/${validatePathParam('twinId', request.twinId)}`
|
|
478
478
|
});
|
|
479
479
|
}
|
|
480
|
+
/** Lists the available regions of the API. */
|
|
480
481
|
}
|
|
481
|
-
/** Lists the available regions of the API. */
|
|
482
482
|
API.LOCALITIES = ['fr-par'];
|
|
483
483
|
|
|
484
484
|
export { API };
|
|
@@ -363,8 +363,8 @@ class API extends API$1 {
|
|
|
363
363
|
path: `/k8s/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/versions/${validatePathParam('versionName', request.versionName)}`
|
|
364
364
|
}, unmarshalVersion);
|
|
365
365
|
}
|
|
366
|
+
/** Lists the available regions of the API. */
|
|
366
367
|
}
|
|
367
|
-
/** Lists the available regions of the API. */
|
|
368
368
|
API.LOCALITIES = ['fr-par', 'nl-ams', 'pl-waw'];
|
|
369
369
|
|
|
370
370
|
export { API };
|
|
@@ -670,6 +670,7 @@ class API extends API$1 {
|
|
|
670
670
|
path: `/lb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/lbs/${validatePathParam('lbId', request.lbId)}/private-networks/${validatePathParam('privateNetworkId', request.privateNetworkId)}/detach`
|
|
671
671
|
});
|
|
672
672
|
}
|
|
673
|
+
/** Lists the available regions of the API. */
|
|
673
674
|
}
|
|
674
675
|
|
|
675
676
|
/**
|
|
@@ -678,7 +679,6 @@ class API extends API$1 {
|
|
|
678
679
|
* This API allows you to manage your Scaleway Load Balancer services. Load
|
|
679
680
|
* Balancer API.
|
|
680
681
|
*/
|
|
681
|
-
/** Lists the available regions of the API. */
|
|
682
682
|
API.LOCALITIES = ['fr-par', 'nl-ams', 'pl-waw'];
|
|
683
683
|
class ZonedAPI extends API$1 {
|
|
684
684
|
constructor() {
|
|
@@ -1467,8 +1467,8 @@ class ZonedAPI extends API$1 {
|
|
|
1467
1467
|
path: `/lb/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/lbs/${validatePathParam('lbId', request.lbId)}/private-networks/${validatePathParam('privateNetworkId', request.privateNetworkId)}/detach`
|
|
1468
1468
|
});
|
|
1469
1469
|
}
|
|
1470
|
+
/** Lists the available zones of the API. */
|
|
1470
1471
|
}
|
|
1471
|
-
/** Lists the available zones of the API. */
|
|
1472
1472
|
ZonedAPI.LOCALITIES = ['fr-par-1', 'fr-par-2', 'nl-ams-1', 'nl-ams-2', 'pl-waw-1', 'pl-waw-2'];
|
|
1473
1473
|
|
|
1474
1474
|
export { API, ZonedAPI };
|