@leaflow/sdk 0.0.0-dev.19.ga71ef8f → 0.0.0-dev.190.gdc509eb
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/README.md +13 -1
- package/dist/account/v1/client.d.ts +4 -0
- package/dist/account/v1/client.js +7 -0
- package/dist/account/v1/index.d.ts +33 -22
- package/dist/account/v1/index.js +4 -4
- package/dist/account/v1/schema.d.ts +307 -89
- package/dist/assistant/v1/client.d.ts +4 -0
- package/dist/assistant/v1/client.js +7 -0
- package/dist/assistant/v1/index.d.ts +69 -40
- package/dist/assistant/v1/index.js +4 -4
- package/dist/assistant/v1/schema.d.ts +1089 -133
- package/dist/billing/v1/client.d.ts +6 -0
- package/dist/billing/v1/client.js +6 -0
- package/dist/billing/v1/index.d.ts +205 -0
- package/dist/billing/v1/index.js +5 -0
- package/dist/billing/v1/schema.d.ts +4969 -0
- package/dist/billing/v1/schema.js +5 -0
- package/dist/canopy/v1/client.d.ts +4 -0
- package/dist/canopy/v1/client.js +7 -0
- package/dist/canopy/v1/index.d.ts +24 -23
- package/dist/canopy/v1/index.js +4 -4
- package/dist/canopy/v1/schema.d.ts +113 -109
- package/dist/compute/v1/client.d.ts +4 -0
- package/dist/compute/v1/client.js +7 -0
- package/dist/compute/v1/index.d.ts +172 -125
- package/dist/compute/v1/index.js +4 -4
- package/dist/compute/v1/schema.d.ts +1581 -476
- package/dist/dns/v1/client.d.ts +4 -0
- package/dist/dns/v1/client.js +7 -0
- package/dist/dns/v1/index.d.ts +43 -0
- package/dist/dns/v1/index.js +5 -0
- package/dist/dns/v1/schema.d.ts +887 -0
- package/dist/dns/v1/schema.js +5 -0
- package/dist/iam/v1/client.d.ts +4 -0
- package/dist/iam/v1/client.js +7 -0
- package/dist/iam/v1/index.d.ts +55 -32
- package/dist/iam/v1/index.js +4 -4
- package/dist/iam/v1/schema.d.ts +521 -88
- package/dist/index.d.ts +11 -7
- package/dist/index.js +19 -5
- package/dist/monitoring/v1/client.d.ts +4 -0
- package/dist/monitoring/v1/client.js +7 -0
- package/dist/monitoring/v1/index.d.ts +130 -49
- package/dist/monitoring/v1/index.js +4 -4
- package/dist/monitoring/v1/schema.d.ts +2420 -527
- package/dist/notification/v1/client.d.ts +4 -0
- package/dist/notification/v1/client.js +7 -0
- package/dist/notification/v1/index.d.ts +77 -0
- package/dist/notification/v1/index.js +5 -0
- package/dist/notification/v1/schema.d.ts +2048 -0
- package/dist/notification/v1/schema.js +5 -0
- package/dist/support/v1/client.d.ts +4 -0
- package/dist/support/v1/client.js +7 -0
- package/dist/support/v1/index.d.ts +51 -0
- package/dist/support/v1/index.js +5 -0
- package/dist/support/v1/schema.d.ts +1082 -0
- package/dist/support/v1/schema.js +5 -0
- package/dist/tunnel/v1/client.d.ts +4 -0
- package/dist/tunnel/v1/client.js +7 -0
- package/dist/tunnel/v1/index.d.ts +8 -7
- package/dist/tunnel/v1/index.js +4 -4
- package/dist/tunnel/v1/schema.d.ts +40 -34
- package/package.json +22 -10
|
@@ -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,10 @@ export interface paths {
|
|
|
82
82
|
path?: never;
|
|
83
83
|
cookie?: never;
|
|
84
84
|
};
|
|
85
|
-
/**
|
|
85
|
+
/**
|
|
86
|
+
* List disk types on sale
|
|
87
|
+
* @description Only disk types currently on sale are listed. A withdrawn one disappears from here and can no longer be bought, while the disks already on it keep working and can still be resized.
|
|
88
|
+
*/
|
|
86
89
|
get: operations["list-disk-types"];
|
|
87
90
|
put?: never;
|
|
88
91
|
post?: never;
|
|
@@ -92,6 +95,26 @@ export interface paths {
|
|
|
92
95
|
patch?: never;
|
|
93
96
|
trace?: never;
|
|
94
97
|
};
|
|
98
|
+
"/api/v1/disk-types/{diskTypeId}": {
|
|
99
|
+
parameters: {
|
|
100
|
+
query?: never;
|
|
101
|
+
header?: never;
|
|
102
|
+
path?: never;
|
|
103
|
+
cookie?: never;
|
|
104
|
+
};
|
|
105
|
+
/**
|
|
106
|
+
* Get a disk type
|
|
107
|
+
* @description Retrieve capacity and performance constraints for an existing disk, including system disk types and types withdrawn from sale.
|
|
108
|
+
*/
|
|
109
|
+
get: operations["get-disk-type"];
|
|
110
|
+
put?: never;
|
|
111
|
+
post?: never;
|
|
112
|
+
delete?: never;
|
|
113
|
+
options?: never;
|
|
114
|
+
head?: never;
|
|
115
|
+
patch?: never;
|
|
116
|
+
trace?: never;
|
|
117
|
+
};
|
|
95
118
|
"/api/v1/images": {
|
|
96
119
|
parameters: {
|
|
97
120
|
query?: never;
|
|
@@ -100,8 +123,10 @@ export interface paths {
|
|
|
100
123
|
cookie?: never;
|
|
101
124
|
};
|
|
102
125
|
/**
|
|
103
|
-
*
|
|
104
|
-
* @description min_ram_mb
|
|
126
|
+
* List images on sale
|
|
127
|
+
* @description An image whose `min_ram_mb` exceeds the memory of the selected instance type cannot boot. Filter the options accordingly.
|
|
128
|
+
*
|
|
129
|
+
* Only images currently on sale are listed. An image the platform withdraws disappears from here and can no longer install new instances, while the instances already running it keep running and can still be rebuilt onto it.
|
|
105
130
|
*/
|
|
106
131
|
get: operations["list-images"];
|
|
107
132
|
put?: never;
|
|
@@ -119,7 +144,10 @@ export interface paths {
|
|
|
119
144
|
path?: never;
|
|
120
145
|
cookie?: never;
|
|
121
146
|
};
|
|
122
|
-
/**
|
|
147
|
+
/**
|
|
148
|
+
* List instance types on sale
|
|
149
|
+
* @description Only instance types currently on sale are listed. A withdrawn one disappears from here and can no longer be ordered, while the instances already running it keep running.
|
|
150
|
+
*/
|
|
123
151
|
get: operations["list-instance-types"];
|
|
124
152
|
put?: never;
|
|
125
153
|
post?: never;
|
|
@@ -136,7 +164,7 @@ export interface paths {
|
|
|
136
164
|
path?: never;
|
|
137
165
|
cookie?: never;
|
|
138
166
|
};
|
|
139
|
-
/**
|
|
167
|
+
/** List available regions */
|
|
140
168
|
get: operations["list-regions"];
|
|
141
169
|
put?: never;
|
|
142
170
|
post?: never;
|
|
@@ -146,7 +174,7 @@ export interface paths {
|
|
|
146
174
|
patch?: never;
|
|
147
175
|
trace?: never;
|
|
148
176
|
};
|
|
149
|
-
"/api/v1/regions/{
|
|
177
|
+
"/api/v1/regions/{regionId}/availability-zones": {
|
|
150
178
|
parameters: {
|
|
151
179
|
query?: never;
|
|
152
180
|
header?: never;
|
|
@@ -154,8 +182,8 @@ export interface paths {
|
|
|
154
182
|
cookie?: never;
|
|
155
183
|
};
|
|
156
184
|
/**
|
|
157
|
-
*
|
|
158
|
-
* @description
|
|
185
|
+
* List the availability zones of a region
|
|
186
|
+
* @description A disk and an instance must reside in the same availability zone to be attached. Confirm the zone before creating either.
|
|
159
187
|
*/
|
|
160
188
|
get: operations["list-availability-zones"];
|
|
161
189
|
put?: never;
|
|
@@ -174,14 +202,16 @@ export interface paths {
|
|
|
174
202
|
cookie?: never;
|
|
175
203
|
};
|
|
176
204
|
/**
|
|
177
|
-
*
|
|
178
|
-
* @description
|
|
205
|
+
* List disks
|
|
206
|
+
* @description When both `region_code` and `availability_zone` are supplied, only disks attachable to an instance at that location are returned.
|
|
179
207
|
*/
|
|
180
208
|
get: operations["list-disks"];
|
|
181
209
|
put?: never;
|
|
182
210
|
/**
|
|
183
|
-
*
|
|
184
|
-
* @description
|
|
211
|
+
* Create a disk
|
|
212
|
+
* @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.
|
|
213
|
+
*
|
|
214
|
+
* A disk type that has been withdrawn is rejected with `DISK_TYPE_RETIRED`, even though its identifier still resolves. Withdrawn types stop appearing in the disk type listing; disks already bought on one keep working and can still be resized.
|
|
185
215
|
*/
|
|
186
216
|
post: operations["create-disk"];
|
|
187
217
|
delete?: never;
|
|
@@ -198,22 +228,22 @@ export interface paths {
|
|
|
198
228
|
cookie?: never;
|
|
199
229
|
};
|
|
200
230
|
/**
|
|
201
|
-
*
|
|
202
|
-
* @description
|
|
231
|
+
* Retrieve a disk
|
|
232
|
+
* @description Queries the current state of the disk, which makes it slower but more accurate than the list endpoint.
|
|
203
233
|
*/
|
|
204
234
|
get: operations["get-disk"];
|
|
205
235
|
put?: never;
|
|
206
236
|
post?: never;
|
|
207
237
|
/**
|
|
208
|
-
*
|
|
209
|
-
* @description
|
|
238
|
+
* Delete a disk
|
|
239
|
+
* @description Deletion is rejected while the disk is attached, or while snapshots created from it still exist.
|
|
210
240
|
*/
|
|
211
241
|
delete: operations["delete-disk"];
|
|
212
242
|
options?: never;
|
|
213
243
|
head?: never;
|
|
214
244
|
/**
|
|
215
|
-
*
|
|
216
|
-
* @description
|
|
245
|
+
* Rename a disk
|
|
246
|
+
* @description Changes the name only. Use the resize endpoint for capacity; type and availability zone are immutable.
|
|
217
247
|
*/
|
|
218
248
|
patch: operations["rename-disk"];
|
|
219
249
|
trace?: never;
|
|
@@ -228,8 +258,14 @@ export interface paths {
|
|
|
228
258
|
get?: never;
|
|
229
259
|
put?: never;
|
|
230
260
|
/**
|
|
231
|
-
*
|
|
232
|
-
* @description
|
|
261
|
+
* Resize a disk
|
|
262
|
+
* @description Capacity can only be increased; shrinking is not supported. Extend the file system inside the instance once the resize completes.
|
|
263
|
+
*
|
|
264
|
+
* **A data disk whose performance grows with its size has to be detached first.** The storage backend decides a volume's limit when the volume is attached and never revisits it, so growing one that is attached would give you the capacity immediately and leave the speed at the old size's figure — indefinitely, and stopping the instance does not help. Rather than take the money for performance that does not arrive, this is refused with `DISK_RESIZE_NEEDS_DETACH`; detach the disk, resize it, and attach it again.
|
|
265
|
+
*
|
|
266
|
+
* It is only refused when the two sizes really would differ in speed. A disk whose type has no QoS level, or whose performance has already reached the type's ceiling, grows online as before.
|
|
267
|
+
*
|
|
268
|
+
* **A system disk is the exception and grows online**, because a root volume cannot be detached at all. Its performance does not change with size for exactly that reason — system disk types are required to carry a level that does not scale.
|
|
233
269
|
*/
|
|
234
270
|
post: operations["resize-disk"];
|
|
235
271
|
delete?: never;
|
|
@@ -248,12 +284,12 @@ export interface paths {
|
|
|
248
284
|
get?: never;
|
|
249
285
|
put?: never;
|
|
250
286
|
/**
|
|
251
|
-
*
|
|
252
|
-
* @description
|
|
287
|
+
* Revert to a snapshot
|
|
288
|
+
* @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
289
|
*
|
|
254
|
-
*
|
|
290
|
+
* 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
291
|
*
|
|
256
|
-
*
|
|
292
|
+
* The revert is not complete when this endpoint returns; poll the retrieve endpoint.
|
|
257
293
|
*/
|
|
258
294
|
post: operations["revert-disk"];
|
|
259
295
|
delete?: never;
|
|
@@ -269,14 +305,14 @@ export interface paths {
|
|
|
269
305
|
path?: never;
|
|
270
306
|
cookie?: never;
|
|
271
307
|
};
|
|
272
|
-
/**
|
|
308
|
+
/** List floating IPs */
|
|
273
309
|
get: operations["list-floating-ips"];
|
|
274
310
|
put?: never;
|
|
275
311
|
/**
|
|
276
|
-
*
|
|
277
|
-
* @description
|
|
312
|
+
* Allocate a floating IP
|
|
313
|
+
* @description If the private network is not yet connected to the internet, connectivity is established as part of this call.
|
|
278
314
|
*
|
|
279
|
-
* IPv6
|
|
315
|
+
* IPv6 is not requested through this endpoint. IPv6 addresses are assigned to instances by the private network; enable IPv6 on that network instead.
|
|
280
316
|
*/
|
|
281
317
|
post: operations["allocate-floating-ip"];
|
|
282
318
|
delete?: never;
|
|
@@ -292,13 +328,13 @@ export interface paths {
|
|
|
292
328
|
path?: never;
|
|
293
329
|
cookie?: never;
|
|
294
330
|
};
|
|
295
|
-
/**
|
|
331
|
+
/** Retrieve a floating IP */
|
|
296
332
|
get: operations["get-floating-ip"];
|
|
297
333
|
put?: never;
|
|
298
334
|
post?: never;
|
|
299
335
|
/**
|
|
300
|
-
*
|
|
301
|
-
* @description
|
|
336
|
+
* Release a floating IP
|
|
337
|
+
* @description Releases the floating IP after unbinding it. Completion is reported by the returned task.
|
|
302
338
|
*/
|
|
303
339
|
delete: operations["release-floating-ip"];
|
|
304
340
|
options?: never;
|
|
@@ -315,8 +351,10 @@ export interface paths {
|
|
|
315
351
|
};
|
|
316
352
|
get?: never;
|
|
317
353
|
/**
|
|
318
|
-
*
|
|
319
|
-
* @description
|
|
354
|
+
* Set the bandwidth limit
|
|
355
|
+
* @description Limits both directions at once. Limiting egress alone does not prevent ingress traffic from saturating the uplink.
|
|
356
|
+
*
|
|
357
|
+
* While the address is bound to an instance, the ceiling has to fit that instance type's `max_bandwidth_mbps`; asking for more is refused with `INSTANCE_BANDWIDTH_CEILING`. An address bound to nothing is not checked against any type — there is none to check against — and is checked again when it is attached.
|
|
320
358
|
*/
|
|
321
359
|
put: operations["set-floating-ip-bandwidth"];
|
|
322
360
|
post?: never;
|
|
@@ -334,12 +372,12 @@ export interface paths {
|
|
|
334
372
|
cookie?: never;
|
|
335
373
|
};
|
|
336
374
|
get?: never;
|
|
337
|
-
/**
|
|
375
|
+
/** Bind a floating IP to a network interface */
|
|
338
376
|
put: operations["bind-floating-ip"];
|
|
339
377
|
post?: never;
|
|
340
378
|
/**
|
|
341
|
-
*
|
|
342
|
-
* @description
|
|
379
|
+
* Unbind a floating IP
|
|
380
|
+
* @description The address remains held by the project and simply no longer points at any network interface.
|
|
343
381
|
*/
|
|
344
382
|
delete: operations["unbind-floating-ip"];
|
|
345
383
|
options?: never;
|
|
@@ -354,22 +392,15 @@ export interface paths {
|
|
|
354
392
|
path?: never;
|
|
355
393
|
cookie?: never;
|
|
356
394
|
};
|
|
357
|
-
/**
|
|
395
|
+
/**
|
|
396
|
+
* List instances
|
|
397
|
+
* @description Every instance in the project, newest first. This endpoint does not query backend state; for the accurate state of one instance, use the retrieve endpoint.
|
|
398
|
+
*/
|
|
358
399
|
get: operations["list-instances"];
|
|
359
400
|
put?: never;
|
|
360
401
|
/**
|
|
361
|
-
*
|
|
362
|
-
* @description
|
|
363
|
-
*
|
|
364
|
-
* `count` 可一次创建多台(最多 20 台),名称自动加 `-1`、`-2` 编号,所有云服务器共用同一个密码。**响应中的 `instances` 始终是数组**,单台创建时也是。
|
|
365
|
-
*
|
|
366
|
-
* 批量创建按顺序逐台进行。若中途失败(例如配额不足),**已创建的云服务器会保留**,响应中的 `failure` 给出中止原因;第一台就失败时视为整次请求失败,不会创建任何云服务器。
|
|
367
|
-
*
|
|
368
|
-
* 镜像二选一:`image_id` 使用平台提供的镜像,`private_image_id` 使用自制镜像。两者都给或都不给都会被拒绝。
|
|
369
|
-
*
|
|
370
|
-
* 云服务器创建在机型所属的可用区。后续要挂载的云硬盘必须位于同一可用区。
|
|
371
|
-
*
|
|
372
|
-
* 接口返回时创建尚未完成(status 为 provisioning),请轮询 GET 确认结果。
|
|
402
|
+
* Create instances
|
|
403
|
+
* @description Creates a Billing order, including for metered pricing. The price must belong to the resource’s Billing Plan; applicable contract pricing is resolved by Billing. Technical capacity is checked before sellable quota is reserved. Provisioning continues automatically after payment; do not submit a new purchase after paying. Reuse the original idempotency key after an uncertain response. Exactly one of image_id, private_image_id or boot_disk_id is required, and exactly one of port_id or subnet_id. Existing ports, boot disks or floating IPs require count=1. Image boots require boot_disk; existing disks retain their own subscription. Instances, disks and public IPs keep their own subscription items on the same order. A request for several instances is all or nothing — if any instance cannot be created, every instance of that request is released and the order fails, so nothing is charged. Each instance is named after this request with a number appended, and each has its own task.
|
|
373
404
|
*/
|
|
374
405
|
post: operations["launch-instance"];
|
|
375
406
|
delete?: never;
|
|
@@ -386,29 +417,29 @@ export interface paths {
|
|
|
386
417
|
cookie?: never;
|
|
387
418
|
};
|
|
388
419
|
/**
|
|
389
|
-
*
|
|
390
|
-
* @description
|
|
420
|
+
* Retrieve an instance
|
|
421
|
+
* @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
422
|
*/
|
|
392
423
|
get: operations["get-instance"];
|
|
393
424
|
put?: never;
|
|
394
425
|
post?: never;
|
|
395
426
|
/**
|
|
396
|
-
*
|
|
397
|
-
* @description
|
|
427
|
+
* Release an instance
|
|
428
|
+
* @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
429
|
*
|
|
399
|
-
*
|
|
430
|
+
* An instance being captured as a private image cannot be released. Wait for the capture to finish, or delete that image first.
|
|
400
431
|
*/
|
|
401
432
|
delete: operations["delete-instance"];
|
|
402
433
|
options?: never;
|
|
403
434
|
head?: never;
|
|
404
435
|
/**
|
|
405
|
-
*
|
|
406
|
-
* @description
|
|
436
|
+
* Rename an instance
|
|
437
|
+
* @description Changes the display name only. The hostname inside the instance is unchanged; it equals the instance id.
|
|
407
438
|
*/
|
|
408
439
|
patch: operations["rename-instance"];
|
|
409
440
|
trace?: never;
|
|
410
441
|
};
|
|
411
|
-
"/api/v1/instances/{instanceId}/
|
|
442
|
+
"/api/v1/instances/{instanceId}/commands": {
|
|
412
443
|
parameters: {
|
|
413
444
|
query?: never;
|
|
414
445
|
header?: never;
|
|
@@ -418,14 +449,26 @@ export interface paths {
|
|
|
418
449
|
get?: never;
|
|
419
450
|
put?: never;
|
|
420
451
|
/**
|
|
421
|
-
*
|
|
422
|
-
* @description
|
|
452
|
+
* Run a command on an instance
|
|
453
|
+
* @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.
|
|
454
|
+
*
|
|
455
|
+
* **A command that fails is still a 200.** Its failure is its own result, not this endpoint's: read `exit_code` for what it exited with and `stderr` for what it said, and decide from those. A `grep` that matches nothing exits 1 and is a perfectly successful call.
|
|
456
|
+
*
|
|
457
|
+
* The status therefore answers a different question — did the command run at all. A non-2xx means it did not, and nothing about the instance was changed by this request: it was suspended, not running or had no floating IP; or it refused the platform key; or the connection could not be opened. Retrying is meaningful in those cases and is not for a non-zero `exit_code`.
|
|
458
|
+
*
|
|
459
|
+
* Three conditions must hold; the instance is unreachable otherwise:
|
|
423
460
|
*
|
|
424
|
-
*
|
|
461
|
+
* - it is `running`
|
|
462
|
+
* - a floating IP is bound to it, since this endpoint connects over the public internet
|
|
463
|
+
* - its security group permits inbound TCP 22
|
|
425
464
|
*
|
|
426
|
-
*
|
|
465
|
+
* 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.
|
|
466
|
+
*
|
|
467
|
+
* **Do not pass secrets in the command.** Read them from a file on the instance instead: neither the command nor its output is a confidential channel.
|
|
468
|
+
*
|
|
469
|
+
* Each stream is capped at 1 MiB. Beyond that the rest is discarded and `truncated` is true.
|
|
427
470
|
*/
|
|
428
|
-
post: operations["
|
|
471
|
+
post: operations["run-instance-command"];
|
|
429
472
|
delete?: never;
|
|
430
473
|
options?: never;
|
|
431
474
|
head?: never;
|
|
@@ -442,10 +485,10 @@ export interface paths {
|
|
|
442
485
|
get?: never;
|
|
443
486
|
put?: never;
|
|
444
487
|
/**
|
|
445
|
-
*
|
|
446
|
-
* @description
|
|
488
|
+
* Open a remote console
|
|
489
|
+
* @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
490
|
*
|
|
448
|
-
*
|
|
491
|
+
* The returned address is single-use and expires within minutes. Request a new one before each use.
|
|
449
492
|
*/
|
|
450
493
|
post: operations["open-instance-console"];
|
|
451
494
|
delete?: never;
|
|
@@ -462,10 +505,10 @@ export interface paths {
|
|
|
462
505
|
cookie?: never;
|
|
463
506
|
};
|
|
464
507
|
/**
|
|
465
|
-
*
|
|
466
|
-
* @description
|
|
508
|
+
* Read the console output
|
|
509
|
+
* @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
510
|
*
|
|
468
|
-
*
|
|
511
|
+
* Instances in an error state, and instances suspended by the platform, can be read as well.
|
|
469
512
|
*/
|
|
470
513
|
get: operations["get-instance-console-output"];
|
|
471
514
|
put?: never;
|
|
@@ -476,6 +519,54 @@ export interface paths {
|
|
|
476
519
|
patch?: never;
|
|
477
520
|
trace?: never;
|
|
478
521
|
};
|
|
522
|
+
"/api/v1/instances/{instanceId}/labels": {
|
|
523
|
+
parameters: {
|
|
524
|
+
query?: never;
|
|
525
|
+
header?: never;
|
|
526
|
+
path?: never;
|
|
527
|
+
cookie?: never;
|
|
528
|
+
};
|
|
529
|
+
get?: never;
|
|
530
|
+
/**
|
|
531
|
+
* Replace an instance's labels
|
|
532
|
+
* @description Records what this instance is for, as key-value pairs. Nothing on the platform reads them.
|
|
533
|
+
*
|
|
534
|
+
* **The whole set is replaced**: whatever is absent from the request is removed.
|
|
535
|
+
*
|
|
536
|
+
* Do not put credentials here. Labels are visible to platform operators.
|
|
537
|
+
*/
|
|
538
|
+
put: operations["set-instance-labels"];
|
|
539
|
+
post?: never;
|
|
540
|
+
delete?: never;
|
|
541
|
+
options?: never;
|
|
542
|
+
head?: never;
|
|
543
|
+
patch?: never;
|
|
544
|
+
trace?: never;
|
|
545
|
+
};
|
|
546
|
+
"/api/v1/instances/{instanceId}/notes": {
|
|
547
|
+
parameters: {
|
|
548
|
+
query?: never;
|
|
549
|
+
header?: never;
|
|
550
|
+
path?: never;
|
|
551
|
+
cookie?: never;
|
|
552
|
+
};
|
|
553
|
+
get?: never;
|
|
554
|
+
/**
|
|
555
|
+
* Replace an instance's note
|
|
556
|
+
* @description A free-text note about this instance — what it runs, and what to be careful about before touching it.
|
|
557
|
+
*
|
|
558
|
+
* **The whole note is replaced**; send an empty string to clear it.
|
|
559
|
+
*
|
|
560
|
+
* Do not put credentials here. The note is visible to platform operators.
|
|
561
|
+
*/
|
|
562
|
+
put: operations["set-instance-notes"];
|
|
563
|
+
post?: never;
|
|
564
|
+
delete?: never;
|
|
565
|
+
options?: never;
|
|
566
|
+
head?: never;
|
|
567
|
+
patch?: never;
|
|
568
|
+
trace?: never;
|
|
569
|
+
};
|
|
479
570
|
"/api/v1/instances/{instanceId}/password": {
|
|
480
571
|
parameters: {
|
|
481
572
|
query?: never;
|
|
@@ -486,12 +577,12 @@ export interface paths {
|
|
|
486
577
|
get?: never;
|
|
487
578
|
put?: never;
|
|
488
579
|
/**
|
|
489
|
-
*
|
|
490
|
-
* @description
|
|
580
|
+
* Reset the login password
|
|
581
|
+
* @description Changes the root password without a reboot. The instance must be running.
|
|
491
582
|
*
|
|
492
|
-
*
|
|
583
|
+
* **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
584
|
*
|
|
494
|
-
*
|
|
585
|
+
* 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
586
|
*/
|
|
496
587
|
post: operations["reset-instance-password"];
|
|
497
588
|
delete?: never;
|
|
@@ -500,6 +591,34 @@ export interface paths {
|
|
|
500
591
|
patch?: never;
|
|
501
592
|
trace?: never;
|
|
502
593
|
};
|
|
594
|
+
"/api/v1/instances/{instanceId}/reboot": {
|
|
595
|
+
parameters: {
|
|
596
|
+
query?: never;
|
|
597
|
+
header?: never;
|
|
598
|
+
path?: never;
|
|
599
|
+
cookie?: never;
|
|
600
|
+
};
|
|
601
|
+
get?: never;
|
|
602
|
+
put?: never;
|
|
603
|
+
/**
|
|
604
|
+
* Reboot an instance
|
|
605
|
+
* @description A reboot defaults to soft, in which the operating system shuts down normally before starting again.
|
|
606
|
+
*
|
|
607
|
+
* 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**.
|
|
608
|
+
*
|
|
609
|
+
* A forced reboot is accepted while the instance is already `rebooting`, which is the way out of a soft reboot the instance never carried out. Every other endpoint refuses an instance in a transient state, and a second soft reboot is refused as well.
|
|
610
|
+
*
|
|
611
|
+
* An instance suspended by the platform must be unsuspended first.
|
|
612
|
+
*
|
|
613
|
+
* This endpoint returns immediately and the `status` it returns is the transient `rebooting`. Poll the instance until it settles at `running`.
|
|
614
|
+
*/
|
|
615
|
+
post: operations["reboot-instance"];
|
|
616
|
+
delete?: never;
|
|
617
|
+
options?: never;
|
|
618
|
+
head?: never;
|
|
619
|
+
patch?: never;
|
|
620
|
+
trace?: never;
|
|
621
|
+
};
|
|
503
622
|
"/api/v1/instances/{instanceId}/rebuild": {
|
|
504
623
|
parameters: {
|
|
505
624
|
query?: never;
|
|
@@ -510,8 +629,10 @@ export interface paths {
|
|
|
510
629
|
get?: never;
|
|
511
630
|
put?: never;
|
|
512
631
|
/**
|
|
513
|
-
*
|
|
514
|
-
* @description
|
|
632
|
+
* Rebuild an instance
|
|
633
|
+
* @description **All data on the system disk is erased and cannot be recovered.** Attached data disks are unaffected.
|
|
634
|
+
*
|
|
635
|
+
* The image this instance already runs is accepted even after the platform has withdrawn it, since rebuilding is the only way back into an instance broken from the inside. Any *other* withdrawn image is rejected with `IMAGE_RETIRED`, which is a change of image and therefore a new order.
|
|
515
636
|
*/
|
|
516
637
|
post: operations["rebuild-instance"];
|
|
517
638
|
delete?: never;
|
|
@@ -530,12 +651,8 @@ export interface paths {
|
|
|
530
651
|
get?: never;
|
|
531
652
|
put?: never;
|
|
532
653
|
/**
|
|
533
|
-
*
|
|
534
|
-
* @description
|
|
535
|
-
*
|
|
536
|
-
* 变配分两步:本接口下发后云服务器会在新规格上重新启动,状态变为 `resize_verifying`,此时**必须**调用确认或回滚接口。目标机型在确认前记在 `pending_instance_type_id` 上,`instance_type_id` 仍为当前生效并计费的机型。
|
|
537
|
-
*
|
|
538
|
-
* **未确认期间新旧两份规格同时占用资源。** 请在状态变为 `resize_verifying` 后尽快确认。
|
|
654
|
+
* Resize an instance
|
|
655
|
+
* @description Creates a Billing order, including for metered pricing. The price must belong to the resource’s Billing Plan; applicable contract pricing is resolved by Billing. Technical capacity is checked before sellable quota is reserved. Provisioning continues automatically after payment; do not submit a new purchase after paying. Reuse the original idempotency key after an uncertain response.
|
|
539
656
|
*/
|
|
540
657
|
post: operations["resize-instance"];
|
|
541
658
|
delete?: never;
|
|
@@ -554,8 +671,8 @@ export interface paths {
|
|
|
554
671
|
get?: never;
|
|
555
672
|
put?: never;
|
|
556
673
|
/**
|
|
557
|
-
*
|
|
558
|
-
* @description
|
|
674
|
+
* Confirm a resize
|
|
675
|
+
* @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
676
|
*/
|
|
560
677
|
post: operations["confirm-instance-resize"];
|
|
561
678
|
delete?: never;
|
|
@@ -574,8 +691,8 @@ export interface paths {
|
|
|
574
691
|
get?: never;
|
|
575
692
|
put?: never;
|
|
576
693
|
/**
|
|
577
|
-
*
|
|
578
|
-
* @description
|
|
694
|
+
* Revert a resize
|
|
695
|
+
* @description The instance returns to its previous size, `pending_instance_type_id` is discarded, and billing is unaffected by the resize.
|
|
579
696
|
*/
|
|
580
697
|
post: operations["revert-instance-resize"];
|
|
581
698
|
delete?: never;
|
|
@@ -584,6 +701,46 @@ export interface paths {
|
|
|
584
701
|
patch?: never;
|
|
585
702
|
trace?: never;
|
|
586
703
|
};
|
|
704
|
+
"/api/v1/instances/{instanceId}/start": {
|
|
705
|
+
parameters: {
|
|
706
|
+
query?: never;
|
|
707
|
+
header?: never;
|
|
708
|
+
path?: never;
|
|
709
|
+
cookie?: never;
|
|
710
|
+
};
|
|
711
|
+
get?: never;
|
|
712
|
+
put?: never;
|
|
713
|
+
/**
|
|
714
|
+
* Start an instance
|
|
715
|
+
* @description Records the desired power state. An in-flight shutdown is allowed to finish before a subsequent start. Outstanding restrictions can prevent starting. A stopped instance keeps its disks, network attachments and sellable quota. Inspect operation, task_state, power_state and observed_at to determine completion.
|
|
716
|
+
*/
|
|
717
|
+
post: operations["start-instance"];
|
|
718
|
+
delete?: never;
|
|
719
|
+
options?: never;
|
|
720
|
+
head?: never;
|
|
721
|
+
patch?: never;
|
|
722
|
+
trace?: never;
|
|
723
|
+
};
|
|
724
|
+
"/api/v1/instances/{instanceId}/stop": {
|
|
725
|
+
parameters: {
|
|
726
|
+
query?: never;
|
|
727
|
+
header?: never;
|
|
728
|
+
path?: never;
|
|
729
|
+
cookie?: never;
|
|
730
|
+
};
|
|
731
|
+
get?: never;
|
|
732
|
+
put?: never;
|
|
733
|
+
/**
|
|
734
|
+
* Stop an instance
|
|
735
|
+
* @description Records the desired power state. An in-flight shutdown is allowed to finish before a subsequent start. Outstanding restrictions can prevent starting. A stopped instance keeps its disks, network attachments and sellable quota. Inspect operation, task_state, power_state and observed_at to determine completion.
|
|
736
|
+
*/
|
|
737
|
+
post: operations["stop-instance"];
|
|
738
|
+
delete?: never;
|
|
739
|
+
options?: never;
|
|
740
|
+
head?: never;
|
|
741
|
+
patch?: never;
|
|
742
|
+
trace?: never;
|
|
743
|
+
};
|
|
587
744
|
"/api/v1/instances/{instanceId}/disks": {
|
|
588
745
|
parameters: {
|
|
589
746
|
query?: never;
|
|
@@ -591,12 +748,12 @@ export interface paths {
|
|
|
591
748
|
path?: never;
|
|
592
749
|
cookie?: never;
|
|
593
750
|
};
|
|
594
|
-
/**
|
|
751
|
+
/** List the disks attached to an instance */
|
|
595
752
|
get: operations["list-instance-disks"];
|
|
596
753
|
put?: never;
|
|
597
754
|
/**
|
|
598
|
-
*
|
|
599
|
-
* @description
|
|
755
|
+
* Attach a disk
|
|
756
|
+
* @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
757
|
*/
|
|
601
758
|
post: operations["attach-disk"];
|
|
602
759
|
delete?: never;
|
|
@@ -616,8 +773,8 @@ export interface paths {
|
|
|
616
773
|
put?: never;
|
|
617
774
|
post?: never;
|
|
618
775
|
/**
|
|
619
|
-
*
|
|
620
|
-
* @description
|
|
776
|
+
* Detach a disk
|
|
777
|
+
* @description Unmount the device inside the instance before calling this endpoint. Forcibly detaching a file system that is being written to corrupts data.
|
|
621
778
|
*/
|
|
622
779
|
delete: operations["detach-disk"];
|
|
623
780
|
options?: never;
|
|
@@ -635,8 +792,8 @@ export interface paths {
|
|
|
635
792
|
get?: never;
|
|
636
793
|
put?: never;
|
|
637
794
|
/**
|
|
638
|
-
*
|
|
639
|
-
* @description
|
|
795
|
+
* Bind a floating IP to an instance
|
|
796
|
+
* @description Changes the public IP binding on the instance's primary network interface. The returned task tracks confirmation of the binding change.
|
|
640
797
|
*/
|
|
641
798
|
post: operations["attach-instance-floating-ip"];
|
|
642
799
|
delete?: never;
|
|
@@ -655,7 +812,10 @@ export interface paths {
|
|
|
655
812
|
get?: never;
|
|
656
813
|
put?: never;
|
|
657
814
|
post?: never;
|
|
658
|
-
/**
|
|
815
|
+
/**
|
|
816
|
+
* Unbind the floating IP of an instance
|
|
817
|
+
* @description Changes the public IP binding on the instance's primary network interface. The returned task tracks confirmation of the binding change.
|
|
818
|
+
*/
|
|
659
819
|
delete: operations["detach-instance-floating-ip"];
|
|
660
820
|
options?: never;
|
|
661
821
|
head?: never;
|
|
@@ -669,10 +829,10 @@ export interface paths {
|
|
|
669
829
|
path?: never;
|
|
670
830
|
cookie?: never;
|
|
671
831
|
};
|
|
672
|
-
/**
|
|
832
|
+
/** List the network interfaces of an instance */
|
|
673
833
|
get: operations["list-instance-ports"];
|
|
674
834
|
put?: never;
|
|
675
|
-
/**
|
|
835
|
+
/** Attach a network interface */
|
|
676
836
|
post: operations["attach-port"];
|
|
677
837
|
delete?: never;
|
|
678
838
|
options?: never;
|
|
@@ -691,8 +851,8 @@ export interface paths {
|
|
|
691
851
|
put?: never;
|
|
692
852
|
post?: never;
|
|
693
853
|
/**
|
|
694
|
-
*
|
|
695
|
-
* @description
|
|
854
|
+
* Detach a network interface
|
|
855
|
+
* @description The primary network interface cannot be detached; the instance would lose its network address.
|
|
696
856
|
*/
|
|
697
857
|
delete: operations["detach-port"];
|
|
698
858
|
options?: never;
|
|
@@ -708,12 +868,12 @@ export interface paths {
|
|
|
708
868
|
cookie?: never;
|
|
709
869
|
};
|
|
710
870
|
/**
|
|
711
|
-
*
|
|
712
|
-
* @description
|
|
871
|
+
* List the operation log of the project
|
|
872
|
+
* @description Records every write operation in the project: who performed it, when, on what, and whether it succeeded. Read operations are not recorded.
|
|
713
873
|
*
|
|
714
|
-
*
|
|
874
|
+
* **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
875
|
*
|
|
716
|
-
*
|
|
876
|
+
* Fields such as passwords are replaced with a placeholder as the record is written and never appear in `payload`.
|
|
717
877
|
*/
|
|
718
878
|
get: operations["list-operation-logs"];
|
|
719
879
|
put?: never;
|
|
@@ -731,12 +891,12 @@ export interface paths {
|
|
|
731
891
|
path?: never;
|
|
732
892
|
cookie?: never;
|
|
733
893
|
};
|
|
734
|
-
/**
|
|
894
|
+
/** List network interfaces */
|
|
735
895
|
get: operations["list-ports"];
|
|
736
896
|
put?: never;
|
|
737
897
|
/**
|
|
738
|
-
*
|
|
739
|
-
* @description
|
|
898
|
+
* Create a network interface
|
|
899
|
+
* @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
900
|
*/
|
|
741
901
|
post: operations["create-port"];
|
|
742
902
|
delete?: never;
|
|
@@ -756,8 +916,8 @@ export interface paths {
|
|
|
756
916
|
put?: never;
|
|
757
917
|
post?: never;
|
|
758
918
|
/**
|
|
759
|
-
*
|
|
760
|
-
* @description
|
|
919
|
+
* Delete a network interface
|
|
920
|
+
* @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
921
|
*/
|
|
762
922
|
delete: operations["delete-port"];
|
|
763
923
|
options?: never;
|
|
@@ -772,23 +932,23 @@ export interface paths {
|
|
|
772
932
|
path?: never;
|
|
773
933
|
cookie?: never;
|
|
774
934
|
};
|
|
775
|
-
/**
|
|
935
|
+
/** List private images */
|
|
776
936
|
get: operations["list-private-images"];
|
|
777
937
|
put?: never;
|
|
778
938
|
/**
|
|
779
|
-
*
|
|
780
|
-
* @description
|
|
939
|
+
* Capture an instance as a private image
|
|
940
|
+
* @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
941
|
*
|
|
782
|
-
*
|
|
942
|
+
* **The image reflects the moment the capture started. Later changes to the instance are not included.**
|
|
783
943
|
*
|
|
784
|
-
*
|
|
944
|
+
* The capture has two phases. Poll the retrieve endpoint:
|
|
785
945
|
*
|
|
786
|
-
* - `provisioning`
|
|
787
|
-
* - `uploading`
|
|
946
|
+
* - `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.
|
|
947
|
+
* - `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
948
|
*
|
|
789
|
-
*
|
|
949
|
+
* 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
950
|
*
|
|
791
|
-
*
|
|
951
|
+
* The instance can be started, stopped and used normally during the capture, but cannot be released.
|
|
792
952
|
*/
|
|
793
953
|
post: operations["create-private-image"];
|
|
794
954
|
delete?: never;
|
|
@@ -805,22 +965,22 @@ export interface paths {
|
|
|
805
965
|
cookie?: never;
|
|
806
966
|
};
|
|
807
967
|
/**
|
|
808
|
-
*
|
|
809
|
-
* @description
|
|
968
|
+
* Retrieve a private image
|
|
969
|
+
* @description Use this endpoint to poll capture progress. When `status` is `error`, `failure` states the reason.
|
|
810
970
|
*/
|
|
811
971
|
get: operations["get-private-image"];
|
|
812
972
|
put?: never;
|
|
813
973
|
post?: never;
|
|
814
974
|
/**
|
|
815
|
-
*
|
|
816
|
-
* @description
|
|
975
|
+
* Delete a private image
|
|
976
|
+
* @description Deletion is rejected while instances created from the image still exist, as they need it in order to be rebuilt.
|
|
817
977
|
*
|
|
818
|
-
*
|
|
978
|
+
* An image whose capture has not finished can be deleted; the capture is aborted.
|
|
819
979
|
*/
|
|
820
980
|
delete: operations["delete-private-image"];
|
|
821
981
|
options?: never;
|
|
822
982
|
head?: never;
|
|
823
|
-
/**
|
|
983
|
+
/** Rename a private image */
|
|
824
984
|
patch: operations["rename-private-image"];
|
|
825
985
|
trace?: never;
|
|
826
986
|
};
|
|
@@ -831,12 +991,12 @@ export interface paths {
|
|
|
831
991
|
path?: never;
|
|
832
992
|
cookie?: never;
|
|
833
993
|
};
|
|
834
|
-
/**
|
|
994
|
+
/** List private networks */
|
|
835
995
|
get: operations["list-private-networks"];
|
|
836
996
|
put?: never;
|
|
837
997
|
/**
|
|
838
|
-
*
|
|
839
|
-
* @description
|
|
998
|
+
* Create a private network
|
|
999
|
+
* @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
1000
|
*/
|
|
841
1001
|
post: operations["create-private-network"];
|
|
842
1002
|
delete?: never;
|
|
@@ -852,20 +1012,20 @@ export interface paths {
|
|
|
852
1012
|
path?: never;
|
|
853
1013
|
cookie?: never;
|
|
854
1014
|
};
|
|
855
|
-
/**
|
|
1015
|
+
/** Retrieve a private network */
|
|
856
1016
|
get: operations["get-private-network"];
|
|
857
1017
|
put?: never;
|
|
858
1018
|
post?: never;
|
|
859
1019
|
/**
|
|
860
|
-
*
|
|
861
|
-
* @description
|
|
1020
|
+
* Release a private network
|
|
1021
|
+
* @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
1022
|
*/
|
|
863
1023
|
delete: operations["delete-private-network"];
|
|
864
1024
|
options?: never;
|
|
865
1025
|
head?: never;
|
|
866
1026
|
/**
|
|
867
|
-
*
|
|
868
|
-
* @description
|
|
1027
|
+
* Rename a private network
|
|
1028
|
+
* @description Changes the display name only. The CIDR, the routes and the internet gateway are immutable.
|
|
869
1029
|
*/
|
|
870
1030
|
patch: operations["rename-private-network"];
|
|
871
1031
|
trace?: never;
|
|
@@ -877,19 +1037,19 @@ export interface paths {
|
|
|
877
1037
|
path?: never;
|
|
878
1038
|
cookie?: never;
|
|
879
1039
|
};
|
|
880
|
-
/**
|
|
1040
|
+
/** Retrieve the IPv6 configuration of a private network */
|
|
881
1041
|
get: operations["get-private-network-ipv6"];
|
|
882
1042
|
put?: never;
|
|
883
1043
|
/**
|
|
884
|
-
*
|
|
885
|
-
* @description
|
|
1044
|
+
* Enable IPv6 on a private network
|
|
1045
|
+
* @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
1046
|
*
|
|
887
|
-
*
|
|
1047
|
+
* If the private network is not yet connected to the internet, connectivity is established as part of this call.
|
|
888
1048
|
*/
|
|
889
1049
|
post: operations["enable-private-network-ipv6"];
|
|
890
1050
|
/**
|
|
891
|
-
*
|
|
892
|
-
* @description
|
|
1051
|
+
* Disable IPv6 on a private network
|
|
1052
|
+
* @description A released prefix is not re-allocated immediately.
|
|
893
1053
|
*/
|
|
894
1054
|
delete: operations["disable-private-network-ipv6"];
|
|
895
1055
|
options?: never;
|
|
@@ -904,12 +1064,12 @@ export interface paths {
|
|
|
904
1064
|
path?: never;
|
|
905
1065
|
cookie?: never;
|
|
906
1066
|
};
|
|
907
|
-
/**
|
|
1067
|
+
/** List static routes */
|
|
908
1068
|
get: operations["list-routes"];
|
|
909
1069
|
put?: never;
|
|
910
1070
|
/**
|
|
911
|
-
*
|
|
912
|
-
* @description
|
|
1071
|
+
* Create a static route
|
|
1072
|
+
* @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
1073
|
*/
|
|
914
1074
|
post: operations["create-route"];
|
|
915
1075
|
delete?: never;
|
|
@@ -928,7 +1088,7 @@ export interface paths {
|
|
|
928
1088
|
get?: never;
|
|
929
1089
|
put?: never;
|
|
930
1090
|
post?: never;
|
|
931
|
-
/**
|
|
1091
|
+
/** Delete a static route */
|
|
932
1092
|
delete: operations["delete-route"];
|
|
933
1093
|
options?: never;
|
|
934
1094
|
head?: never;
|
|
@@ -943,12 +1103,12 @@ export interface paths {
|
|
|
943
1103
|
cookie?: never;
|
|
944
1104
|
};
|
|
945
1105
|
/**
|
|
946
|
-
*
|
|
947
|
-
* @description IPv6
|
|
1106
|
+
* List subnets
|
|
1107
|
+
* @description IPv6 subnets are included, with `ip_version` 6. They are created when IPv6 is enabled and cannot be deleted individually.
|
|
948
1108
|
*/
|
|
949
1109
|
get: operations["list-subnets"];
|
|
950
1110
|
put?: never;
|
|
951
|
-
/**
|
|
1111
|
+
/** Create a subnet */
|
|
952
1112
|
post: operations["create-subnet"];
|
|
953
1113
|
delete?: never;
|
|
954
1114
|
options?: never;
|
|
@@ -964,8 +1124,8 @@ export interface paths {
|
|
|
964
1124
|
cookie?: never;
|
|
965
1125
|
};
|
|
966
1126
|
/**
|
|
967
|
-
*
|
|
968
|
-
* @description
|
|
1127
|
+
* Suggest the next free CIDR
|
|
1128
|
+
* @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
1129
|
*/
|
|
970
1130
|
get: operations["suggest-subnet-cidr"];
|
|
971
1131
|
put?: never;
|
|
@@ -987,8 +1147,8 @@ export interface paths {
|
|
|
987
1147
|
put?: never;
|
|
988
1148
|
post?: never;
|
|
989
1149
|
/**
|
|
990
|
-
*
|
|
991
|
-
* @description
|
|
1150
|
+
* Delete a subnet
|
|
1151
|
+
* @description Deletion is rejected while network interfaces remain in the subnet, or while a static route has a next hop inside its CIDR.
|
|
992
1152
|
*/
|
|
993
1153
|
delete: operations["delete-subnet"];
|
|
994
1154
|
options?: never;
|
|
@@ -1003,12 +1163,12 @@ export interface paths {
|
|
|
1003
1163
|
path?: never;
|
|
1004
1164
|
cookie?: never;
|
|
1005
1165
|
};
|
|
1006
|
-
/**
|
|
1166
|
+
/** List security groups */
|
|
1007
1167
|
get: operations["list-security-groups"];
|
|
1008
1168
|
put?: never;
|
|
1009
1169
|
/**
|
|
1010
|
-
*
|
|
1011
|
-
* @description
|
|
1170
|
+
* Create a security group
|
|
1171
|
+
* @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
1172
|
*/
|
|
1013
1173
|
post: operations["create-security-group"];
|
|
1014
1174
|
delete?: never;
|
|
@@ -1024,20 +1184,20 @@ export interface paths {
|
|
|
1024
1184
|
path?: never;
|
|
1025
1185
|
cookie?: never;
|
|
1026
1186
|
};
|
|
1027
|
-
/**
|
|
1187
|
+
/** Retrieve a security group */
|
|
1028
1188
|
get: operations["get-security-group"];
|
|
1029
1189
|
put?: never;
|
|
1030
1190
|
post?: never;
|
|
1031
1191
|
/**
|
|
1032
|
-
*
|
|
1033
|
-
* @description
|
|
1192
|
+
* Delete a security group
|
|
1193
|
+
* @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
1194
|
*/
|
|
1035
1195
|
delete: operations["delete-security-group"];
|
|
1036
1196
|
options?: never;
|
|
1037
1197
|
head?: never;
|
|
1038
1198
|
/**
|
|
1039
|
-
*
|
|
1040
|
-
* @description
|
|
1199
|
+
* Rename a security group
|
|
1200
|
+
* @description Changes the name only. Use the rule endpoints to change rules.
|
|
1041
1201
|
*/
|
|
1042
1202
|
patch: operations["rename-security-group"];
|
|
1043
1203
|
trace?: never;
|
|
@@ -1049,12 +1209,12 @@ export interface paths {
|
|
|
1049
1209
|
path?: never;
|
|
1050
1210
|
cookie?: never;
|
|
1051
1211
|
};
|
|
1052
|
-
/**
|
|
1212
|
+
/** List security group rules */
|
|
1053
1213
|
get: operations["list-security-group-rules"];
|
|
1054
1214
|
put?: never;
|
|
1055
1215
|
/**
|
|
1056
|
-
*
|
|
1057
|
-
* @description
|
|
1216
|
+
* Create a security group rule
|
|
1217
|
+
* @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
1218
|
*/
|
|
1059
1219
|
post: operations["create-security-group-rule"];
|
|
1060
1220
|
delete?: never;
|
|
@@ -1073,7 +1233,7 @@ export interface paths {
|
|
|
1073
1233
|
get?: never;
|
|
1074
1234
|
put?: never;
|
|
1075
1235
|
post?: never;
|
|
1076
|
-
/**
|
|
1236
|
+
/** Delete a security group rule */
|
|
1077
1237
|
delete: operations["delete-security-group-rule"];
|
|
1078
1238
|
options?: never;
|
|
1079
1239
|
head?: never;
|
|
@@ -1087,14 +1247,14 @@ export interface paths {
|
|
|
1087
1247
|
path?: never;
|
|
1088
1248
|
cookie?: never;
|
|
1089
1249
|
};
|
|
1090
|
-
/**
|
|
1250
|
+
/** List snapshots */
|
|
1091
1251
|
get: operations["list-snapshots"];
|
|
1092
1252
|
put?: never;
|
|
1093
1253
|
/**
|
|
1094
|
-
*
|
|
1095
|
-
* @description
|
|
1254
|
+
* Create a snapshot
|
|
1255
|
+
* @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
1256
|
*
|
|
1097
|
-
*
|
|
1257
|
+
* **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
1258
|
*/
|
|
1099
1259
|
post: operations["create-snapshot"];
|
|
1100
1260
|
delete?: never;
|
|
@@ -1110,18 +1270,55 @@ export interface paths {
|
|
|
1110
1270
|
path?: never;
|
|
1111
1271
|
cookie?: never;
|
|
1112
1272
|
};
|
|
1113
|
-
/**
|
|
1273
|
+
/** Retrieve a snapshot */
|
|
1114
1274
|
get: operations["get-snapshot"];
|
|
1115
1275
|
put?: never;
|
|
1116
1276
|
post?: never;
|
|
1117
|
-
/**
|
|
1277
|
+
/** Delete a snapshot */
|
|
1118
1278
|
delete: operations["delete-snapshot"];
|
|
1119
1279
|
options?: never;
|
|
1120
1280
|
head?: never;
|
|
1121
|
-
/**
|
|
1281
|
+
/** Rename a snapshot */
|
|
1122
1282
|
patch: operations["rename-snapshot"];
|
|
1123
1283
|
trace?: never;
|
|
1124
1284
|
};
|
|
1285
|
+
"/api/v1/tasks/{taskId}": {
|
|
1286
|
+
parameters: {
|
|
1287
|
+
query?: never;
|
|
1288
|
+
header?: never;
|
|
1289
|
+
path?: never;
|
|
1290
|
+
cookie?: never;
|
|
1291
|
+
};
|
|
1292
|
+
/** Get a requested action */
|
|
1293
|
+
get: operations["get-task"];
|
|
1294
|
+
put?: never;
|
|
1295
|
+
post?: never;
|
|
1296
|
+
delete?: never;
|
|
1297
|
+
options?: never;
|
|
1298
|
+
head?: never;
|
|
1299
|
+
patch?: never;
|
|
1300
|
+
trace?: never;
|
|
1301
|
+
};
|
|
1302
|
+
"/api/v1/ipv4-pools": {
|
|
1303
|
+
parameters: {
|
|
1304
|
+
query?: never;
|
|
1305
|
+
header?: never;
|
|
1306
|
+
path?: never;
|
|
1307
|
+
cookie?: never;
|
|
1308
|
+
};
|
|
1309
|
+
/**
|
|
1310
|
+
* List public IP pools
|
|
1311
|
+
* @description Lists the public IP pools available for new allocations in this region.
|
|
1312
|
+
*/
|
|
1313
|
+
get: operations["list-ipv4-pools"];
|
|
1314
|
+
put?: never;
|
|
1315
|
+
post?: never;
|
|
1316
|
+
delete?: never;
|
|
1317
|
+
options?: never;
|
|
1318
|
+
head?: never;
|
|
1319
|
+
patch?: never;
|
|
1320
|
+
trace?: never;
|
|
1321
|
+
};
|
|
1125
1322
|
}
|
|
1126
1323
|
export type webhooks = Record<string, never>;
|
|
1127
1324
|
export interface components {
|
|
@@ -1129,6 +1326,10 @@ export interface components {
|
|
|
1129
1326
|
Error: {
|
|
1130
1327
|
code?: string;
|
|
1131
1328
|
message: string;
|
|
1329
|
+
/**
|
|
1330
|
+
* @description What a given `code` carries alongside the message. The keys depend on the code,
|
|
1331
|
+
* and a client that does not recognise one ignores it.
|
|
1332
|
+
*/
|
|
1132
1333
|
meta?: {
|
|
1133
1334
|
[key: string]: unknown;
|
|
1134
1335
|
};
|
|
@@ -1136,26 +1337,43 @@ export interface components {
|
|
|
1136
1337
|
status: number;
|
|
1137
1338
|
};
|
|
1138
1339
|
BackupResource: {
|
|
1139
|
-
/** @description 源云硬盘所在的可用区。恢复时可选择本地区的其他可用区 */
|
|
1140
|
-
availability_zone: string;
|
|
1141
1340
|
/** Format: date-time */
|
|
1142
1341
|
created_at: string;
|
|
1143
1342
|
/** Format: uuid */
|
|
1144
1343
|
id: string;
|
|
1145
1344
|
name: string;
|
|
1146
|
-
|
|
1345
|
+
/** Format: uuid */
|
|
1346
|
+
region_id: string;
|
|
1147
1347
|
/**
|
|
1148
1348
|
* Format: int64
|
|
1149
|
-
* @description
|
|
1349
|
+
* @description Capacity of the source disk when the backup was created. A restored disk cannot be smaller than this
|
|
1150
1350
|
*/
|
|
1151
1351
|
size_gb: number;
|
|
1152
1352
|
/**
|
|
1153
1353
|
* Format: uuid
|
|
1154
|
-
* @description
|
|
1354
|
+
* @description The disk this backup was taken from. The backup remains usable after that disk is deleted
|
|
1155
1355
|
*/
|
|
1156
1356
|
source_disk_id: string;
|
|
1157
1357
|
/** @enum {string} */
|
|
1158
1358
|
status: "provisioning" | "available" | "restoring" | "deleting" | "error";
|
|
1359
|
+
/** Format: uuid */
|
|
1360
|
+
order_id: string | null;
|
|
1361
|
+
/** Format: uuid */
|
|
1362
|
+
price_id: string | null;
|
|
1363
|
+
/** Format: uuid */
|
|
1364
|
+
subscription_item_id: string | null;
|
|
1365
|
+
/** @enum {string|null} */
|
|
1366
|
+
access_state: "pending" | "enabled" | "suspended" | "reclaimed" | null;
|
|
1367
|
+
task: components["schemas"]["Task"] | null;
|
|
1368
|
+
/** Format: int64 */
|
|
1369
|
+
generation: number;
|
|
1370
|
+
/** Format: date-time */
|
|
1371
|
+
observed_at: string | null;
|
|
1372
|
+
/**
|
|
1373
|
+
* Format: uuid
|
|
1374
|
+
* @description Availability zone of the source disk. A restore may target another zone in the same region
|
|
1375
|
+
*/
|
|
1376
|
+
source_availability_zone_id: string;
|
|
1159
1377
|
};
|
|
1160
1378
|
BackupListResponseBody: {
|
|
1161
1379
|
items: components["schemas"]["BackupResource"][] | null;
|
|
@@ -1164,6 +1382,9 @@ export interface components {
|
|
|
1164
1382
|
/** Format: uuid */
|
|
1165
1383
|
disk_id: string;
|
|
1166
1384
|
name: string;
|
|
1385
|
+
/** Format: uuid */
|
|
1386
|
+
price_id: string;
|
|
1387
|
+
order: components["schemas"]["OrderOptions"];
|
|
1167
1388
|
};
|
|
1168
1389
|
RenameBackupRequestBody: {
|
|
1169
1390
|
name: string;
|
|
@@ -1171,42 +1392,86 @@ export interface components {
|
|
|
1171
1392
|
RestoreBackupRequestBody: {
|
|
1172
1393
|
/**
|
|
1173
1394
|
* Format: uuid
|
|
1174
|
-
* @description
|
|
1395
|
+
* @description May differ from the availability zone of the source disk, but must be in the same region. It has to be on sale — restoring creates a new disk, so a withdrawn type is rejected here as well
|
|
1175
1396
|
*/
|
|
1176
1397
|
disk_type_id: string;
|
|
1177
1398
|
name: string;
|
|
1178
1399
|
/**
|
|
1179
1400
|
* Format: int64
|
|
1180
|
-
* @description
|
|
1401
|
+
* @description Matches the size of the backup when omitted. When given, it must not be smaller than the backup
|
|
1181
1402
|
*/
|
|
1182
1403
|
size_gb?: number;
|
|
1404
|
+
/** Format: uuid */
|
|
1405
|
+
price_id: string;
|
|
1406
|
+
order: components["schemas"]["OrderOptions"];
|
|
1183
1407
|
};
|
|
1184
1408
|
DiskResource: {
|
|
1185
|
-
|
|
1186
|
-
|
|
1187
|
-
|
|
1409
|
+
/**
|
|
1410
|
+
* Format: uuid
|
|
1411
|
+
* @description Availability zone the disk actually resides in. An instance must be in the same zone to attach it
|
|
1412
|
+
*/
|
|
1413
|
+
availability_zone_id: string;
|
|
1188
1414
|
/** Format: date-time */
|
|
1189
1415
|
created_at: string;
|
|
1190
|
-
/** @description 系统分配的设备名,在云服务器内看到的即为该名称 */
|
|
1191
|
-
device: string | null;
|
|
1192
1416
|
/** Format: uuid */
|
|
1193
1417
|
disk_type_id: string;
|
|
1194
1418
|
/** Format: uuid */
|
|
1195
1419
|
id: string;
|
|
1196
|
-
/** @description 系统盘随云服务器一并释放,不能卸载也不能单独删除 */
|
|
1197
|
-
is_system: boolean;
|
|
1198
1420
|
name: string;
|
|
1199
|
-
|
|
1421
|
+
/** Format: uuid */
|
|
1422
|
+
region_id: string;
|
|
1200
1423
|
/** Format: int64 */
|
|
1201
1424
|
size_gb: number;
|
|
1425
|
+
/**
|
|
1426
|
+
* Format: int64
|
|
1427
|
+
* @description IOPS this disk is allowed. Null when its type is not rate-limited.
|
|
1428
|
+
*
|
|
1429
|
+
* Computed from the disk's own capacity, so it grows when the disk is grown — but see the
|
|
1430
|
+
* note on the resize endpoint: growing a disk that is attached is refused, precisely because
|
|
1431
|
+
* the new figure would not take effect until it was attached again.
|
|
1432
|
+
*/
|
|
1433
|
+
iops: number | null;
|
|
1434
|
+
/**
|
|
1435
|
+
* Format: int64
|
|
1436
|
+
* @description Throughput this disk is allowed, in bytes per second. Null when its type is not rate-limited
|
|
1437
|
+
*/
|
|
1438
|
+
throughput_bytes_per_sec: number | null;
|
|
1202
1439
|
/** @enum {string} */
|
|
1203
1440
|
status: "provisioning" | "available" | "attaching" | "in_use" | "detaching" | "resizing" | "reverting" | "restoring" | "releasing" | "deleting" | "error";
|
|
1441
|
+
/** Format: uuid */
|
|
1442
|
+
order_id: string | null;
|
|
1443
|
+
/** Format: uuid */
|
|
1444
|
+
price_id: string | null;
|
|
1445
|
+
/** Format: uuid */
|
|
1446
|
+
subscription_item_id: string | null;
|
|
1447
|
+
/** @enum {string|null} */
|
|
1448
|
+
access_state: "pending" | "enabled" | "suspended" | "reclaimed" | null;
|
|
1449
|
+
task: components["schemas"]["Task"] | null;
|
|
1450
|
+
attachment?: components["schemas"]["DiskAttachment"] | null;
|
|
1451
|
+
/** Format: int64 */
|
|
1452
|
+
generation: number;
|
|
1453
|
+
/** Format: date-time */
|
|
1454
|
+
observed_at: string | null;
|
|
1204
1455
|
};
|
|
1205
1456
|
DiskTypeResource: {
|
|
1206
|
-
|
|
1457
|
+
/** Format: uuid */
|
|
1458
|
+
availability_zone_id: string;
|
|
1207
1459
|
/** Format: uuid */
|
|
1208
1460
|
id: string;
|
|
1209
|
-
|
|
1461
|
+
/**
|
|
1462
|
+
* Format: int64
|
|
1463
|
+
* @description IOPS a disk of `min_size_gb` gets. Null when this type is not rate-limited.
|
|
1464
|
+
*
|
|
1465
|
+
* Performance grows with capacity, so this and `iops_at_max_size` are the two ends of the
|
|
1466
|
+
* range. The exact figure for the size actually bought appears on the disk itself once it
|
|
1467
|
+
* exists.
|
|
1468
|
+
*/
|
|
1469
|
+
iops_at_min_size: number | null;
|
|
1470
|
+
/**
|
|
1471
|
+
* Format: int64
|
|
1472
|
+
* @description IOPS a disk of `max_size_gb` gets. Null when this type is not rate-limited
|
|
1473
|
+
*/
|
|
1474
|
+
iops_at_max_size: number | null;
|
|
1210
1475
|
/** Format: int64 */
|
|
1211
1476
|
max_size_gb: number;
|
|
1212
1477
|
/** @enum {string} */
|
|
@@ -1214,10 +1479,37 @@ export interface components {
|
|
|
1214
1479
|
/** Format: int64 */
|
|
1215
1480
|
min_size_gb: number;
|
|
1216
1481
|
name: string;
|
|
1217
|
-
|
|
1482
|
+
/** Format: uuid */
|
|
1483
|
+
region_id: string;
|
|
1218
1484
|
/** Format: int64 */
|
|
1219
1485
|
step_gb: number;
|
|
1220
|
-
|
|
1486
|
+
/**
|
|
1487
|
+
* Format: int64
|
|
1488
|
+
* @description Throughput a disk of `min_size_gb` gets, in **bytes per second**. Null when this type is
|
|
1489
|
+
* not rate-limited.
|
|
1490
|
+
*
|
|
1491
|
+
* Bytes rather than MiB so the number needs no rounding on the way out; divide by 1048576
|
|
1492
|
+
* for MiB/s at the point of display.
|
|
1493
|
+
*/
|
|
1494
|
+
throughput_at_min_size: number | null;
|
|
1495
|
+
/**
|
|
1496
|
+
* Format: int64
|
|
1497
|
+
* @description Throughput a disk of `max_size_gb` gets, in bytes per second. Null when this type is not rate-limited
|
|
1498
|
+
*/
|
|
1499
|
+
throughput_at_max_size: number | null;
|
|
1500
|
+
/** Format: uuid */
|
|
1501
|
+
product_id: string | null;
|
|
1502
|
+
/** Format: uuid */
|
|
1503
|
+
plan_id: string | null;
|
|
1504
|
+
name_translations: {
|
|
1505
|
+
[key: string]: string;
|
|
1506
|
+
};
|
|
1507
|
+
/** Format: uuid */
|
|
1508
|
+
snapshot_plan_id: string | null;
|
|
1509
|
+
/** Format: uuid */
|
|
1510
|
+
backup_plan_id: string | null;
|
|
1511
|
+
/** Format: uuid */
|
|
1512
|
+
private_image_plan_id: string | null;
|
|
1221
1513
|
};
|
|
1222
1514
|
DiskTypeListResponseBody: {
|
|
1223
1515
|
items: components["schemas"]["DiskTypeResource"][] | null;
|
|
@@ -1226,6 +1518,8 @@ export interface components {
|
|
|
1226
1518
|
architecture: string;
|
|
1227
1519
|
/** Format: uuid */
|
|
1228
1520
|
id: string;
|
|
1521
|
+
/** @description The account this image lets you log in as. The password set at creation belongs to this account */
|
|
1522
|
+
login_username: string;
|
|
1229
1523
|
/** Format: int64 */
|
|
1230
1524
|
min_disk_gb: number;
|
|
1231
1525
|
/** Format: int64 */
|
|
@@ -1233,20 +1527,48 @@ export interface components {
|
|
|
1233
1527
|
name: string;
|
|
1234
1528
|
os_family: string;
|
|
1235
1529
|
os_version: string;
|
|
1236
|
-
|
|
1237
|
-
|
|
1530
|
+
/** Format: uuid */
|
|
1531
|
+
region_id: string;
|
|
1532
|
+
/** @description False means a new password can only be set by rebuilding an instance created from this image */
|
|
1238
1533
|
supports_password_reset: boolean;
|
|
1239
1534
|
};
|
|
1240
1535
|
ImageListResponseBody: {
|
|
1241
|
-
items: components["schemas"]["ImageResource"][]
|
|
1536
|
+
items: components["schemas"]["ImageResource"][];
|
|
1537
|
+
/** Format: int64 */
|
|
1538
|
+
page: number;
|
|
1539
|
+
/** Format: int64 */
|
|
1540
|
+
page_size: number;
|
|
1541
|
+
/** Format: int64 */
|
|
1542
|
+
total_count?: number;
|
|
1242
1543
|
};
|
|
1243
1544
|
InstanceTypeResource: {
|
|
1244
|
-
/**
|
|
1245
|
-
|
|
1545
|
+
/** Format: uuid */
|
|
1546
|
+
availability_zone_id: string;
|
|
1246
1547
|
/** Format: uuid */
|
|
1247
1548
|
id: string;
|
|
1248
|
-
/**
|
|
1549
|
+
/**
|
|
1550
|
+
* Format: int64
|
|
1551
|
+
* @description The most public bandwidth a machine of this type may be given, in Mbps. Asking for more
|
|
1552
|
+
* when creating a machine, or raising a bound address past it, is refused.
|
|
1553
|
+
*
|
|
1554
|
+
* A ceiling on what can be bought, not a speed. How fast the machine's own interfaces run is
|
|
1555
|
+
* `network_egress_kbps` / `network_ingress_kbps`.
|
|
1556
|
+
*/
|
|
1249
1557
|
max_bandwidth_mbps: number;
|
|
1558
|
+
/**
|
|
1559
|
+
* Format: int64
|
|
1560
|
+
* @description Outbound ceiling of **each** network interface, in kbps. Null when this type is not
|
|
1561
|
+
* rate-limited.
|
|
1562
|
+
*
|
|
1563
|
+
* Per interface rather than per machine: a machine with two interfaces has this ceiling on
|
|
1564
|
+
* each of them, not shared between them. `max_ports` says how many it may have.
|
|
1565
|
+
*/
|
|
1566
|
+
network_egress_kbps: number | null;
|
|
1567
|
+
/**
|
|
1568
|
+
* Format: int64
|
|
1569
|
+
* @description Inbound ceiling of each network interface, in kbps. Null when this type is not rate-limited
|
|
1570
|
+
*/
|
|
1571
|
+
network_ingress_kbps: number | null;
|
|
1250
1572
|
/** Format: int64 */
|
|
1251
1573
|
max_floating_ips: number;
|
|
1252
1574
|
/** Format: int64 */
|
|
@@ -1254,24 +1576,47 @@ export interface components {
|
|
|
1254
1576
|
name: string;
|
|
1255
1577
|
/** Format: int64 */
|
|
1256
1578
|
ram_mb: number;
|
|
1257
|
-
|
|
1579
|
+
/** Format: uuid */
|
|
1580
|
+
region_id: string;
|
|
1258
1581
|
/** Format: int64 */
|
|
1259
1582
|
vcpus: number;
|
|
1583
|
+
/** Format: uuid */
|
|
1584
|
+
product_id: string | null;
|
|
1585
|
+
/** Format: uuid */
|
|
1586
|
+
plan_id: string | null;
|
|
1587
|
+
name_translations: {
|
|
1588
|
+
[key: string]: string;
|
|
1589
|
+
};
|
|
1260
1590
|
};
|
|
1261
1591
|
InstanceTypeListResponseBody: {
|
|
1262
|
-
items: components["schemas"]["InstanceTypeResource"][]
|
|
1592
|
+
items: components["schemas"]["InstanceTypeResource"][];
|
|
1593
|
+
/** Format: int64 */
|
|
1594
|
+
page: number;
|
|
1595
|
+
/** Format: int64 */
|
|
1596
|
+
page_size: number;
|
|
1597
|
+
/** Format: int64 */
|
|
1598
|
+
total_count?: number;
|
|
1263
1599
|
};
|
|
1264
1600
|
RegionResource: {
|
|
1265
|
-
|
|
1601
|
+
/** @description ISO 3166-1 alpha-2 country this region sits in. Two letters, uppercase. */
|
|
1266
1602
|
country_code: string;
|
|
1603
|
+
/** @description Display name for this place, shown to tenants (Hong Kong). It is the translatable one; the stable handle is code. */
|
|
1267
1604
|
name: string;
|
|
1605
|
+
/** @description The region's code, the way the outside world names this place (hk-1). Stable and human-written; addressing is by id. */
|
|
1606
|
+
code: string;
|
|
1607
|
+
/** Format: uuid */
|
|
1608
|
+
id: string;
|
|
1268
1609
|
};
|
|
1269
1610
|
RegionListResponseBody: {
|
|
1270
1611
|
items: components["schemas"]["RegionResource"][] | null;
|
|
1271
1612
|
};
|
|
1272
1613
|
ZoneResource: {
|
|
1273
|
-
code
|
|
1614
|
+
/** @description Display name for this zone, shown to tenants (Hong Kong A). It is the translatable one; the stable handle is code. */
|
|
1274
1615
|
name: string;
|
|
1616
|
+
/** @description The zone's code within its region (hk-1-a). Stable and human-written; addressing is by id. */
|
|
1617
|
+
code: string;
|
|
1618
|
+
/** Format: uuid */
|
|
1619
|
+
id: string;
|
|
1275
1620
|
};
|
|
1276
1621
|
ZoneListResponseBody: {
|
|
1277
1622
|
items: components["schemas"]["ZoneResource"][] | null;
|
|
@@ -1280,16 +1625,22 @@ export interface components {
|
|
|
1280
1625
|
items: components["schemas"]["DiskResource"][] | null;
|
|
1281
1626
|
};
|
|
1282
1627
|
CreateDiskRequestBody: {
|
|
1283
|
-
/**
|
|
1628
|
+
/**
|
|
1629
|
+
* Format: uuid
|
|
1630
|
+
* @description A disk type currently on sale. A withdrawn one is rejected even though its identifier still resolves
|
|
1631
|
+
*/
|
|
1284
1632
|
disk_type_id: string;
|
|
1285
1633
|
name: string;
|
|
1286
1634
|
/** Format: int64 */
|
|
1287
1635
|
size_gb: number;
|
|
1288
1636
|
/**
|
|
1289
1637
|
* Format: uuid
|
|
1290
|
-
* @description
|
|
1638
|
+
* @description Restore from this snapshot. When given, the capacity need only be no smaller than the snapshot
|
|
1291
1639
|
*/
|
|
1292
1640
|
snapshot_id?: string;
|
|
1641
|
+
/** Format: uuid */
|
|
1642
|
+
price_id: string;
|
|
1643
|
+
order: components["schemas"]["OrderOptions"];
|
|
1293
1644
|
};
|
|
1294
1645
|
RenameDiskRequestBody: {
|
|
1295
1646
|
name: string;
|
|
@@ -1297,210 +1648,333 @@ export interface components {
|
|
|
1297
1648
|
ResizeDiskRequestBody: {
|
|
1298
1649
|
/**
|
|
1299
1650
|
* Format: int64
|
|
1300
|
-
* @description
|
|
1651
|
+
* @description Must be larger than the current capacity
|
|
1301
1652
|
*/
|
|
1302
1653
|
size_gb: number;
|
|
1654
|
+
/** Format: uuid */
|
|
1655
|
+
price_id: string;
|
|
1656
|
+
order: components["schemas"]["OrderOptions"];
|
|
1303
1657
|
};
|
|
1304
1658
|
RevertDiskRequestBody: {
|
|
1305
1659
|
/**
|
|
1306
1660
|
* Format: uuid
|
|
1307
|
-
* @description
|
|
1661
|
+
* @description Must be the most recent snapshot of the disk
|
|
1308
1662
|
*/
|
|
1309
1663
|
snapshot_id: string;
|
|
1310
1664
|
};
|
|
1311
1665
|
FloatingIPResource: {
|
|
1312
1666
|
address: string;
|
|
1313
|
-
attached_fixed_ip: string | null;
|
|
1314
|
-
attached_port_id: string | null;
|
|
1315
1667
|
/** Format: int64 */
|
|
1316
1668
|
bandwidth_mbps: number | null;
|
|
1317
1669
|
/** Format: date-time */
|
|
1318
1670
|
created_at: string;
|
|
1319
|
-
/** Format: date-time */
|
|
1320
|
-
detached_at: string | null;
|
|
1321
1671
|
/** Format: uuid */
|
|
1322
1672
|
id: string;
|
|
1323
|
-
|
|
1324
|
-
|
|
1325
|
-
|
|
1326
|
-
|
|
1327
|
-
|
|
1328
|
-
|
|
1329
|
-
|
|
1330
|
-
|
|
1331
|
-
|
|
1332
|
-
|
|
1333
|
-
|
|
1334
|
-
|
|
1673
|
+
/** Format: uuid */
|
|
1674
|
+
region_id: string;
|
|
1675
|
+
/** @enum {string} */
|
|
1676
|
+
status: "pending" | "available" | "deleting" | "error" | "unknown";
|
|
1677
|
+
/** Format: uuid */
|
|
1678
|
+
order_id: string | null;
|
|
1679
|
+
/** Format: uuid */
|
|
1680
|
+
price_id: string | null;
|
|
1681
|
+
/** Format: uuid */
|
|
1682
|
+
subscription_item_id: string | null;
|
|
1683
|
+
/** @enum {string|null} */
|
|
1684
|
+
access_state: "pending" | "enabled" | "suspended" | "reclaimed" | null;
|
|
1685
|
+
task: components["schemas"]["Task"] | null;
|
|
1686
|
+
/** Format: uuid */
|
|
1687
|
+
bandwidth_order_id: string | null;
|
|
1688
|
+
/** Format: uuid */
|
|
1689
|
+
bandwidth_price_id: string | null;
|
|
1690
|
+
/** Format: uuid */
|
|
1691
|
+
bandwidth_subscription_item_id: string | null;
|
|
1692
|
+
/** @enum {string|null} */
|
|
1693
|
+
bandwidth_access_state: "pending" | "enabled" | "suspended" | "reclaimed" | null;
|
|
1694
|
+
/** Format: int64 */
|
|
1695
|
+
generation: number;
|
|
1696
|
+
/** Format: date-time */
|
|
1697
|
+
observed_at: string | null;
|
|
1698
|
+
binding: components["schemas"]["IPv4Binding"] | null;
|
|
1699
|
+
};
|
|
1700
|
+
FloatingIPListResponseBody: {
|
|
1701
|
+
items: components["schemas"]["FloatingIPResource"][] | null;
|
|
1702
|
+
};
|
|
1703
|
+
AllocateFloatingIPRequestBody: {
|
|
1704
|
+
/** @description The address to allocate. Allocated by the platform when omitted */
|
|
1335
1705
|
address?: string;
|
|
1706
|
+
/**
|
|
1707
|
+
* Format: int64
|
|
1708
|
+
* @description The bandwidth ceiling of this address, in Mbit/s, applied to both directions.
|
|
1709
|
+
*
|
|
1710
|
+
* Required, and there is no "unlimited": an address with no ceiling runs at line rate and is
|
|
1711
|
+
* charged nothing for the traffic, while the address itself bills normally — so the invoice
|
|
1712
|
+
* looks correct and nothing anywhere reports it.
|
|
1713
|
+
*
|
|
1714
|
+
* It is billed separately from the address, per Mbit/s-hour, and appears as its own line on
|
|
1715
|
+
* the order. Changing it later goes through the bandwidth endpoint.
|
|
1716
|
+
*/
|
|
1717
|
+
bandwidth_mbps: number;
|
|
1336
1718
|
/** Format: uuid */
|
|
1337
1719
|
private_network_id: string;
|
|
1720
|
+
/** Format: uuid */
|
|
1721
|
+
ipv4_pool_id: string;
|
|
1722
|
+
/** Format: uuid */
|
|
1723
|
+
price_id: string;
|
|
1724
|
+
/** Format: uuid */
|
|
1725
|
+
bandwidth_price_id: string;
|
|
1726
|
+
order: components["schemas"]["OrderOptions"];
|
|
1338
1727
|
};
|
|
1339
1728
|
SetBandwidthRequestBody: {
|
|
1340
1729
|
/**
|
|
1341
1730
|
* Format: int64
|
|
1342
|
-
* @description
|
|
1731
|
+
* @description Applied to both directions
|
|
1343
1732
|
*/
|
|
1344
1733
|
mbps: number;
|
|
1734
|
+
/** Format: uuid */
|
|
1735
|
+
price_id: string;
|
|
1736
|
+
order: components["schemas"]["OrderOptions"];
|
|
1345
1737
|
};
|
|
1346
1738
|
BindFloatingIPRequestBody: {
|
|
1347
1739
|
/** Format: uuid */
|
|
1348
|
-
|
|
1740
|
+
port_address_id: string;
|
|
1349
1741
|
};
|
|
1350
1742
|
InstanceResource: {
|
|
1351
|
-
|
|
1743
|
+
/** Format: uuid */
|
|
1744
|
+
availability_zone_id: string;
|
|
1352
1745
|
/** Format: date-time */
|
|
1353
1746
|
created_at: string;
|
|
1354
|
-
/** @description
|
|
1747
|
+
/** @description Hostname inside the instance; equals the instance id */
|
|
1355
1748
|
hostname: string;
|
|
1356
1749
|
/** Format: uuid */
|
|
1357
1750
|
id: string;
|
|
1358
1751
|
/**
|
|
1359
1752
|
* Format: uuid
|
|
1360
|
-
* @description
|
|
1753
|
+
* @description Non-empty when the instance was created from a platform image
|
|
1361
1754
|
*/
|
|
1362
1755
|
image_id: string | null;
|
|
1363
1756
|
/**
|
|
1364
1757
|
* Format: uuid
|
|
1365
|
-
* @description
|
|
1758
|
+
* @description The instance type in effect, and the basis for billing
|
|
1366
1759
|
*/
|
|
1367
1760
|
instance_type_id: string;
|
|
1368
|
-
/** @description
|
|
1761
|
+
/** @description IPv6 address of the primary network interface. Assigned automatically once IPv6 is enabled on the private network */
|
|
1369
1762
|
ipv6_address: string | null;
|
|
1763
|
+
/** @description Your own classification of this instance, as key-value pairs. Empty when never set */
|
|
1764
|
+
labels: {
|
|
1765
|
+
[key: string]: string;
|
|
1766
|
+
};
|
|
1767
|
+
/** @description The account to log in as over SSH. The password set at creation belongs to this account */
|
|
1768
|
+
login_username: string;
|
|
1370
1769
|
name: string;
|
|
1770
|
+
/** @description A free-text note about this instance. Empty when never set */
|
|
1771
|
+
notes: string;
|
|
1371
1772
|
/**
|
|
1372
1773
|
* Format: uuid
|
|
1373
|
-
* @description
|
|
1374
|
-
*/
|
|
1375
|
-
pending_instance_type_id: string | null;
|
|
1376
|
-
/**
|
|
1377
|
-
* Format: uuid
|
|
1378
|
-
* @description 从自制的私有镜像创建时非空
|
|
1774
|
+
* @description Non-empty when the instance was created from a private image
|
|
1379
1775
|
*/
|
|
1380
1776
|
private_image_id: string | null;
|
|
1381
|
-
/** @description
|
|
1777
|
+
/** @description Private address of the instance */
|
|
1382
1778
|
private_ip: string | null;
|
|
1383
|
-
/**
|
|
1779
|
+
/** Format: uuid */
|
|
1384
1780
|
private_network_id: string | null;
|
|
1385
|
-
/** @description
|
|
1781
|
+
/** @description Floating IPv4 addresses bound to the primary network interface; an empty array when none are bound */
|
|
1386
1782
|
public_ips: string[] | null;
|
|
1387
|
-
|
|
1783
|
+
/** Format: uuid */
|
|
1784
|
+
region_id: string;
|
|
1388
1785
|
/** @enum {string} */
|
|
1389
|
-
status: "
|
|
1390
|
-
/**
|
|
1786
|
+
status: "pending" | "building" | "active" | "stopped" | "paused" | "suspended" | "shelved" | "shelved_offloaded" | "rescued" | "resized" | "deleting" | "deleted" | "error" | "unknown";
|
|
1787
|
+
/** Format: uuid */
|
|
1391
1788
|
subnet_id: string | null;
|
|
1392
|
-
/**
|
|
1393
|
-
* Format: date-time
|
|
1394
|
-
* @description 非空表示已被平台停服,需先解除后才能操作
|
|
1395
|
-
*/
|
|
1396
|
-
suspended_at: string | null;
|
|
1397
1789
|
/** Format: date-time */
|
|
1398
1790
|
updated_at: string;
|
|
1791
|
+
/** @enum {string} */
|
|
1792
|
+
desired_state: "running" | "stopped" | "deleted";
|
|
1793
|
+
/** @enum {string} */
|
|
1794
|
+
power_state: "no_state" | "running" | "paused" | "shutdown" | "crashed" | "suspended" | "unknown";
|
|
1795
|
+
/** @description Current provider task, such as scheduling, networking, block_device_mapping or spawning. none means no task; unknown tasks remain observable and do not imply failure. */
|
|
1796
|
+
task_state: string;
|
|
1797
|
+
/** Format: int64 */
|
|
1798
|
+
generation: number;
|
|
1799
|
+
/** Format: date-time */
|
|
1800
|
+
observed_at: string | null;
|
|
1801
|
+
restrictions: components["schemas"]["InstanceRestriction"][];
|
|
1802
|
+
task: components["schemas"]["Task"] | null;
|
|
1803
|
+
/** Format: uuid */
|
|
1804
|
+
order_id: string | null;
|
|
1805
|
+
/** Format: uuid */
|
|
1806
|
+
price_id: string | null;
|
|
1807
|
+
/** Format: uuid */
|
|
1808
|
+
subscription_item_id: string | null;
|
|
1809
|
+
/** @enum {string|null} */
|
|
1810
|
+
access_state: "pending" | "enabled" | "suspended" | "reclaimed" | null;
|
|
1811
|
+
/**
|
|
1812
|
+
* Format: uuid
|
|
1813
|
+
* @description Non-empty when the instance was created from a disk you already had, instead of from an image
|
|
1814
|
+
*/
|
|
1815
|
+
source_disk_id: string | null;
|
|
1399
1816
|
};
|
|
1400
1817
|
InstanceListResponseBody: {
|
|
1401
|
-
items: components["schemas"]["InstanceResource"][]
|
|
1818
|
+
items: components["schemas"]["InstanceResource"][];
|
|
1819
|
+
/** Format: int64 */
|
|
1820
|
+
page: number;
|
|
1821
|
+
/** Format: int64 */
|
|
1822
|
+
page_size: number;
|
|
1823
|
+
/** Format: int64 */
|
|
1824
|
+
total_count?: number;
|
|
1402
1825
|
};
|
|
1403
1826
|
LaunchInstanceRequestBody: {
|
|
1827
|
+
/**
|
|
1828
|
+
* Format: uuid
|
|
1829
|
+
* @description Bind a floating IP you already hold, instead of allocating a new one. It must be idle and in
|
|
1830
|
+
* the same region.
|
|
1831
|
+
*
|
|
1832
|
+
* Mutually exclusive with `bandwidth_mbps`: an address you already hold has its own bandwidth
|
|
1833
|
+
* ceiling, set when it was allocated, and changing it is a separate operation.
|
|
1834
|
+
*
|
|
1835
|
+
* Like `bandwidth_mbps`, this happens **inside the creation**: if binding fails, no instance is
|
|
1836
|
+
* created. Binding afterwards is still possible from the instance page, but then it is two
|
|
1837
|
+
* operations and a failure in between leaves an instance you cannot reach.
|
|
1838
|
+
*
|
|
1839
|
+
* Only one instance can be created when it is used — one address binds to one interface.
|
|
1840
|
+
*/
|
|
1841
|
+
floating_ip_id?: string;
|
|
1404
1842
|
/**
|
|
1405
1843
|
* Format: int64
|
|
1406
|
-
* @description
|
|
1844
|
+
* @description Number of instances to create; 1 when omitted. Names are numbered automatically for several
|
|
1845
|
+
* @default 1
|
|
1407
1846
|
*/
|
|
1408
1847
|
count?: number;
|
|
1409
|
-
/** @description
|
|
1848
|
+
/** @description Have the platform generate a random password, returned only in this response */
|
|
1410
1849
|
generate_password?: boolean;
|
|
1411
1850
|
/**
|
|
1412
1851
|
* Format: uuid
|
|
1413
|
-
* @description
|
|
1852
|
+
* @description Boot a disk you already have instead of installing an image. The disk must be available, unattached, and in the same availability zone as the instance type. Exactly one of this, `image_id` and `private_image_id`
|
|
1853
|
+
*/
|
|
1854
|
+
boot_disk_id?: string;
|
|
1855
|
+
/**
|
|
1856
|
+
* Format: uuid
|
|
1857
|
+
* @description A platform image, and it must be one currently on sale. Exactly one of this, `private_image_id` and `boot_disk_id`
|
|
1414
1858
|
*/
|
|
1415
1859
|
image_id?: string;
|
|
1416
|
-
/**
|
|
1860
|
+
/**
|
|
1861
|
+
* Format: uuid
|
|
1862
|
+
* @description An instance type currently on sale. A withdrawn one is rejected even though its identifier still resolves
|
|
1863
|
+
*/
|
|
1417
1864
|
instance_type_id: string;
|
|
1865
|
+
/** @description The account the disk lets you log in as. Required with `boot_disk_id`, and rejected without it since an image states its own */
|
|
1866
|
+
login_username?: string;
|
|
1418
1867
|
name: string;
|
|
1419
|
-
/** @description root
|
|
1868
|
+
/** @description The password to set, on the login account and on root. Only the SSH public keys of the project are used when omitted */
|
|
1420
1869
|
password?: string;
|
|
1421
1870
|
/**
|
|
1422
1871
|
* Format: uuid
|
|
1423
|
-
* @description
|
|
1872
|
+
* @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
1873
|
*/
|
|
1425
1874
|
port_id?: string;
|
|
1426
1875
|
/**
|
|
1427
1876
|
* Format: uuid
|
|
1428
|
-
* @description
|
|
1877
|
+
* @description A private image. Exactly one of this, `image_id` and `boot_disk_id`
|
|
1429
1878
|
*/
|
|
1430
1879
|
private_image_id?: string;
|
|
1431
|
-
/**
|
|
1432
|
-
* Format: int64
|
|
1433
|
-
* @description 系统盘容量(GB)。留空时按镜像要求与平台下限自动选择
|
|
1434
|
-
*/
|
|
1435
|
-
root_disk_gb?: number;
|
|
1436
|
-
/** @description 新建主网卡时必填,至少一个;不会自动使用默认安全组。使用 port_id 时忽略——那张网卡的安全组在创建它时已经定了 */
|
|
1880
|
+
/** @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
1881
|
security_group_ids?: string[] | null;
|
|
1438
1882
|
/**
|
|
1439
1883
|
* Format: uuid
|
|
1440
|
-
* @description
|
|
1884
|
+
* @description Create the primary network interface in this subnet. Exactly one of this and `port_id`
|
|
1441
1885
|
*/
|
|
1442
1886
|
subnet_id?: string;
|
|
1887
|
+
order: components["schemas"]["OrderOptions"];
|
|
1888
|
+
/** Format: uuid */
|
|
1889
|
+
price_id: string;
|
|
1890
|
+
boot_disk?: components["schemas"]["NewBootDisk"];
|
|
1891
|
+
floating_ip?: components["schemas"]["NewFloatingIP"];
|
|
1443
1892
|
};
|
|
1444
|
-
|
|
1445
|
-
/** @description
|
|
1446
|
-
|
|
1447
|
-
|
|
1448
|
-
|
|
1449
|
-
|
|
1450
|
-
|
|
1893
|
+
SetInstanceLabelsRequestBody: {
|
|
1894
|
+
/** @description The complete set of labels. Whatever is absent here is removed; send an empty object to clear them all. A key may not contain a colon, whitespace or control characters */
|
|
1895
|
+
labels: {
|
|
1896
|
+
[key: string]: string;
|
|
1897
|
+
};
|
|
1898
|
+
};
|
|
1899
|
+
SetInstanceNotesRequestBody: {
|
|
1900
|
+
/** @description The complete note. Send an empty string to clear it */
|
|
1901
|
+
notes: string;
|
|
1451
1902
|
};
|
|
1452
1903
|
RenameInstanceRequestBody: {
|
|
1453
1904
|
name: string;
|
|
1454
1905
|
};
|
|
1455
|
-
|
|
1456
|
-
/** @
|
|
1457
|
-
action: "start" | "stop" | "reboot";
|
|
1458
|
-
/** @description 仅适用于 reboot。强制重启不等待操作系统正常关闭,未落盘的数据会丢失,用于系统已无响应的情况 */
|
|
1906
|
+
RebootInstanceRequestBody: {
|
|
1907
|
+
/** @description 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. False when omitted */
|
|
1459
1908
|
force?: boolean;
|
|
1460
1909
|
};
|
|
1910
|
+
RunCommandRequestBody: {
|
|
1911
|
+
/** @description Run by the login shell, so pipes, redirection and `&&` work. It cannot read standard input */
|
|
1912
|
+
command: string;
|
|
1913
|
+
/**
|
|
1914
|
+
* Format: int64
|
|
1915
|
+
* @description Kill the command after this long. 60 when omitted
|
|
1916
|
+
*/
|
|
1917
|
+
timeout_seconds?: number;
|
|
1918
|
+
};
|
|
1919
|
+
CommandResultResponseBody: {
|
|
1920
|
+
/**
|
|
1921
|
+
* Format: int64
|
|
1922
|
+
* @description What the command exited with, 0 being success. Any other value is the command's own verdict and still arrives as a 200. Null when it was killed rather than exiting on its own, which includes the timeout — null is the absence of a verdict, not a successful one
|
|
1923
|
+
*/
|
|
1924
|
+
exit_code: number | null;
|
|
1925
|
+
stderr: string;
|
|
1926
|
+
stdout: string;
|
|
1927
|
+
/** @description True when the command was still running at the timeout and was killed */
|
|
1928
|
+
timed_out: boolean;
|
|
1929
|
+
/** @description True when either stream hit the 1 MiB cap and the rest was discarded */
|
|
1930
|
+
truncated: boolean;
|
|
1931
|
+
};
|
|
1461
1932
|
ConsoleResponseBody: {
|
|
1462
|
-
/** @description
|
|
1933
|
+
/** @description Connection address of the remote console; single-use and expires within minutes */
|
|
1463
1934
|
console_url: string;
|
|
1464
1935
|
};
|
|
1465
1936
|
ConsoleOutputResponseBody: {
|
|
1466
|
-
/** @description
|
|
1937
|
+
/** @description Raw text of the console output, in the same line order as inside the instance */
|
|
1467
1938
|
output: string;
|
|
1468
1939
|
};
|
|
1469
1940
|
ResetPasswordRequestBody: {
|
|
1470
|
-
/** @description
|
|
1941
|
+
/** @description Have the platform generate a random password, returned only in this response */
|
|
1471
1942
|
generate_password?: boolean;
|
|
1472
|
-
/** @description
|
|
1943
|
+
/** @description New root password. Exactly one of this and `generate_password` */
|
|
1473
1944
|
password?: string;
|
|
1474
1945
|
};
|
|
1475
1946
|
ResetPasswordResponseBody: {
|
|
1476
|
-
/** @description
|
|
1947
|
+
/** @description The password generated by the platform, returned only in this response. Empty when the password was supplied in the request */
|
|
1477
1948
|
password: string;
|
|
1478
1949
|
};
|
|
1479
1950
|
RebuildInstanceRequestBody: {
|
|
1480
1951
|
generate_password?: boolean;
|
|
1481
1952
|
/**
|
|
1482
1953
|
* Format: uuid
|
|
1483
|
-
* @description
|
|
1954
|
+
* @description A platform image, which must be on sale unless it is the one this instance already runs. Exactly one of this and `private_image_id`
|
|
1484
1955
|
*/
|
|
1485
1956
|
image_id?: string;
|
|
1486
1957
|
password?: string;
|
|
1487
1958
|
/**
|
|
1488
1959
|
* Format: uuid
|
|
1489
|
-
* @description
|
|
1960
|
+
* @description A private image. Exactly one of this and `image_id`
|
|
1490
1961
|
*/
|
|
1491
1962
|
private_image_id?: string;
|
|
1492
1963
|
};
|
|
1493
1964
|
RebuildInstanceResponseBody: {
|
|
1494
1965
|
instance: components["schemas"]["InstanceResource"];
|
|
1495
|
-
/** @description
|
|
1966
|
+
/** @description Returned only in this response; store it immediately */
|
|
1496
1967
|
password: string;
|
|
1497
1968
|
};
|
|
1498
1969
|
ResizeInstanceRequestBody: {
|
|
1499
1970
|
/**
|
|
1500
1971
|
* Format: uuid
|
|
1501
|
-
* @description
|
|
1972
|
+
* @description Must be in the same region and availability zone as the current instance type
|
|
1502
1973
|
*/
|
|
1503
1974
|
instance_type_id: string;
|
|
1975
|
+
order: components["schemas"]["OrderOptions"];
|
|
1976
|
+
/** Format: uuid */
|
|
1977
|
+
price_id: string;
|
|
1504
1978
|
};
|
|
1505
1979
|
AttachDiskRequestBody: {
|
|
1506
1980
|
/** Format: uuid */
|
|
@@ -1511,21 +1985,22 @@ export interface components {
|
|
|
1511
1985
|
floating_ip_id: string;
|
|
1512
1986
|
};
|
|
1513
1987
|
PortResource: {
|
|
1514
|
-
attached_instance_id: string | null;
|
|
1515
1988
|
/** Format: uuid */
|
|
1516
1989
|
id: string;
|
|
1517
|
-
ipv6_address: string | null;
|
|
1518
|
-
/** @description 主网卡随云服务器一并创建和释放,不可单独卸载 */
|
|
1519
|
-
is_primary: boolean;
|
|
1520
1990
|
mac: string | null;
|
|
1521
1991
|
name: string;
|
|
1522
|
-
private_ip: string | null;
|
|
1523
1992
|
/** Format: uuid */
|
|
1524
1993
|
private_network_id: string;
|
|
1525
|
-
/** @description
|
|
1994
|
+
/** @description Floating IPv4 addresses bound to this network interface; an empty array when none are bound */
|
|
1526
1995
|
public_ips: string[] | null;
|
|
1527
|
-
|
|
1528
|
-
|
|
1996
|
+
addresses?: components["schemas"]["PortAddress"][];
|
|
1997
|
+
attachment?: components["schemas"]["PortAttachment"] | null;
|
|
1998
|
+
/** @enum {string} */
|
|
1999
|
+
status: "pending" | "available" | "deleting" | "error" | "unknown";
|
|
2000
|
+
/** Format: int64 */
|
|
2001
|
+
generation: number;
|
|
2002
|
+
/** Format: date-time */
|
|
2003
|
+
observed_at: string | null;
|
|
1529
2004
|
};
|
|
1530
2005
|
PortListResponseBody: {
|
|
1531
2006
|
items: components["schemas"]["PortResource"][] | null;
|
|
@@ -1535,90 +2010,125 @@ export interface components {
|
|
|
1535
2010
|
port_id: string;
|
|
1536
2011
|
};
|
|
1537
2012
|
OperationLogResource: {
|
|
1538
|
-
/** @description
|
|
2013
|
+
/** @description Name of the operation; matches the operation id of the endpoint */
|
|
1539
2014
|
action: string;
|
|
1540
|
-
/** @description
|
|
2015
|
+
/** @description The user who initiated the operation. Empty when the platform performed it */
|
|
1541
2016
|
actor: string | null;
|
|
1542
|
-
/**
|
|
2017
|
+
/**
|
|
2018
|
+
* @description The name this user went by at the time of the operation, recorded alongside the operation itself. It is not refreshed afterwards: the record states who acted then, and a name read today is a statement about a different moment.
|
|
2019
|
+
*
|
|
2020
|
+
* Null on entries recorded before this field existed, and on entries performed by the platform. An empty string means the account had no name recorded.
|
|
2021
|
+
*/
|
|
2022
|
+
actor_name: string | null;
|
|
2023
|
+
/** @description True when the operation was performed by the platform */
|
|
1543
2024
|
by_platform: boolean;
|
|
1544
2025
|
/** Format: date-time */
|
|
1545
2026
|
created_at: string;
|
|
1546
|
-
/** @description
|
|
2027
|
+
/** @description Brief reason for the failure */
|
|
1547
2028
|
failure: string | null;
|
|
1548
2029
|
/** Format: uuid */
|
|
1549
2030
|
id: string;
|
|
1550
|
-
/** @description
|
|
2031
|
+
/** @description Path and query parameters of the request. Fields such as passwords are redacted */
|
|
1551
2032
|
payload: {
|
|
1552
2033
|
[key: string]: unknown;
|
|
1553
2034
|
};
|
|
1554
|
-
|
|
1555
|
-
|
|
2035
|
+
/** Format: uuid */
|
|
2036
|
+
region_id: string | null;
|
|
2037
|
+
/** @description Empty for create operations: the id of the new resource is in the response, not in the request path */
|
|
1556
2038
|
subject_id: string;
|
|
1557
2039
|
subject_type: string;
|
|
1558
2040
|
succeeded: boolean;
|
|
1559
2041
|
};
|
|
1560
2042
|
OperationLogListResponseBody: {
|
|
1561
|
-
items: components["schemas"]["OperationLogResource"][]
|
|
2043
|
+
items: components["schemas"]["OperationLogResource"][];
|
|
1562
2044
|
/** Format: int64 */
|
|
1563
|
-
|
|
2045
|
+
page: number;
|
|
2046
|
+
/** Format: int64 */
|
|
2047
|
+
page_size: number;
|
|
2048
|
+
/** Format: int64 */
|
|
2049
|
+
total_count?: number;
|
|
1564
2050
|
};
|
|
1565
2051
|
CreatePortRequestBody: {
|
|
1566
2052
|
name?: string;
|
|
1567
|
-
/** @description
|
|
1568
|
-
private_ip?: string;
|
|
1569
|
-
/** @description 至少一个,且必须属于同一个私有网络 */
|
|
2053
|
+
/** @description At least one, and all must belong to the same private network */
|
|
1570
2054
|
security_group_ids: string[] | null;
|
|
1571
2055
|
/** Format: uuid */
|
|
1572
2056
|
subnet_id: string;
|
|
2057
|
+
/** @description The private address to assign. Allocated automatically when omitted */
|
|
2058
|
+
address?: string;
|
|
1573
2059
|
};
|
|
1574
2060
|
PrivateImageResource: {
|
|
1575
2061
|
architecture: string;
|
|
1576
2062
|
/** Format: date-time */
|
|
1577
2063
|
created_at: string;
|
|
1578
|
-
/** @description
|
|
2064
|
+
/** @description Reason the capture failed; non-empty only when `status` is `error` */
|
|
1579
2065
|
failure: string | null;
|
|
1580
2066
|
/** Format: uuid */
|
|
1581
2067
|
id: string;
|
|
2068
|
+
/** @description The account this image lets you log in as. The password set at creation belongs to this account */
|
|
2069
|
+
login_username: string;
|
|
1582
2070
|
/**
|
|
1583
2071
|
* Format: int64
|
|
1584
|
-
* @description
|
|
2072
|
+
* @description The system disk of an instance created from this image cannot be smaller than this
|
|
1585
2073
|
*/
|
|
1586
2074
|
min_disk_gb: number;
|
|
1587
2075
|
/**
|
|
1588
2076
|
* Format: int64
|
|
1589
|
-
* @description
|
|
2077
|
+
* @description The instance type of an instance created from this image must have at least this much memory
|
|
1590
2078
|
*/
|
|
1591
2079
|
min_ram_mb: number;
|
|
1592
2080
|
name: string;
|
|
1593
2081
|
os_family: string;
|
|
1594
2082
|
os_version: string;
|
|
1595
|
-
/**
|
|
1596
|
-
|
|
2083
|
+
/** Format: uuid */
|
|
2084
|
+
region_id: string;
|
|
1597
2085
|
/**
|
|
1598
2086
|
* Format: int64
|
|
1599
|
-
* @description
|
|
2087
|
+
* @description Storage occupied by the image; 0 until the capture completes
|
|
1600
2088
|
*/
|
|
1601
2089
|
size_bytes: number;
|
|
1602
2090
|
/**
|
|
1603
2091
|
* Format: uuid
|
|
1604
|
-
* @description
|
|
2092
|
+
* @description The instance this image was captured from. The image remains usable after that instance is released
|
|
1605
2093
|
*/
|
|
1606
2094
|
source_instance_id: string | null;
|
|
1607
2095
|
/** @enum {string} */
|
|
1608
2096
|
status: "provisioning" | "uploading" | "available" | "deleting" | "error";
|
|
1609
|
-
/** @description
|
|
2097
|
+
/** @description False means a new password can only be set by rebuilding an instance created from this image */
|
|
1610
2098
|
supports_password_reset: boolean;
|
|
2099
|
+
/** Format: uuid */
|
|
2100
|
+
order_id: string | null;
|
|
2101
|
+
/** Format: uuid */
|
|
2102
|
+
price_id: string | null;
|
|
2103
|
+
/** Format: uuid */
|
|
2104
|
+
subscription_item_id: string | null;
|
|
2105
|
+
/** @enum {string|null} */
|
|
2106
|
+
access_state: "pending" | "enabled" | "suspended" | "reclaimed" | null;
|
|
2107
|
+
task: components["schemas"]["Task"] | null;
|
|
2108
|
+
/** Format: int64 */
|
|
2109
|
+
generation: number;
|
|
2110
|
+
/** Format: date-time */
|
|
2111
|
+
observed_at: string | null;
|
|
1611
2112
|
};
|
|
1612
2113
|
PrivateImageListResponseBody: {
|
|
1613
|
-
items: components["schemas"]["PrivateImageResource"][]
|
|
2114
|
+
items: components["schemas"]["PrivateImageResource"][];
|
|
2115
|
+
/** Format: int64 */
|
|
2116
|
+
page: number;
|
|
2117
|
+
/** Format: int64 */
|
|
2118
|
+
page_size: number;
|
|
2119
|
+
/** Format: int64 */
|
|
2120
|
+
total_count?: number;
|
|
1614
2121
|
};
|
|
1615
2122
|
CreatePrivateImageRequestBody: {
|
|
1616
2123
|
/**
|
|
1617
2124
|
* Format: uuid
|
|
1618
|
-
* @description
|
|
2125
|
+
* @description Captured from the system disk of this instance; data disks are not included
|
|
1619
2126
|
*/
|
|
1620
2127
|
instance_id: string;
|
|
1621
2128
|
name: string;
|
|
2129
|
+
/** Format: uuid */
|
|
2130
|
+
price_id: string;
|
|
2131
|
+
order: components["schemas"]["OrderOptions"];
|
|
1622
2132
|
};
|
|
1623
2133
|
RenamePrivateImageRequestBody: {
|
|
1624
2134
|
name: string;
|
|
@@ -1631,9 +2141,10 @@ export interface components {
|
|
|
1631
2141
|
/** Format: uuid */
|
|
1632
2142
|
id: string;
|
|
1633
2143
|
name: string;
|
|
1634
|
-
|
|
2144
|
+
/** Format: uuid */
|
|
2145
|
+
region_id: string;
|
|
1635
2146
|
/** @enum {string} */
|
|
1636
|
-
status: "available" | "error";
|
|
2147
|
+
status: "pending" | "available" | "deleting" | "error" | "unknown";
|
|
1637
2148
|
/** Format: date-time */
|
|
1638
2149
|
updated_at: string;
|
|
1639
2150
|
};
|
|
@@ -1641,20 +2152,21 @@ export interface components {
|
|
|
1641
2152
|
items: components["schemas"]["PrivateNetworkResource"][] | null;
|
|
1642
2153
|
};
|
|
1643
2154
|
CreatePrivateNetworkRequestBody: {
|
|
1644
|
-
/** @description
|
|
2155
|
+
/** @description Must be an RFC 1918 private CIDR with a prefix length between /8 and /24, for example `10.0.0.0/16` */
|
|
1645
2156
|
cidr: string;
|
|
1646
2157
|
name: string;
|
|
1647
|
-
|
|
2158
|
+
/** Format: uuid */
|
|
2159
|
+
region_id: string;
|
|
1648
2160
|
};
|
|
1649
2161
|
RenamePrivateNetworkRequestBody: {
|
|
1650
2162
|
name: string;
|
|
1651
2163
|
};
|
|
1652
2164
|
IPv6ResponseBody: {
|
|
1653
|
-
/** @description
|
|
2165
|
+
/** @description The allocated /64 prefix; empty while IPv6 is disabled */
|
|
1654
2166
|
cidr: string;
|
|
1655
2167
|
enabled: boolean;
|
|
1656
2168
|
/**
|
|
1657
|
-
* @description
|
|
2169
|
+
* @description `active` means IPv6 is fully available
|
|
1658
2170
|
* @enum {string}
|
|
1659
2171
|
*/
|
|
1660
2172
|
status: "pending" | "active" | "draining";
|
|
@@ -1673,9 +2185,9 @@ export interface components {
|
|
|
1673
2185
|
};
|
|
1674
2186
|
CreateRouteRequestBody: {
|
|
1675
2187
|
description?: string;
|
|
1676
|
-
/** @description
|
|
2188
|
+
/** @description Destination CIDR. It cannot be `0.0.0.0/0`, nor the CIDR of a subnet of this network */
|
|
1677
2189
|
destination: string;
|
|
1678
|
-
/** @description
|
|
2190
|
+
/** @description Private address of an instance; must fall inside a subnet of this private network */
|
|
1679
2191
|
nexthop: string;
|
|
1680
2192
|
};
|
|
1681
2193
|
SubnetResource: {
|
|
@@ -1696,12 +2208,12 @@ export interface components {
|
|
|
1696
2208
|
items: components["schemas"]["SubnetResource"][] | null;
|
|
1697
2209
|
};
|
|
1698
2210
|
CreateSubnetRequestBody: {
|
|
1699
|
-
/** @description
|
|
2211
|
+
/** @description Must fall inside the CIDR of the private network and must not overlap an existing subnet */
|
|
1700
2212
|
cidr: string;
|
|
1701
2213
|
name: string;
|
|
1702
2214
|
};
|
|
1703
2215
|
NextFreeCidrResponseBody: {
|
|
1704
|
-
/** @description
|
|
2216
|
+
/** @description Empty when the private network has no free CIDR left for that prefix length */
|
|
1705
2217
|
cidr: string;
|
|
1706
2218
|
};
|
|
1707
2219
|
SecurityGroupResource: {
|
|
@@ -1710,7 +2222,7 @@ export interface components {
|
|
|
1710
2222
|
description: string;
|
|
1711
2223
|
/** Format: uuid */
|
|
1712
2224
|
id: string;
|
|
1713
|
-
/** @description
|
|
2225
|
+
/** @description The default security group is released with its private network and cannot be deleted individually */
|
|
1714
2226
|
is_default: boolean;
|
|
1715
2227
|
name: string;
|
|
1716
2228
|
/** Format: uuid */
|
|
@@ -1737,12 +2249,12 @@ export interface components {
|
|
|
1737
2249
|
id: string;
|
|
1738
2250
|
/**
|
|
1739
2251
|
* Format: int64
|
|
1740
|
-
* @description ICMP
|
|
2252
|
+
* @description Denotes the ICMP code rather than a port when the protocol is ICMP
|
|
1741
2253
|
*/
|
|
1742
2254
|
port_range_max: number | null;
|
|
1743
2255
|
/**
|
|
1744
2256
|
* Format: int64
|
|
1745
|
-
* @description ICMP
|
|
2257
|
+
* @description Denotes the ICMP type rather than a port when the protocol is ICMP
|
|
1746
2258
|
*/
|
|
1747
2259
|
port_range_min: number | null;
|
|
1748
2260
|
protocol: string | null;
|
|
@@ -1759,22 +2271,25 @@ export interface components {
|
|
|
1759
2271
|
ethertype: "IPv4" | "IPv6";
|
|
1760
2272
|
/**
|
|
1761
2273
|
* Format: int64
|
|
1762
|
-
* @description ICMP
|
|
2274
|
+
* @description Denotes the ICMP code (0–255) rather than a port when the protocol is ICMP
|
|
1763
2275
|
*/
|
|
1764
2276
|
port_range_max?: number | null;
|
|
1765
2277
|
/**
|
|
1766
2278
|
* Format: int64
|
|
1767
|
-
* @description ICMP
|
|
2279
|
+
* @description Denotes the ICMP type (0–255) rather than a port when the protocol is ICMP
|
|
1768
2280
|
*/
|
|
1769
2281
|
port_range_min?: number | null;
|
|
1770
|
-
/** @description
|
|
2282
|
+
/** @description For example `tcp`, `udp`, `icmp` or `ipv6-icmp`. All protocols when omitted */
|
|
1771
2283
|
protocol?: string;
|
|
1772
|
-
/** @description
|
|
2284
|
+
/** @description Equivalent to `0.0.0.0/0` or `::/0` when omitted */
|
|
1773
2285
|
remote_ip_prefix?: string;
|
|
1774
2286
|
};
|
|
1775
2287
|
SnapshotResource: {
|
|
1776
|
-
/**
|
|
1777
|
-
|
|
2288
|
+
/**
|
|
2289
|
+
* Format: uuid
|
|
2290
|
+
* @description A disk restored from this snapshot must reside in this availability zone
|
|
2291
|
+
*/
|
|
2292
|
+
availability_zone_id: string;
|
|
1778
2293
|
/** Format: date-time */
|
|
1779
2294
|
created_at: string;
|
|
1780
2295
|
/** Format: uuid */
|
|
@@ -1782,14 +2297,28 @@ export interface components {
|
|
|
1782
2297
|
/** Format: uuid */
|
|
1783
2298
|
id: string;
|
|
1784
2299
|
name: string;
|
|
1785
|
-
|
|
2300
|
+
/** Format: uuid */
|
|
2301
|
+
region_id: string;
|
|
1786
2302
|
/**
|
|
1787
2303
|
* Format: int64
|
|
1788
|
-
* @description
|
|
2304
|
+
* @description Capacity of the source disk when the snapshot was created. A disk restored from it cannot be smaller
|
|
1789
2305
|
*/
|
|
1790
2306
|
size_gb: number;
|
|
1791
2307
|
/** @enum {string} */
|
|
1792
2308
|
status: "provisioning" | "available" | "restoring" | "deleting" | "error";
|
|
2309
|
+
/** Format: uuid */
|
|
2310
|
+
order_id: string | null;
|
|
2311
|
+
/** Format: uuid */
|
|
2312
|
+
price_id: string | null;
|
|
2313
|
+
/** Format: uuid */
|
|
2314
|
+
subscription_item_id: string | null;
|
|
2315
|
+
/** @enum {string|null} */
|
|
2316
|
+
access_state: "pending" | "enabled" | "suspended" | "reclaimed" | null;
|
|
2317
|
+
task: components["schemas"]["Task"] | null;
|
|
2318
|
+
/** Format: int64 */
|
|
2319
|
+
generation: number;
|
|
2320
|
+
/** Format: date-time */
|
|
2321
|
+
observed_at: string | null;
|
|
1793
2322
|
};
|
|
1794
2323
|
SnapshotListResponseBody: {
|
|
1795
2324
|
items: components["schemas"]["SnapshotResource"][] | null;
|
|
@@ -1798,6 +2327,9 @@ export interface components {
|
|
|
1798
2327
|
/** Format: uuid */
|
|
1799
2328
|
disk_id: string;
|
|
1800
2329
|
name: string;
|
|
2330
|
+
/** Format: uuid */
|
|
2331
|
+
price_id: string;
|
|
2332
|
+
order: components["schemas"]["OrderOptions"];
|
|
1801
2333
|
};
|
|
1802
2334
|
RenameSecurityGroupRequestBody: {
|
|
1803
2335
|
name: string;
|
|
@@ -1805,6 +2337,205 @@ export interface components {
|
|
|
1805
2337
|
RenameSnapshotRequestBody: {
|
|
1806
2338
|
name: string;
|
|
1807
2339
|
};
|
|
2340
|
+
/** @description Reuse the same key for retries of the same purchase. Reusing it with a different request fails. Billing selects contract pricing, applies eligible grants and promotions, and owns payment challenges and expiry. */
|
|
2341
|
+
OrderOptions: {
|
|
2342
|
+
idempotency_key: string;
|
|
2343
|
+
payment_plan?: components["schemas"]["PaymentPlan"];
|
|
2344
|
+
expected_amount?: string;
|
|
2345
|
+
redemption_code?: string;
|
|
2346
|
+
};
|
|
2347
|
+
/**
|
|
2348
|
+
* @description A billable order has been created. Read it from the billing API to find out what is
|
|
2349
|
+
* owed and whether payment is still required.
|
|
2350
|
+
*
|
|
2351
|
+
* Only the identifier is returned. Amounts and state are not repeated here; the order
|
|
2352
|
+
* itself is the single source for them.
|
|
2353
|
+
*/
|
|
2354
|
+
PlacedOrder: {
|
|
2355
|
+
/**
|
|
2356
|
+
* Format: uuid
|
|
2357
|
+
* @description Identifies the order. Use it to read the order and, where payment is required,
|
|
2358
|
+
* to pay it.
|
|
2359
|
+
*
|
|
2360
|
+
* An order is created even when nothing is owed, such as a plan with no charge or one
|
|
2361
|
+
* covered entirely by granted credit. Such an order is already settled, and no
|
|
2362
|
+
* payment step applies.
|
|
2363
|
+
*/
|
|
2364
|
+
order_id: string;
|
|
2365
|
+
};
|
|
2366
|
+
/** @description A system disk purchased in the same order. Required when booting from an image; mutually exclusive with boot_disk_id. */
|
|
2367
|
+
NewBootDisk: {
|
|
2368
|
+
/** Format: uuid */
|
|
2369
|
+
disk_type_id: string;
|
|
2370
|
+
/** Format: int64 */
|
|
2371
|
+
size_gb: number;
|
|
2372
|
+
/** Format: uuid */
|
|
2373
|
+
price_id: string;
|
|
2374
|
+
/** @default true */
|
|
2375
|
+
delete_with_instance?: boolean;
|
|
2376
|
+
};
|
|
2377
|
+
/** @description An address and bandwidth purchased in the same order. Mutually exclusive with floating_ip_id. */
|
|
2378
|
+
NewFloatingIP: {
|
|
2379
|
+
/** Format: uuid */
|
|
2380
|
+
price_id: string;
|
|
2381
|
+
/** Format: uuid */
|
|
2382
|
+
bandwidth_price_id: string;
|
|
2383
|
+
/** Format: int64 */
|
|
2384
|
+
bandwidth_mbps: number;
|
|
2385
|
+
/** Format: uuid */
|
|
2386
|
+
ipv4_pool_id: string;
|
|
2387
|
+
};
|
|
2388
|
+
/** @description An independent restriction on use. Removing one restriction never removes another source’s restriction or changes the user’s desired power state. */
|
|
2389
|
+
InstanceRestriction: {
|
|
2390
|
+
/** Format: uuid */
|
|
2391
|
+
id: string;
|
|
2392
|
+
/** @enum {string} */
|
|
2393
|
+
source: "billing" | "iam" | "operator";
|
|
2394
|
+
source_id: string;
|
|
2395
|
+
reason_code: string;
|
|
2396
|
+
/** Format: date-time */
|
|
2397
|
+
created_at: string;
|
|
2398
|
+
};
|
|
2399
|
+
PowerRequest: {
|
|
2400
|
+
/** Format: int64 */
|
|
2401
|
+
expected_generation?: number;
|
|
2402
|
+
};
|
|
2403
|
+
/** @description A requested action and its outcome. Query it through the service that accepted the request, using the same project or administrator credentials. Only succeeded confirms completion. Stopping a wait does not cancel the action. Cancellation is available only where the action explicitly supports it. */
|
|
2404
|
+
Task: {
|
|
2405
|
+
/** Format: uuid */
|
|
2406
|
+
id: string;
|
|
2407
|
+
/** @description Action requested from the owning service. */
|
|
2408
|
+
type: string;
|
|
2409
|
+
/** @enum {string} */
|
|
2410
|
+
state: "pending" | "running" | "succeeded" | "failed" | "canceled";
|
|
2411
|
+
/** @description Terminal failure. Absent while work can still recover. */
|
|
2412
|
+
error?: components["schemas"]["Error"];
|
|
2413
|
+
/** Format: date-time */
|
|
2414
|
+
created_at: string;
|
|
2415
|
+
/** Format: date-time */
|
|
2416
|
+
started_at: string | null;
|
|
2417
|
+
/** Format: date-time */
|
|
2418
|
+
completed_at: string | null;
|
|
2419
|
+
};
|
|
2420
|
+
PortAddress: {
|
|
2421
|
+
/** Format: uuid */
|
|
2422
|
+
id: string;
|
|
2423
|
+
/** Format: uuid */
|
|
2424
|
+
subnet_id: string;
|
|
2425
|
+
address: string;
|
|
2426
|
+
is_primary: boolean;
|
|
2427
|
+
/** @enum {string} */
|
|
2428
|
+
state: "reserved" | "assigned" | "releasing" | "released" | "unknown";
|
|
2429
|
+
/** Format: date-time */
|
|
2430
|
+
assigned_at: string | null;
|
|
2431
|
+
/** Format: date-time */
|
|
2432
|
+
released_at: string | null;
|
|
2433
|
+
};
|
|
2434
|
+
DiskAttachment: {
|
|
2435
|
+
/** Format: uuid */
|
|
2436
|
+
id: string;
|
|
2437
|
+
/** Format: uuid */
|
|
2438
|
+
instance_id: string;
|
|
2439
|
+
/** Format: uuid */
|
|
2440
|
+
disk_id: string;
|
|
2441
|
+
/** @enum {string} */
|
|
2442
|
+
role: "boot" | "data";
|
|
2443
|
+
delete_with_instance: boolean;
|
|
2444
|
+
/** @enum {string} */
|
|
2445
|
+
state: "reserved" | "attaching" | "attached" | "detaching" | "released" | "unknown";
|
|
2446
|
+
/** Format: date-time */
|
|
2447
|
+
attached_at: string | null;
|
|
2448
|
+
/** Format: date-time */
|
|
2449
|
+
detached_at: string | null;
|
|
2450
|
+
/** Format: date-time */
|
|
2451
|
+
released_at: string | null;
|
|
2452
|
+
device: string | null;
|
|
2453
|
+
};
|
|
2454
|
+
DiskAttachmentList: {
|
|
2455
|
+
items: components["schemas"]["DiskAttachment"][];
|
|
2456
|
+
/** Format: int64 */
|
|
2457
|
+
page: number;
|
|
2458
|
+
/** Format: int64 */
|
|
2459
|
+
page_size: number;
|
|
2460
|
+
/** Format: int64 */
|
|
2461
|
+
total_count: number;
|
|
2462
|
+
};
|
|
2463
|
+
PortAttachment: {
|
|
2464
|
+
/** Format: uuid */
|
|
2465
|
+
id: string;
|
|
2466
|
+
/** Format: uuid */
|
|
2467
|
+
instance_id: string;
|
|
2468
|
+
/** Format: uuid */
|
|
2469
|
+
port_id: string;
|
|
2470
|
+
/** @enum {string} */
|
|
2471
|
+
role: "primary" | "additional";
|
|
2472
|
+
delete_with_instance: boolean;
|
|
2473
|
+
/** @enum {string} */
|
|
2474
|
+
state: "reserved" | "attaching" | "attached" | "detaching" | "released" | "unknown";
|
|
2475
|
+
/** Format: date-time */
|
|
2476
|
+
attached_at: string | null;
|
|
2477
|
+
/** Format: date-time */
|
|
2478
|
+
detached_at: string | null;
|
|
2479
|
+
/** Format: date-time */
|
|
2480
|
+
released_at: string | null;
|
|
2481
|
+
};
|
|
2482
|
+
PortAttachmentList: {
|
|
2483
|
+
items: components["schemas"]["PortAttachment"][];
|
|
2484
|
+
/** Format: int64 */
|
|
2485
|
+
page: number;
|
|
2486
|
+
/** Format: int64 */
|
|
2487
|
+
page_size: number;
|
|
2488
|
+
/** Format: int64 */
|
|
2489
|
+
total_count: number;
|
|
2490
|
+
};
|
|
2491
|
+
LaunchInstanceResponseBody: {
|
|
2492
|
+
order: components["schemas"]["PlacedOrder"];
|
|
2493
|
+
/** @description Generated login password. Null when no password was generated. Keep it before leaving this response. */
|
|
2494
|
+
password: string | null;
|
|
2495
|
+
};
|
|
2496
|
+
IPv4PoolResource: {
|
|
2497
|
+
/** Format: uuid */
|
|
2498
|
+
id: string;
|
|
2499
|
+
/** Format: uuid */
|
|
2500
|
+
region_id: string;
|
|
2501
|
+
name: string;
|
|
2502
|
+
/** Format: uuid */
|
|
2503
|
+
plan_id: string | null;
|
|
2504
|
+
/** Format: uuid */
|
|
2505
|
+
bandwidth_plan_id: string | null;
|
|
2506
|
+
};
|
|
2507
|
+
IPv4PoolListResponseBody: {
|
|
2508
|
+
items: components["schemas"]["IPv4PoolResource"][];
|
|
2509
|
+
/** Format: int64 */
|
|
2510
|
+
page: number;
|
|
2511
|
+
/** Format: int64 */
|
|
2512
|
+
page_size: number;
|
|
2513
|
+
/** Format: int64 */
|
|
2514
|
+
total_count?: number;
|
|
2515
|
+
};
|
|
2516
|
+
IPv4Binding: {
|
|
2517
|
+
/** Format: uuid */
|
|
2518
|
+
id: string;
|
|
2519
|
+
/** Format: uuid */
|
|
2520
|
+
ipv4_allocation_id: string;
|
|
2521
|
+
/** Format: uuid */
|
|
2522
|
+
port_address_id: string;
|
|
2523
|
+
address: string;
|
|
2524
|
+
fixed_ip: string;
|
|
2525
|
+
/** @enum {string} */
|
|
2526
|
+
state: "binding" | "bound" | "unbinding" | "released" | "unknown";
|
|
2527
|
+
/** Format: date-time */
|
|
2528
|
+
bound_at: string | null;
|
|
2529
|
+
/** Format: date-time */
|
|
2530
|
+
unbound_at: string | null;
|
|
2531
|
+
/** Format: date-time */
|
|
2532
|
+
released_at: string | null;
|
|
2533
|
+
};
|
|
2534
|
+
/** @description Requested funding split. This does not select a card or payment provider; complete payment through Billing. */
|
|
2535
|
+
PaymentPlan: {
|
|
2536
|
+
balance_amount: string;
|
|
2537
|
+
provider_amount: string;
|
|
2538
|
+
};
|
|
1808
2539
|
};
|
|
1809
2540
|
responses: never;
|
|
1810
2541
|
parameters: never;
|
|
@@ -1817,7 +2548,7 @@ export interface operations {
|
|
|
1817
2548
|
"list-backups": {
|
|
1818
2549
|
parameters: {
|
|
1819
2550
|
query?: {
|
|
1820
|
-
/** @description
|
|
2551
|
+
/** @description Return only the backups of this disk */
|
|
1821
2552
|
disk_id?: string;
|
|
1822
2553
|
};
|
|
1823
2554
|
header?: never;
|
|
@@ -1865,7 +2596,7 @@ export interface operations {
|
|
|
1865
2596
|
[name: string]: unknown;
|
|
1866
2597
|
};
|
|
1867
2598
|
content: {
|
|
1868
|
-
"application/json": components["schemas"]["
|
|
2599
|
+
"application/json": components["schemas"]["PlacedOrder"];
|
|
1869
2600
|
};
|
|
1870
2601
|
};
|
|
1871
2602
|
/** @description Error */
|
|
@@ -1913,7 +2644,10 @@ export interface operations {
|
|
|
1913
2644
|
"delete-backup": {
|
|
1914
2645
|
parameters: {
|
|
1915
2646
|
query?: never;
|
|
1916
|
-
header
|
|
2647
|
+
header: {
|
|
2648
|
+
/** @description Reuse the same key for retries of the same action. A different request with the same key is rejected. */
|
|
2649
|
+
"Idempotency-Key": string;
|
|
2650
|
+
};
|
|
1917
2651
|
path: {
|
|
1918
2652
|
backupId: string;
|
|
1919
2653
|
};
|
|
@@ -1921,12 +2655,14 @@ export interface operations {
|
|
|
1921
2655
|
};
|
|
1922
2656
|
requestBody?: never;
|
|
1923
2657
|
responses: {
|
|
1924
|
-
/** @description
|
|
1925
|
-
|
|
2658
|
+
/** @description The action was accepted. Wait for the returned task to finish. */
|
|
2659
|
+
202: {
|
|
1926
2660
|
headers: {
|
|
1927
2661
|
[name: string]: unknown;
|
|
1928
2662
|
};
|
|
1929
|
-
content
|
|
2663
|
+
content: {
|
|
2664
|
+
"application/json": components["schemas"]["Task"];
|
|
2665
|
+
};
|
|
1930
2666
|
};
|
|
1931
2667
|
/** @description Error */
|
|
1932
2668
|
default: {
|
|
@@ -1995,7 +2731,7 @@ export interface operations {
|
|
|
1995
2731
|
[name: string]: unknown;
|
|
1996
2732
|
};
|
|
1997
2733
|
content: {
|
|
1998
|
-
"application/json": components["schemas"]["
|
|
2734
|
+
"application/json": components["schemas"]["PlacedOrder"];
|
|
1999
2735
|
};
|
|
2000
2736
|
};
|
|
2001
2737
|
/** @description Error */
|
|
@@ -2012,7 +2748,7 @@ export interface operations {
|
|
|
2012
2748
|
"list-disk-types": {
|
|
2013
2749
|
parameters: {
|
|
2014
2750
|
query: {
|
|
2015
|
-
|
|
2751
|
+
region_id: string;
|
|
2016
2752
|
};
|
|
2017
2753
|
header?: never;
|
|
2018
2754
|
path?: never;
|
|
@@ -2040,10 +2776,43 @@ export interface operations {
|
|
|
2040
2776
|
};
|
|
2041
2777
|
};
|
|
2042
2778
|
};
|
|
2779
|
+
"get-disk-type": {
|
|
2780
|
+
parameters: {
|
|
2781
|
+
query?: never;
|
|
2782
|
+
header?: never;
|
|
2783
|
+
path: {
|
|
2784
|
+
diskTypeId: string;
|
|
2785
|
+
};
|
|
2786
|
+
cookie?: never;
|
|
2787
|
+
};
|
|
2788
|
+
requestBody?: never;
|
|
2789
|
+
responses: {
|
|
2790
|
+
/** @description OK */
|
|
2791
|
+
200: {
|
|
2792
|
+
headers: {
|
|
2793
|
+
[name: string]: unknown;
|
|
2794
|
+
};
|
|
2795
|
+
content: {
|
|
2796
|
+
"application/json": components["schemas"]["DiskTypeResource"];
|
|
2797
|
+
};
|
|
2798
|
+
};
|
|
2799
|
+
/** @description Error */
|
|
2800
|
+
default: {
|
|
2801
|
+
headers: {
|
|
2802
|
+
[name: string]: unknown;
|
|
2803
|
+
};
|
|
2804
|
+
content: {
|
|
2805
|
+
"application/json": components["schemas"]["Error"];
|
|
2806
|
+
};
|
|
2807
|
+
};
|
|
2808
|
+
};
|
|
2809
|
+
};
|
|
2043
2810
|
"list-images": {
|
|
2044
2811
|
parameters: {
|
|
2045
2812
|
query: {
|
|
2046
|
-
|
|
2813
|
+
region_id: string;
|
|
2814
|
+
page?: number;
|
|
2815
|
+
page_size?: number;
|
|
2047
2816
|
};
|
|
2048
2817
|
header?: never;
|
|
2049
2818
|
path?: never;
|
|
@@ -2074,7 +2843,9 @@ export interface operations {
|
|
|
2074
2843
|
"list-instance-types": {
|
|
2075
2844
|
parameters: {
|
|
2076
2845
|
query: {
|
|
2077
|
-
|
|
2846
|
+
region_id: string;
|
|
2847
|
+
page?: number;
|
|
2848
|
+
page_size?: number;
|
|
2078
2849
|
};
|
|
2079
2850
|
header?: never;
|
|
2080
2851
|
path?: never;
|
|
@@ -2136,7 +2907,7 @@ export interface operations {
|
|
|
2136
2907
|
query?: never;
|
|
2137
2908
|
header?: never;
|
|
2138
2909
|
path: {
|
|
2139
|
-
|
|
2910
|
+
regionId: string;
|
|
2140
2911
|
};
|
|
2141
2912
|
cookie?: never;
|
|
2142
2913
|
};
|
|
@@ -2165,9 +2936,9 @@ export interface operations {
|
|
|
2165
2936
|
"list-disks": {
|
|
2166
2937
|
parameters: {
|
|
2167
2938
|
query?: {
|
|
2168
|
-
|
|
2169
|
-
/** @description
|
|
2170
|
-
|
|
2939
|
+
region_id?: string;
|
|
2940
|
+
/** @description Supplied together with `region_code` to filter attachable disks */
|
|
2941
|
+
availability_zone_id?: string;
|
|
2171
2942
|
};
|
|
2172
2943
|
header?: never;
|
|
2173
2944
|
path?: never;
|
|
@@ -2214,7 +2985,34 @@ export interface operations {
|
|
|
2214
2985
|
[name: string]: unknown;
|
|
2215
2986
|
};
|
|
2216
2987
|
content: {
|
|
2217
|
-
"application/json": components["schemas"]["
|
|
2988
|
+
"application/json": components["schemas"]["PlacedOrder"];
|
|
2989
|
+
};
|
|
2990
|
+
};
|
|
2991
|
+
/**
|
|
2992
|
+
* @description Payment required: **nothing was created.**
|
|
2993
|
+
*
|
|
2994
|
+
* Returned when `payment_method` is `online`. `meta.checkout_url` is where to send the
|
|
2995
|
+
* customer; `meta.order_id` is the order waiting on it.
|
|
2996
|
+
*
|
|
2997
|
+
* ## Why this is a status and not a field on a 200
|
|
2998
|
+
*
|
|
2999
|
+
* A field on a success response is something a client can forget to read, and forgetting it
|
|
3000
|
+
* means treating "we created nothing and are waiting for money" as "created" — which looks
|
|
3001
|
+
* identical from the outside until the bill does not add up. A 402 fails loudly in any
|
|
3002
|
+
* client that handles errors at all.
|
|
3003
|
+
*
|
|
3004
|
+
* ## What happens after they pay
|
|
3005
|
+
*
|
|
3006
|
+
* The money lands in the balance and the order is settled from it. The resource is **not**
|
|
3007
|
+
* created automatically: placing it again is the customer's move, because between paying
|
|
3008
|
+
* and coming back they may have changed their mind. The balance is theirs either way.
|
|
3009
|
+
*/
|
|
3010
|
+
402: {
|
|
3011
|
+
headers: {
|
|
3012
|
+
[name: string]: unknown;
|
|
3013
|
+
};
|
|
3014
|
+
content: {
|
|
3015
|
+
"application/json": components["schemas"]["Error"];
|
|
2218
3016
|
};
|
|
2219
3017
|
};
|
|
2220
3018
|
/** @description Error */
|
|
@@ -2262,7 +3060,10 @@ export interface operations {
|
|
|
2262
3060
|
"delete-disk": {
|
|
2263
3061
|
parameters: {
|
|
2264
3062
|
query?: never;
|
|
2265
|
-
header
|
|
3063
|
+
header: {
|
|
3064
|
+
/** @description Reuse the same key for retries of the same action. A different request with the same key is rejected. */
|
|
3065
|
+
"Idempotency-Key": string;
|
|
3066
|
+
};
|
|
2266
3067
|
path: {
|
|
2267
3068
|
diskId: string;
|
|
2268
3069
|
};
|
|
@@ -2270,12 +3071,14 @@ export interface operations {
|
|
|
2270
3071
|
};
|
|
2271
3072
|
requestBody?: never;
|
|
2272
3073
|
responses: {
|
|
2273
|
-
/** @description
|
|
2274
|
-
|
|
3074
|
+
/** @description The action was accepted. Wait for the returned task to finish. */
|
|
3075
|
+
202: {
|
|
2275
3076
|
headers: {
|
|
2276
3077
|
[name: string]: unknown;
|
|
2277
3078
|
};
|
|
2278
|
-
content
|
|
3079
|
+
content: {
|
|
3080
|
+
"application/json": components["schemas"]["Task"];
|
|
3081
|
+
};
|
|
2279
3082
|
};
|
|
2280
3083
|
/** @description Error */
|
|
2281
3084
|
default: {
|
|
@@ -2344,7 +3147,7 @@ export interface operations {
|
|
|
2344
3147
|
[name: string]: unknown;
|
|
2345
3148
|
};
|
|
2346
3149
|
content: {
|
|
2347
|
-
"application/json": components["schemas"]["
|
|
3150
|
+
"application/json": components["schemas"]["PlacedOrder"];
|
|
2348
3151
|
};
|
|
2349
3152
|
};
|
|
2350
3153
|
/** @description Error */
|
|
@@ -2361,7 +3164,10 @@ export interface operations {
|
|
|
2361
3164
|
"revert-disk": {
|
|
2362
3165
|
parameters: {
|
|
2363
3166
|
query?: never;
|
|
2364
|
-
header
|
|
3167
|
+
header: {
|
|
3168
|
+
/** @description Reuse the same key for retries of the same action. A different request with the same key is rejected. */
|
|
3169
|
+
"Idempotency-Key": string;
|
|
3170
|
+
};
|
|
2365
3171
|
path: {
|
|
2366
3172
|
diskId: string;
|
|
2367
3173
|
};
|
|
@@ -2373,13 +3179,13 @@ export interface operations {
|
|
|
2373
3179
|
};
|
|
2374
3180
|
};
|
|
2375
3181
|
responses: {
|
|
2376
|
-
/** @description
|
|
2377
|
-
|
|
3182
|
+
/** @description The action was accepted. Wait for the returned task to finish. */
|
|
3183
|
+
202: {
|
|
2378
3184
|
headers: {
|
|
2379
3185
|
[name: string]: unknown;
|
|
2380
3186
|
};
|
|
2381
3187
|
content: {
|
|
2382
|
-
"application/json": components["schemas"]["
|
|
3188
|
+
"application/json": components["schemas"]["Task"];
|
|
2383
3189
|
};
|
|
2384
3190
|
};
|
|
2385
3191
|
/** @description Error */
|
|
@@ -2441,7 +3247,7 @@ export interface operations {
|
|
|
2441
3247
|
[name: string]: unknown;
|
|
2442
3248
|
};
|
|
2443
3249
|
content: {
|
|
2444
|
-
"application/json": components["schemas"]["
|
|
3250
|
+
"application/json": components["schemas"]["PlacedOrder"];
|
|
2445
3251
|
};
|
|
2446
3252
|
};
|
|
2447
3253
|
/** @description Error */
|
|
@@ -2489,7 +3295,10 @@ export interface operations {
|
|
|
2489
3295
|
"release-floating-ip": {
|
|
2490
3296
|
parameters: {
|
|
2491
3297
|
query?: never;
|
|
2492
|
-
header
|
|
3298
|
+
header: {
|
|
3299
|
+
/** @description Reuse the same key for retries of the same action. A different request with the same key is rejected. */
|
|
3300
|
+
"Idempotency-Key": string;
|
|
3301
|
+
};
|
|
2493
3302
|
path: {
|
|
2494
3303
|
floatingIpId: string;
|
|
2495
3304
|
};
|
|
@@ -2497,12 +3306,14 @@ export interface operations {
|
|
|
2497
3306
|
};
|
|
2498
3307
|
requestBody?: never;
|
|
2499
3308
|
responses: {
|
|
2500
|
-
/** @description
|
|
2501
|
-
|
|
3309
|
+
/** @description The release has been accepted. */
|
|
3310
|
+
202: {
|
|
2502
3311
|
headers: {
|
|
2503
3312
|
[name: string]: unknown;
|
|
2504
3313
|
};
|
|
2505
|
-
content
|
|
3314
|
+
content: {
|
|
3315
|
+
"application/json": components["schemas"]["Task"];
|
|
3316
|
+
};
|
|
2506
3317
|
};
|
|
2507
3318
|
/** @description Error */
|
|
2508
3319
|
default: {
|
|
@@ -2536,7 +3347,7 @@ export interface operations {
|
|
|
2536
3347
|
[name: string]: unknown;
|
|
2537
3348
|
};
|
|
2538
3349
|
content: {
|
|
2539
|
-
"application/json": components["schemas"]["
|
|
3350
|
+
"application/json": components["schemas"]["PlacedOrder"];
|
|
2540
3351
|
};
|
|
2541
3352
|
};
|
|
2542
3353
|
/** @description Error */
|
|
@@ -2571,7 +3382,136 @@ export interface operations {
|
|
|
2571
3382
|
[name: string]: unknown;
|
|
2572
3383
|
};
|
|
2573
3384
|
content: {
|
|
2574
|
-
"application/json": components["schemas"]["FloatingIPResource"];
|
|
3385
|
+
"application/json": components["schemas"]["FloatingIPResource"];
|
|
3386
|
+
};
|
|
3387
|
+
};
|
|
3388
|
+
/** @description Error */
|
|
3389
|
+
default: {
|
|
3390
|
+
headers: {
|
|
3391
|
+
[name: string]: unknown;
|
|
3392
|
+
};
|
|
3393
|
+
content: {
|
|
3394
|
+
"application/json": components["schemas"]["Error"];
|
|
3395
|
+
};
|
|
3396
|
+
};
|
|
3397
|
+
};
|
|
3398
|
+
};
|
|
3399
|
+
"unbind-floating-ip": {
|
|
3400
|
+
parameters: {
|
|
3401
|
+
query?: never;
|
|
3402
|
+
header?: never;
|
|
3403
|
+
path: {
|
|
3404
|
+
floatingIpId: string;
|
|
3405
|
+
};
|
|
3406
|
+
cookie?: never;
|
|
3407
|
+
};
|
|
3408
|
+
requestBody?: never;
|
|
3409
|
+
responses: {
|
|
3410
|
+
/** @description OK */
|
|
3411
|
+
200: {
|
|
3412
|
+
headers: {
|
|
3413
|
+
[name: string]: unknown;
|
|
3414
|
+
};
|
|
3415
|
+
content: {
|
|
3416
|
+
"application/json": components["schemas"]["FloatingIPResource"];
|
|
3417
|
+
};
|
|
3418
|
+
};
|
|
3419
|
+
/** @description Error */
|
|
3420
|
+
default: {
|
|
3421
|
+
headers: {
|
|
3422
|
+
[name: string]: unknown;
|
|
3423
|
+
};
|
|
3424
|
+
content: {
|
|
3425
|
+
"application/json": components["schemas"]["Error"];
|
|
3426
|
+
};
|
|
3427
|
+
};
|
|
3428
|
+
};
|
|
3429
|
+
};
|
|
3430
|
+
"list-instances": {
|
|
3431
|
+
parameters: {
|
|
3432
|
+
query?: {
|
|
3433
|
+
/** @description Only instances carrying this label, written as `key:value` — for example `env:prod`. Both halves are matched exactly */
|
|
3434
|
+
label?: string;
|
|
3435
|
+
page?: number;
|
|
3436
|
+
page_size?: number;
|
|
3437
|
+
};
|
|
3438
|
+
header?: never;
|
|
3439
|
+
path?: never;
|
|
3440
|
+
cookie?: never;
|
|
3441
|
+
};
|
|
3442
|
+
requestBody?: never;
|
|
3443
|
+
responses: {
|
|
3444
|
+
/** @description OK */
|
|
3445
|
+
200: {
|
|
3446
|
+
headers: {
|
|
3447
|
+
[name: string]: unknown;
|
|
3448
|
+
};
|
|
3449
|
+
content: {
|
|
3450
|
+
"application/json": components["schemas"]["InstanceListResponseBody"];
|
|
3451
|
+
};
|
|
3452
|
+
};
|
|
3453
|
+
/** @description Error */
|
|
3454
|
+
default: {
|
|
3455
|
+
headers: {
|
|
3456
|
+
[name: string]: unknown;
|
|
3457
|
+
};
|
|
3458
|
+
content: {
|
|
3459
|
+
"application/json": components["schemas"]["Error"];
|
|
3460
|
+
};
|
|
3461
|
+
};
|
|
3462
|
+
};
|
|
3463
|
+
};
|
|
3464
|
+
"launch-instance": {
|
|
3465
|
+
parameters: {
|
|
3466
|
+
query?: never;
|
|
3467
|
+
header?: never;
|
|
3468
|
+
path?: never;
|
|
3469
|
+
cookie?: never;
|
|
3470
|
+
};
|
|
3471
|
+
requestBody: {
|
|
3472
|
+
content: {
|
|
3473
|
+
"application/json": components["schemas"]["LaunchInstanceRequestBody"];
|
|
3474
|
+
};
|
|
3475
|
+
};
|
|
3476
|
+
responses: {
|
|
3477
|
+
/** @description Accepted */
|
|
3478
|
+
202: {
|
|
3479
|
+
headers: {
|
|
3480
|
+
[name: string]: unknown;
|
|
3481
|
+
};
|
|
3482
|
+
content: {
|
|
3483
|
+
"application/json": components["schemas"]["LaunchInstanceResponseBody"];
|
|
3484
|
+
};
|
|
3485
|
+
};
|
|
3486
|
+
/** @description Error */
|
|
3487
|
+
default: {
|
|
3488
|
+
headers: {
|
|
3489
|
+
[name: string]: unknown;
|
|
3490
|
+
};
|
|
3491
|
+
content: {
|
|
3492
|
+
"application/json": components["schemas"]["Error"];
|
|
3493
|
+
};
|
|
3494
|
+
};
|
|
3495
|
+
};
|
|
3496
|
+
};
|
|
3497
|
+
"get-instance": {
|
|
3498
|
+
parameters: {
|
|
3499
|
+
query?: never;
|
|
3500
|
+
header?: never;
|
|
3501
|
+
path: {
|
|
3502
|
+
instanceId: string;
|
|
3503
|
+
};
|
|
3504
|
+
cookie?: never;
|
|
3505
|
+
};
|
|
3506
|
+
requestBody?: never;
|
|
3507
|
+
responses: {
|
|
3508
|
+
/** @description OK */
|
|
3509
|
+
200: {
|
|
3510
|
+
headers: {
|
|
3511
|
+
[name: string]: unknown;
|
|
3512
|
+
};
|
|
3513
|
+
content: {
|
|
3514
|
+
"application/json": components["schemas"]["InstanceResource"];
|
|
2575
3515
|
};
|
|
2576
3516
|
};
|
|
2577
3517
|
/** @description Error */
|
|
@@ -2585,24 +3525,27 @@ export interface operations {
|
|
|
2585
3525
|
};
|
|
2586
3526
|
};
|
|
2587
3527
|
};
|
|
2588
|
-
"
|
|
3528
|
+
"delete-instance": {
|
|
2589
3529
|
parameters: {
|
|
2590
3530
|
query?: never;
|
|
2591
|
-
header
|
|
3531
|
+
header: {
|
|
3532
|
+
/** @description Reuse the same key for retries of the same action. A different request with the same key is rejected. */
|
|
3533
|
+
"Idempotency-Key": string;
|
|
3534
|
+
};
|
|
2592
3535
|
path: {
|
|
2593
|
-
|
|
3536
|
+
instanceId: string;
|
|
2594
3537
|
};
|
|
2595
3538
|
cookie?: never;
|
|
2596
3539
|
};
|
|
2597
3540
|
requestBody?: never;
|
|
2598
3541
|
responses: {
|
|
2599
|
-
/** @description
|
|
2600
|
-
|
|
3542
|
+
/** @description The action was accepted. Wait for the returned task to finish. */
|
|
3543
|
+
202: {
|
|
2601
3544
|
headers: {
|
|
2602
3545
|
[name: string]: unknown;
|
|
2603
3546
|
};
|
|
2604
3547
|
content: {
|
|
2605
|
-
"application/json": components["schemas"]["
|
|
3548
|
+
"application/json": components["schemas"]["Task"];
|
|
2606
3549
|
};
|
|
2607
3550
|
};
|
|
2608
3551
|
/** @description Error */
|
|
@@ -2616,14 +3559,20 @@ export interface operations {
|
|
|
2616
3559
|
};
|
|
2617
3560
|
};
|
|
2618
3561
|
};
|
|
2619
|
-
"
|
|
3562
|
+
"rename-instance": {
|
|
2620
3563
|
parameters: {
|
|
2621
3564
|
query?: never;
|
|
2622
3565
|
header?: never;
|
|
2623
|
-
path
|
|
3566
|
+
path: {
|
|
3567
|
+
instanceId: string;
|
|
3568
|
+
};
|
|
2624
3569
|
cookie?: never;
|
|
2625
3570
|
};
|
|
2626
|
-
requestBody
|
|
3571
|
+
requestBody: {
|
|
3572
|
+
content: {
|
|
3573
|
+
"application/json": components["schemas"]["RenameInstanceRequestBody"];
|
|
3574
|
+
};
|
|
3575
|
+
};
|
|
2627
3576
|
responses: {
|
|
2628
3577
|
/** @description OK */
|
|
2629
3578
|
200: {
|
|
@@ -2631,7 +3580,7 @@ export interface operations {
|
|
|
2631
3580
|
[name: string]: unknown;
|
|
2632
3581
|
};
|
|
2633
3582
|
content: {
|
|
2634
|
-
"application/json": components["schemas"]["
|
|
3583
|
+
"application/json": components["schemas"]["InstanceResource"];
|
|
2635
3584
|
};
|
|
2636
3585
|
};
|
|
2637
3586
|
/** @description Error */
|
|
@@ -2645,26 +3594,28 @@ export interface operations {
|
|
|
2645
3594
|
};
|
|
2646
3595
|
};
|
|
2647
3596
|
};
|
|
2648
|
-
"
|
|
3597
|
+
"run-instance-command": {
|
|
2649
3598
|
parameters: {
|
|
2650
3599
|
query?: never;
|
|
2651
3600
|
header?: never;
|
|
2652
|
-
path
|
|
3601
|
+
path: {
|
|
3602
|
+
instanceId: string;
|
|
3603
|
+
};
|
|
2653
3604
|
cookie?: never;
|
|
2654
3605
|
};
|
|
2655
3606
|
requestBody: {
|
|
2656
3607
|
content: {
|
|
2657
|
-
"application/json": components["schemas"]["
|
|
3608
|
+
"application/json": components["schemas"]["RunCommandRequestBody"];
|
|
2658
3609
|
};
|
|
2659
3610
|
};
|
|
2660
3611
|
responses: {
|
|
2661
|
-
/** @description
|
|
2662
|
-
|
|
3612
|
+
/** @description OK */
|
|
3613
|
+
200: {
|
|
2663
3614
|
headers: {
|
|
2664
3615
|
[name: string]: unknown;
|
|
2665
3616
|
};
|
|
2666
3617
|
content: {
|
|
2667
|
-
"application/json": components["schemas"]["
|
|
3618
|
+
"application/json": components["schemas"]["CommandResultResponseBody"];
|
|
2668
3619
|
};
|
|
2669
3620
|
};
|
|
2670
3621
|
/** @description Error */
|
|
@@ -2678,7 +3629,7 @@ export interface operations {
|
|
|
2678
3629
|
};
|
|
2679
3630
|
};
|
|
2680
3631
|
};
|
|
2681
|
-
"
|
|
3632
|
+
"open-instance-console": {
|
|
2682
3633
|
parameters: {
|
|
2683
3634
|
query?: never;
|
|
2684
3635
|
header?: never;
|
|
@@ -2695,7 +3646,7 @@ export interface operations {
|
|
|
2695
3646
|
[name: string]: unknown;
|
|
2696
3647
|
};
|
|
2697
3648
|
content: {
|
|
2698
|
-
"application/json": components["schemas"]["
|
|
3649
|
+
"application/json": components["schemas"]["ConsoleResponseBody"];
|
|
2699
3650
|
};
|
|
2700
3651
|
};
|
|
2701
3652
|
/** @description Error */
|
|
@@ -2709,9 +3660,12 @@ export interface operations {
|
|
|
2709
3660
|
};
|
|
2710
3661
|
};
|
|
2711
3662
|
};
|
|
2712
|
-
"
|
|
3663
|
+
"get-instance-console-output": {
|
|
2713
3664
|
parameters: {
|
|
2714
|
-
query?:
|
|
3665
|
+
query?: {
|
|
3666
|
+
/** @description Number of trailing lines to return; 0 returns the entire output */
|
|
3667
|
+
lines?: number;
|
|
3668
|
+
};
|
|
2715
3669
|
header?: never;
|
|
2716
3670
|
path: {
|
|
2717
3671
|
instanceId: string;
|
|
@@ -2720,12 +3674,14 @@ export interface operations {
|
|
|
2720
3674
|
};
|
|
2721
3675
|
requestBody?: never;
|
|
2722
3676
|
responses: {
|
|
2723
|
-
/** @description
|
|
2724
|
-
|
|
3677
|
+
/** @description OK */
|
|
3678
|
+
200: {
|
|
2725
3679
|
headers: {
|
|
2726
3680
|
[name: string]: unknown;
|
|
2727
3681
|
};
|
|
2728
|
-
content
|
|
3682
|
+
content: {
|
|
3683
|
+
"application/json": components["schemas"]["ConsoleOutputResponseBody"];
|
|
3684
|
+
};
|
|
2729
3685
|
};
|
|
2730
3686
|
/** @description Error */
|
|
2731
3687
|
default: {
|
|
@@ -2738,7 +3694,7 @@ export interface operations {
|
|
|
2738
3694
|
};
|
|
2739
3695
|
};
|
|
2740
3696
|
};
|
|
2741
|
-
"
|
|
3697
|
+
"set-instance-labels": {
|
|
2742
3698
|
parameters: {
|
|
2743
3699
|
query?: never;
|
|
2744
3700
|
header?: never;
|
|
@@ -2749,7 +3705,7 @@ export interface operations {
|
|
|
2749
3705
|
};
|
|
2750
3706
|
requestBody: {
|
|
2751
3707
|
content: {
|
|
2752
|
-
"application/json": components["schemas"]["
|
|
3708
|
+
"application/json": components["schemas"]["SetInstanceLabelsRequestBody"];
|
|
2753
3709
|
};
|
|
2754
3710
|
};
|
|
2755
3711
|
responses: {
|
|
@@ -2773,7 +3729,7 @@ export interface operations {
|
|
|
2773
3729
|
};
|
|
2774
3730
|
};
|
|
2775
3731
|
};
|
|
2776
|
-
"
|
|
3732
|
+
"set-instance-notes": {
|
|
2777
3733
|
parameters: {
|
|
2778
3734
|
query?: never;
|
|
2779
3735
|
header?: never;
|
|
@@ -2784,7 +3740,7 @@ export interface operations {
|
|
|
2784
3740
|
};
|
|
2785
3741
|
requestBody: {
|
|
2786
3742
|
content: {
|
|
2787
|
-
"application/json": components["schemas"]["
|
|
3743
|
+
"application/json": components["schemas"]["SetInstanceNotesRequestBody"];
|
|
2788
3744
|
};
|
|
2789
3745
|
};
|
|
2790
3746
|
responses: {
|
|
@@ -2808,7 +3764,7 @@ export interface operations {
|
|
|
2808
3764
|
};
|
|
2809
3765
|
};
|
|
2810
3766
|
};
|
|
2811
|
-
"
|
|
3767
|
+
"reset-instance-password": {
|
|
2812
3768
|
parameters: {
|
|
2813
3769
|
query?: never;
|
|
2814
3770
|
header?: never;
|
|
@@ -2817,7 +3773,11 @@ export interface operations {
|
|
|
2817
3773
|
};
|
|
2818
3774
|
cookie?: never;
|
|
2819
3775
|
};
|
|
2820
|
-
requestBody
|
|
3776
|
+
requestBody: {
|
|
3777
|
+
content: {
|
|
3778
|
+
"application/json": components["schemas"]["ResetPasswordRequestBody"];
|
|
3779
|
+
};
|
|
3780
|
+
};
|
|
2821
3781
|
responses: {
|
|
2822
3782
|
/** @description OK */
|
|
2823
3783
|
200: {
|
|
@@ -2825,7 +3785,7 @@ export interface operations {
|
|
|
2825
3785
|
[name: string]: unknown;
|
|
2826
3786
|
};
|
|
2827
3787
|
content: {
|
|
2828
|
-
"application/json": components["schemas"]["
|
|
3788
|
+
"application/json": components["schemas"]["ResetPasswordResponseBody"];
|
|
2829
3789
|
};
|
|
2830
3790
|
};
|
|
2831
3791
|
/** @description Error */
|
|
@@ -2839,27 +3799,31 @@ export interface operations {
|
|
|
2839
3799
|
};
|
|
2840
3800
|
};
|
|
2841
3801
|
};
|
|
2842
|
-
"
|
|
3802
|
+
"reboot-instance": {
|
|
2843
3803
|
parameters: {
|
|
2844
|
-
query?:
|
|
2845
|
-
|
|
2846
|
-
|
|
3804
|
+
query?: never;
|
|
3805
|
+
header: {
|
|
3806
|
+
/** @description Reuse the same key for retries of the same action. A different request with the same key is rejected. */
|
|
3807
|
+
"Idempotency-Key": string;
|
|
2847
3808
|
};
|
|
2848
|
-
header?: never;
|
|
2849
3809
|
path: {
|
|
2850
3810
|
instanceId: string;
|
|
2851
3811
|
};
|
|
2852
3812
|
cookie?: never;
|
|
2853
3813
|
};
|
|
2854
|
-
requestBody
|
|
3814
|
+
requestBody: {
|
|
3815
|
+
content: {
|
|
3816
|
+
"application/json": components["schemas"]["RebootInstanceRequestBody"];
|
|
3817
|
+
};
|
|
3818
|
+
};
|
|
2855
3819
|
responses: {
|
|
2856
|
-
/** @description
|
|
2857
|
-
|
|
3820
|
+
/** @description The action was accepted. Wait for the returned task to finish. */
|
|
3821
|
+
202: {
|
|
2858
3822
|
headers: {
|
|
2859
3823
|
[name: string]: unknown;
|
|
2860
3824
|
};
|
|
2861
3825
|
content: {
|
|
2862
|
-
"application/json": components["schemas"]["
|
|
3826
|
+
"application/json": components["schemas"]["Task"];
|
|
2863
3827
|
};
|
|
2864
3828
|
};
|
|
2865
3829
|
/** @description Error */
|
|
@@ -2873,7 +3837,7 @@ export interface operations {
|
|
|
2873
3837
|
};
|
|
2874
3838
|
};
|
|
2875
3839
|
};
|
|
2876
|
-
"
|
|
3840
|
+
"rebuild-instance": {
|
|
2877
3841
|
parameters: {
|
|
2878
3842
|
query?: never;
|
|
2879
3843
|
header?: never;
|
|
@@ -2884,7 +3848,7 @@ export interface operations {
|
|
|
2884
3848
|
};
|
|
2885
3849
|
requestBody: {
|
|
2886
3850
|
content: {
|
|
2887
|
-
"application/json": components["schemas"]["
|
|
3851
|
+
"application/json": components["schemas"]["RebuildInstanceRequestBody"];
|
|
2888
3852
|
};
|
|
2889
3853
|
};
|
|
2890
3854
|
responses: {
|
|
@@ -2894,7 +3858,7 @@ export interface operations {
|
|
|
2894
3858
|
[name: string]: unknown;
|
|
2895
3859
|
};
|
|
2896
3860
|
content: {
|
|
2897
|
-
"application/json": components["schemas"]["
|
|
3861
|
+
"application/json": components["schemas"]["RebuildInstanceResponseBody"];
|
|
2898
3862
|
};
|
|
2899
3863
|
};
|
|
2900
3864
|
/** @description Error */
|
|
@@ -2908,7 +3872,7 @@ export interface operations {
|
|
|
2908
3872
|
};
|
|
2909
3873
|
};
|
|
2910
3874
|
};
|
|
2911
|
-
"
|
|
3875
|
+
"resize-instance": {
|
|
2912
3876
|
parameters: {
|
|
2913
3877
|
query?: never;
|
|
2914
3878
|
header?: never;
|
|
@@ -2919,17 +3883,17 @@ export interface operations {
|
|
|
2919
3883
|
};
|
|
2920
3884
|
requestBody: {
|
|
2921
3885
|
content: {
|
|
2922
|
-
"application/json": components["schemas"]["
|
|
3886
|
+
"application/json": components["schemas"]["ResizeInstanceRequestBody"];
|
|
2923
3887
|
};
|
|
2924
3888
|
};
|
|
2925
3889
|
responses: {
|
|
2926
|
-
/** @description
|
|
2927
|
-
|
|
3890
|
+
/** @description Accepted */
|
|
3891
|
+
202: {
|
|
2928
3892
|
headers: {
|
|
2929
3893
|
[name: string]: unknown;
|
|
2930
3894
|
};
|
|
2931
3895
|
content: {
|
|
2932
|
-
"application/json": components["schemas"]["
|
|
3896
|
+
"application/json": components["schemas"]["PlacedOrder"];
|
|
2933
3897
|
};
|
|
2934
3898
|
};
|
|
2935
3899
|
/** @description Error */
|
|
@@ -2943,28 +3907,61 @@ export interface operations {
|
|
|
2943
3907
|
};
|
|
2944
3908
|
};
|
|
2945
3909
|
};
|
|
2946
|
-
"
|
|
3910
|
+
"confirm-instance-resize": {
|
|
2947
3911
|
parameters: {
|
|
2948
3912
|
query?: never;
|
|
2949
|
-
header
|
|
3913
|
+
header: {
|
|
3914
|
+
/** @description Reuse the same key for retries of the same action. A different request with the same key is rejected. */
|
|
3915
|
+
"Idempotency-Key": string;
|
|
3916
|
+
};
|
|
2950
3917
|
path: {
|
|
2951
3918
|
instanceId: string;
|
|
2952
3919
|
};
|
|
2953
3920
|
cookie?: never;
|
|
2954
3921
|
};
|
|
2955
|
-
requestBody
|
|
2956
|
-
|
|
2957
|
-
|
|
3922
|
+
requestBody?: never;
|
|
3923
|
+
responses: {
|
|
3924
|
+
/** @description The action was accepted. Wait for the returned task to finish. */
|
|
3925
|
+
202: {
|
|
3926
|
+
headers: {
|
|
3927
|
+
[name: string]: unknown;
|
|
3928
|
+
};
|
|
3929
|
+
content: {
|
|
3930
|
+
"application/json": components["schemas"]["Task"];
|
|
3931
|
+
};
|
|
3932
|
+
};
|
|
3933
|
+
/** @description Error */
|
|
3934
|
+
default: {
|
|
3935
|
+
headers: {
|
|
3936
|
+
[name: string]: unknown;
|
|
3937
|
+
};
|
|
3938
|
+
content: {
|
|
3939
|
+
"application/json": components["schemas"]["Error"];
|
|
3940
|
+
};
|
|
3941
|
+
};
|
|
3942
|
+
};
|
|
3943
|
+
};
|
|
3944
|
+
"revert-instance-resize": {
|
|
3945
|
+
parameters: {
|
|
3946
|
+
query?: never;
|
|
3947
|
+
header: {
|
|
3948
|
+
/** @description Reuse the same key for retries of the same action. A different request with the same key is rejected. */
|
|
3949
|
+
"Idempotency-Key": string;
|
|
3950
|
+
};
|
|
3951
|
+
path: {
|
|
3952
|
+
instanceId: string;
|
|
2958
3953
|
};
|
|
3954
|
+
cookie?: never;
|
|
2959
3955
|
};
|
|
3956
|
+
requestBody?: never;
|
|
2960
3957
|
responses: {
|
|
2961
|
-
/** @description
|
|
2962
|
-
|
|
3958
|
+
/** @description The action was accepted. Wait for the returned task to finish. */
|
|
3959
|
+
202: {
|
|
2963
3960
|
headers: {
|
|
2964
3961
|
[name: string]: unknown;
|
|
2965
3962
|
};
|
|
2966
3963
|
content: {
|
|
2967
|
-
"application/json": components["schemas"]["
|
|
3964
|
+
"application/json": components["schemas"]["Task"];
|
|
2968
3965
|
};
|
|
2969
3966
|
};
|
|
2970
3967
|
/** @description Error */
|
|
@@ -2978,24 +3975,31 @@ export interface operations {
|
|
|
2978
3975
|
};
|
|
2979
3976
|
};
|
|
2980
3977
|
};
|
|
2981
|
-
"
|
|
3978
|
+
"start-instance": {
|
|
2982
3979
|
parameters: {
|
|
2983
3980
|
query?: never;
|
|
2984
|
-
header
|
|
3981
|
+
header: {
|
|
3982
|
+
/** @description Reuse the same key for retries of the same action. A different request with the same key is rejected. */
|
|
3983
|
+
"Idempotency-Key": string;
|
|
3984
|
+
};
|
|
2985
3985
|
path: {
|
|
2986
3986
|
instanceId: string;
|
|
2987
3987
|
};
|
|
2988
3988
|
cookie?: never;
|
|
2989
3989
|
};
|
|
2990
|
-
requestBody
|
|
3990
|
+
requestBody: {
|
|
3991
|
+
content: {
|
|
3992
|
+
"application/json": components["schemas"]["PowerRequest"];
|
|
3993
|
+
};
|
|
3994
|
+
};
|
|
2991
3995
|
responses: {
|
|
2992
|
-
/** @description
|
|
2993
|
-
|
|
3996
|
+
/** @description The action was accepted. Wait for the returned task to finish. */
|
|
3997
|
+
202: {
|
|
2994
3998
|
headers: {
|
|
2995
3999
|
[name: string]: unknown;
|
|
2996
4000
|
};
|
|
2997
4001
|
content: {
|
|
2998
|
-
"application/json": components["schemas"]["
|
|
4002
|
+
"application/json": components["schemas"]["Task"];
|
|
2999
4003
|
};
|
|
3000
4004
|
};
|
|
3001
4005
|
/** @description Error */
|
|
@@ -3009,24 +4013,31 @@ export interface operations {
|
|
|
3009
4013
|
};
|
|
3010
4014
|
};
|
|
3011
4015
|
};
|
|
3012
|
-
"
|
|
4016
|
+
"stop-instance": {
|
|
3013
4017
|
parameters: {
|
|
3014
4018
|
query?: never;
|
|
3015
|
-
header
|
|
4019
|
+
header: {
|
|
4020
|
+
/** @description Reuse the same key for retries of the same action. A different request with the same key is rejected. */
|
|
4021
|
+
"Idempotency-Key": string;
|
|
4022
|
+
};
|
|
3016
4023
|
path: {
|
|
3017
4024
|
instanceId: string;
|
|
3018
4025
|
};
|
|
3019
4026
|
cookie?: never;
|
|
3020
4027
|
};
|
|
3021
|
-
requestBody
|
|
4028
|
+
requestBody: {
|
|
4029
|
+
content: {
|
|
4030
|
+
"application/json": components["schemas"]["PowerRequest"];
|
|
4031
|
+
};
|
|
4032
|
+
};
|
|
3022
4033
|
responses: {
|
|
3023
|
-
/** @description
|
|
3024
|
-
|
|
4034
|
+
/** @description The action was accepted. Wait for the returned task to finish. */
|
|
4035
|
+
202: {
|
|
3025
4036
|
headers: {
|
|
3026
4037
|
[name: string]: unknown;
|
|
3027
4038
|
};
|
|
3028
4039
|
content: {
|
|
3029
|
-
"application/json": components["schemas"]["
|
|
4040
|
+
"application/json": components["schemas"]["Task"];
|
|
3030
4041
|
};
|
|
3031
4042
|
};
|
|
3032
4043
|
/** @description Error */
|
|
@@ -3042,7 +4053,10 @@ export interface operations {
|
|
|
3042
4053
|
};
|
|
3043
4054
|
"list-instance-disks": {
|
|
3044
4055
|
parameters: {
|
|
3045
|
-
query?:
|
|
4056
|
+
query?: {
|
|
4057
|
+
page?: number;
|
|
4058
|
+
page_size?: number;
|
|
4059
|
+
};
|
|
3046
4060
|
header?: never;
|
|
3047
4061
|
path: {
|
|
3048
4062
|
instanceId: string;
|
|
@@ -3057,7 +4071,7 @@ export interface operations {
|
|
|
3057
4071
|
[name: string]: unknown;
|
|
3058
4072
|
};
|
|
3059
4073
|
content: {
|
|
3060
|
-
"application/json": components["schemas"]["
|
|
4074
|
+
"application/json": components["schemas"]["DiskAttachmentList"];
|
|
3061
4075
|
};
|
|
3062
4076
|
};
|
|
3063
4077
|
/** @description Error */
|
|
@@ -3074,7 +4088,10 @@ export interface operations {
|
|
|
3074
4088
|
"attach-disk": {
|
|
3075
4089
|
parameters: {
|
|
3076
4090
|
query?: never;
|
|
3077
|
-
header
|
|
4091
|
+
header: {
|
|
4092
|
+
/** @description Reuse the same key for retries of the same action. A different request with the same key is rejected. */
|
|
4093
|
+
"Idempotency-Key": string;
|
|
4094
|
+
};
|
|
3078
4095
|
path: {
|
|
3079
4096
|
instanceId: string;
|
|
3080
4097
|
};
|
|
@@ -3086,13 +4103,13 @@ export interface operations {
|
|
|
3086
4103
|
};
|
|
3087
4104
|
};
|
|
3088
4105
|
responses: {
|
|
3089
|
-
/** @description
|
|
3090
|
-
|
|
4106
|
+
/** @description The action was accepted. Wait for the returned task to finish. */
|
|
4107
|
+
202: {
|
|
3091
4108
|
headers: {
|
|
3092
4109
|
[name: string]: unknown;
|
|
3093
4110
|
};
|
|
3094
4111
|
content: {
|
|
3095
|
-
"application/json": components["schemas"]["
|
|
4112
|
+
"application/json": components["schemas"]["Task"];
|
|
3096
4113
|
};
|
|
3097
4114
|
};
|
|
3098
4115
|
/** @description Error */
|
|
@@ -3109,7 +4126,10 @@ export interface operations {
|
|
|
3109
4126
|
"detach-disk": {
|
|
3110
4127
|
parameters: {
|
|
3111
4128
|
query?: never;
|
|
3112
|
-
header
|
|
4129
|
+
header: {
|
|
4130
|
+
/** @description Reuse the same key for retries of the same action. A different request with the same key is rejected. */
|
|
4131
|
+
"Idempotency-Key": string;
|
|
4132
|
+
};
|
|
3113
4133
|
path: {
|
|
3114
4134
|
instanceId: string;
|
|
3115
4135
|
diskId: string;
|
|
@@ -3118,13 +4138,13 @@ export interface operations {
|
|
|
3118
4138
|
};
|
|
3119
4139
|
requestBody?: never;
|
|
3120
4140
|
responses: {
|
|
3121
|
-
/** @description
|
|
3122
|
-
|
|
4141
|
+
/** @description The action was accepted. Wait for the returned task to finish. */
|
|
4142
|
+
202: {
|
|
3123
4143
|
headers: {
|
|
3124
4144
|
[name: string]: unknown;
|
|
3125
4145
|
};
|
|
3126
4146
|
content: {
|
|
3127
|
-
"application/json": components["schemas"]["
|
|
4147
|
+
"application/json": components["schemas"]["Task"];
|
|
3128
4148
|
};
|
|
3129
4149
|
};
|
|
3130
4150
|
/** @description Error */
|
|
@@ -3153,7 +4173,7 @@ export interface operations {
|
|
|
3153
4173
|
};
|
|
3154
4174
|
};
|
|
3155
4175
|
responses: {
|
|
3156
|
-
/** @description
|
|
4176
|
+
/** @description The current floating IP binding */
|
|
3157
4177
|
200: {
|
|
3158
4178
|
headers: {
|
|
3159
4179
|
[name: string]: unknown;
|
|
@@ -3185,7 +4205,7 @@ export interface operations {
|
|
|
3185
4205
|
};
|
|
3186
4206
|
requestBody?: never;
|
|
3187
4207
|
responses: {
|
|
3188
|
-
/** @description
|
|
4208
|
+
/** @description The current floating IP binding */
|
|
3189
4209
|
200: {
|
|
3190
4210
|
headers: {
|
|
3191
4211
|
[name: string]: unknown;
|
|
@@ -3207,7 +4227,10 @@ export interface operations {
|
|
|
3207
4227
|
};
|
|
3208
4228
|
"list-instance-ports": {
|
|
3209
4229
|
parameters: {
|
|
3210
|
-
query?:
|
|
4230
|
+
query?: {
|
|
4231
|
+
page?: number;
|
|
4232
|
+
page_size?: number;
|
|
4233
|
+
};
|
|
3211
4234
|
header?: never;
|
|
3212
4235
|
path: {
|
|
3213
4236
|
instanceId: string;
|
|
@@ -3222,7 +4245,7 @@ export interface operations {
|
|
|
3222
4245
|
[name: string]: unknown;
|
|
3223
4246
|
};
|
|
3224
4247
|
content: {
|
|
3225
|
-
"application/json": components["schemas"]["
|
|
4248
|
+
"application/json": components["schemas"]["PortAttachmentList"];
|
|
3226
4249
|
};
|
|
3227
4250
|
};
|
|
3228
4251
|
/** @description Error */
|
|
@@ -3239,7 +4262,10 @@ export interface operations {
|
|
|
3239
4262
|
"attach-port": {
|
|
3240
4263
|
parameters: {
|
|
3241
4264
|
query?: never;
|
|
3242
|
-
header
|
|
4265
|
+
header: {
|
|
4266
|
+
/** @description Reuse the same key for retries of the same action. A different request with the same key is rejected. */
|
|
4267
|
+
"Idempotency-Key": string;
|
|
4268
|
+
};
|
|
3243
4269
|
path: {
|
|
3244
4270
|
instanceId: string;
|
|
3245
4271
|
};
|
|
@@ -3251,13 +4277,13 @@ export interface operations {
|
|
|
3251
4277
|
};
|
|
3252
4278
|
};
|
|
3253
4279
|
responses: {
|
|
3254
|
-
/** @description
|
|
3255
|
-
|
|
4280
|
+
/** @description The action was accepted. Wait for the returned task to finish. */
|
|
4281
|
+
202: {
|
|
3256
4282
|
headers: {
|
|
3257
4283
|
[name: string]: unknown;
|
|
3258
4284
|
};
|
|
3259
4285
|
content: {
|
|
3260
|
-
"application/json": components["schemas"]["
|
|
4286
|
+
"application/json": components["schemas"]["Task"];
|
|
3261
4287
|
};
|
|
3262
4288
|
};
|
|
3263
4289
|
/** @description Error */
|
|
@@ -3274,7 +4300,10 @@ export interface operations {
|
|
|
3274
4300
|
"detach-port": {
|
|
3275
4301
|
parameters: {
|
|
3276
4302
|
query?: never;
|
|
3277
|
-
header
|
|
4303
|
+
header: {
|
|
4304
|
+
/** @description Reuse the same key for retries of the same action. A different request with the same key is rejected. */
|
|
4305
|
+
"Idempotency-Key": string;
|
|
4306
|
+
};
|
|
3278
4307
|
path: {
|
|
3279
4308
|
instanceId: string;
|
|
3280
4309
|
portId: string;
|
|
@@ -3283,13 +4312,13 @@ export interface operations {
|
|
|
3283
4312
|
};
|
|
3284
4313
|
requestBody?: never;
|
|
3285
4314
|
responses: {
|
|
3286
|
-
/** @description
|
|
3287
|
-
|
|
4315
|
+
/** @description The action was accepted. Wait for the returned task to finish. */
|
|
4316
|
+
202: {
|
|
3288
4317
|
headers: {
|
|
3289
4318
|
[name: string]: unknown;
|
|
3290
4319
|
};
|
|
3291
4320
|
content: {
|
|
3292
|
-
"application/json": components["schemas"]["
|
|
4321
|
+
"application/json": components["schemas"]["Task"];
|
|
3293
4322
|
};
|
|
3294
4323
|
};
|
|
3295
4324
|
/** @description Error */
|
|
@@ -3306,10 +4335,10 @@ export interface operations {
|
|
|
3306
4335
|
"list-operation-logs": {
|
|
3307
4336
|
parameters: {
|
|
3308
4337
|
query?: {
|
|
3309
|
-
/** @description
|
|
4338
|
+
/** @description Return a single kind of operation; the value matches the operation id of the endpoint */
|
|
3310
4339
|
action?: string;
|
|
3311
|
-
|
|
3312
|
-
|
|
4340
|
+
page?: number;
|
|
4341
|
+
page_size?: number;
|
|
3313
4342
|
};
|
|
3314
4343
|
header?: never;
|
|
3315
4344
|
path?: never;
|
|
@@ -3431,8 +4460,10 @@ export interface operations {
|
|
|
3431
4460
|
"list-private-images": {
|
|
3432
4461
|
parameters: {
|
|
3433
4462
|
query?: {
|
|
3434
|
-
/** @description
|
|
3435
|
-
|
|
4463
|
+
/** @description Return only the images of this region. An image can only be used in the region that holds it */
|
|
4464
|
+
region_id?: string;
|
|
4465
|
+
page?: number;
|
|
4466
|
+
page_size?: number;
|
|
3436
4467
|
};
|
|
3437
4468
|
header?: never;
|
|
3438
4469
|
path?: never;
|
|
@@ -3479,7 +4510,7 @@ export interface operations {
|
|
|
3479
4510
|
[name: string]: unknown;
|
|
3480
4511
|
};
|
|
3481
4512
|
content: {
|
|
3482
|
-
"application/json": components["schemas"]["
|
|
4513
|
+
"application/json": components["schemas"]["PlacedOrder"];
|
|
3483
4514
|
};
|
|
3484
4515
|
};
|
|
3485
4516
|
/** @description Error */
|
|
@@ -3527,7 +4558,10 @@ export interface operations {
|
|
|
3527
4558
|
"delete-private-image": {
|
|
3528
4559
|
parameters: {
|
|
3529
4560
|
query?: never;
|
|
3530
|
-
header
|
|
4561
|
+
header: {
|
|
4562
|
+
/** @description Reuse the same key for retries of the same action. A different request with the same key is rejected. */
|
|
4563
|
+
"Idempotency-Key": string;
|
|
4564
|
+
};
|
|
3531
4565
|
path: {
|
|
3532
4566
|
privateImageId: string;
|
|
3533
4567
|
};
|
|
@@ -3535,12 +4569,14 @@ export interface operations {
|
|
|
3535
4569
|
};
|
|
3536
4570
|
requestBody?: never;
|
|
3537
4571
|
responses: {
|
|
3538
|
-
/** @description
|
|
3539
|
-
|
|
4572
|
+
/** @description The action was accepted. Wait for the returned task to finish. */
|
|
4573
|
+
202: {
|
|
3540
4574
|
headers: {
|
|
3541
4575
|
[name: string]: unknown;
|
|
3542
4576
|
};
|
|
3543
|
-
content
|
|
4577
|
+
content: {
|
|
4578
|
+
"application/json": components["schemas"]["Task"];
|
|
4579
|
+
};
|
|
3544
4580
|
};
|
|
3545
4581
|
/** @description Error */
|
|
3546
4582
|
default: {
|
|
@@ -3591,8 +4627,8 @@ export interface operations {
|
|
|
3591
4627
|
"list-private-networks": {
|
|
3592
4628
|
parameters: {
|
|
3593
4629
|
query?: {
|
|
3594
|
-
/** @description
|
|
3595
|
-
|
|
4630
|
+
/** @description Returns every region when omitted */
|
|
4631
|
+
region_id?: string;
|
|
3596
4632
|
};
|
|
3597
4633
|
header?: never;
|
|
3598
4634
|
path?: never;
|
|
@@ -4067,8 +5103,8 @@ export interface operations {
|
|
|
4067
5103
|
"list-security-groups": {
|
|
4068
5104
|
parameters: {
|
|
4069
5105
|
query?: {
|
|
4070
|
-
|
|
4071
|
-
/** @description
|
|
5106
|
+
region_id?: string;
|
|
5107
|
+
/** @description Return only the security groups of this private network */
|
|
4072
5108
|
private_network_id?: string;
|
|
4073
5109
|
};
|
|
4074
5110
|
header?: never;
|
|
@@ -4324,7 +5360,7 @@ export interface operations {
|
|
|
4324
5360
|
"list-snapshots": {
|
|
4325
5361
|
parameters: {
|
|
4326
5362
|
query?: {
|
|
4327
|
-
/** @description
|
|
5363
|
+
/** @description Return only the snapshots of this disk */
|
|
4328
5364
|
disk_id?: string;
|
|
4329
5365
|
};
|
|
4330
5366
|
header?: never;
|
|
@@ -4372,7 +5408,7 @@ export interface operations {
|
|
|
4372
5408
|
[name: string]: unknown;
|
|
4373
5409
|
};
|
|
4374
5410
|
content: {
|
|
4375
|
-
"application/json": components["schemas"]["
|
|
5411
|
+
"application/json": components["schemas"]["PlacedOrder"];
|
|
4376
5412
|
};
|
|
4377
5413
|
};
|
|
4378
5414
|
/** @description Error */
|
|
@@ -4420,7 +5456,10 @@ export interface operations {
|
|
|
4420
5456
|
"delete-snapshot": {
|
|
4421
5457
|
parameters: {
|
|
4422
5458
|
query?: never;
|
|
4423
|
-
header
|
|
5459
|
+
header: {
|
|
5460
|
+
/** @description Reuse the same key for retries of the same action. A different request with the same key is rejected. */
|
|
5461
|
+
"Idempotency-Key": string;
|
|
5462
|
+
};
|
|
4424
5463
|
path: {
|
|
4425
5464
|
snapshotId: string;
|
|
4426
5465
|
};
|
|
@@ -4428,12 +5467,14 @@ export interface operations {
|
|
|
4428
5467
|
};
|
|
4429
5468
|
requestBody?: never;
|
|
4430
5469
|
responses: {
|
|
4431
|
-
/** @description
|
|
4432
|
-
|
|
5470
|
+
/** @description The action was accepted. Wait for the returned task to finish. */
|
|
5471
|
+
202: {
|
|
4433
5472
|
headers: {
|
|
4434
5473
|
[name: string]: unknown;
|
|
4435
5474
|
};
|
|
4436
|
-
content
|
|
5475
|
+
content: {
|
|
5476
|
+
"application/json": components["schemas"]["Task"];
|
|
5477
|
+
};
|
|
4437
5478
|
};
|
|
4438
5479
|
/** @description Error */
|
|
4439
5480
|
default: {
|
|
@@ -4481,4 +5522,68 @@ export interface operations {
|
|
|
4481
5522
|
};
|
|
4482
5523
|
};
|
|
4483
5524
|
};
|
|
5525
|
+
"get-task": {
|
|
5526
|
+
parameters: {
|
|
5527
|
+
query?: never;
|
|
5528
|
+
header?: never;
|
|
5529
|
+
path: {
|
|
5530
|
+
taskId: string;
|
|
5531
|
+
};
|
|
5532
|
+
cookie?: never;
|
|
5533
|
+
};
|
|
5534
|
+
requestBody?: never;
|
|
5535
|
+
responses: {
|
|
5536
|
+
/** @description The task. */
|
|
5537
|
+
200: {
|
|
5538
|
+
headers: {
|
|
5539
|
+
[name: string]: unknown;
|
|
5540
|
+
};
|
|
5541
|
+
content: {
|
|
5542
|
+
"application/json": components["schemas"]["Task"];
|
|
5543
|
+
};
|
|
5544
|
+
};
|
|
5545
|
+
/** @description The request could not be completed. */
|
|
5546
|
+
default: {
|
|
5547
|
+
headers: {
|
|
5548
|
+
[name: string]: unknown;
|
|
5549
|
+
};
|
|
5550
|
+
content: {
|
|
5551
|
+
"application/json": components["schemas"]["Error"];
|
|
5552
|
+
};
|
|
5553
|
+
};
|
|
5554
|
+
};
|
|
5555
|
+
};
|
|
5556
|
+
"list-ipv4-pools": {
|
|
5557
|
+
parameters: {
|
|
5558
|
+
query: {
|
|
5559
|
+
region_id: string;
|
|
5560
|
+
page?: number;
|
|
5561
|
+
page_size?: number;
|
|
5562
|
+
};
|
|
5563
|
+
header?: never;
|
|
5564
|
+
path?: never;
|
|
5565
|
+
cookie?: never;
|
|
5566
|
+
};
|
|
5567
|
+
requestBody?: never;
|
|
5568
|
+
responses: {
|
|
5569
|
+
/** @description OK */
|
|
5570
|
+
200: {
|
|
5571
|
+
headers: {
|
|
5572
|
+
[name: string]: unknown;
|
|
5573
|
+
};
|
|
5574
|
+
content: {
|
|
5575
|
+
"application/json": components["schemas"]["IPv4PoolListResponseBody"];
|
|
5576
|
+
};
|
|
5577
|
+
};
|
|
5578
|
+
/** @description Error */
|
|
5579
|
+
default: {
|
|
5580
|
+
headers: {
|
|
5581
|
+
[name: string]: unknown;
|
|
5582
|
+
};
|
|
5583
|
+
content: {
|
|
5584
|
+
"application/json": components["schemas"]["Error"];
|
|
5585
|
+
};
|
|
5586
|
+
};
|
|
5587
|
+
};
|
|
5588
|
+
};
|
|
4484
5589
|
}
|