@leaflow/sdk 0.0.0-dev.17.geb299fb → 0.0.0-dev.172.g8c535ea
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 +34 -21
- package/dist/account/v1/index.js +4 -4
- package/dist/account/v1/schema.d.ts +374 -81
- 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 +4976 -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 +1567 -471
- 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/fabric/v1/client.d.ts +4 -0
- package/dist/fabric/v1/client.js +7 -0
- package/dist/fabric/v1/index.d.ts +115 -0
- package/dist/fabric/v1/index.js +5 -0
- package/dist/fabric/v1/schema.d.ts +2311 -0
- package/dist/fabric/v1/schema.js +5 -0
- package/dist/fleet/v1/client.d.ts +4 -0
- package/dist/fleet/v1/client.js +7 -0
- package/dist/fleet/v1/index.d.ts +15 -0
- package/dist/fleet/v1/index.js +5 -0
- package/dist/fleet/v1/schema.d.ts +291 -0
- package/dist/fleet/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 +14 -7
- package/dist/index.js +22 -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/storage/v1/client.d.ts +4 -0
- package/dist/storage/v1/client.js +7 -0
- package/dist/storage/v1/index.d.ts +35 -0
- package/dist/storage/v1/index.js +5 -0
- package/dist/storage/v1/schema.d.ts +751 -0
- package/dist/storage/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 +34 -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.
|
|
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. **Do not cache it**; 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,8 @@ export interface components {
|
|
|
1164
1382
|
/** Format: uuid */
|
|
1165
1383
|
disk_id: string;
|
|
1166
1384
|
name: string;
|
|
1385
|
+
price: components["schemas"]["CatalogReference"];
|
|
1386
|
+
order: components["schemas"]["OrderOptions"];
|
|
1167
1387
|
};
|
|
1168
1388
|
RenameBackupRequestBody: {
|
|
1169
1389
|
name: string;
|
|
@@ -1171,42 +1391,85 @@ export interface components {
|
|
|
1171
1391
|
RestoreBackupRequestBody: {
|
|
1172
1392
|
/**
|
|
1173
1393
|
* Format: uuid
|
|
1174
|
-
* @description
|
|
1394
|
+
* @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
1395
|
*/
|
|
1176
1396
|
disk_type_id: string;
|
|
1177
1397
|
name: string;
|
|
1178
1398
|
/**
|
|
1179
1399
|
* Format: int64
|
|
1180
|
-
* @description
|
|
1400
|
+
* @description Matches the size of the backup when omitted. When given, it must not be smaller than the backup
|
|
1181
1401
|
*/
|
|
1182
1402
|
size_gb?: number;
|
|
1403
|
+
price: components["schemas"]["CatalogReference"];
|
|
1404
|
+
order: components["schemas"]["OrderOptions"];
|
|
1183
1405
|
};
|
|
1184
1406
|
DiskResource: {
|
|
1185
|
-
|
|
1186
|
-
|
|
1187
|
-
|
|
1407
|
+
/**
|
|
1408
|
+
* Format: uuid
|
|
1409
|
+
* @description Availability zone the disk actually resides in. An instance must be in the same zone to attach it
|
|
1410
|
+
*/
|
|
1411
|
+
availability_zone_id: string;
|
|
1188
1412
|
/** Format: date-time */
|
|
1189
1413
|
created_at: string;
|
|
1190
|
-
/** @description 系统分配的设备名,在云服务器内看到的即为该名称 */
|
|
1191
|
-
device: string | null;
|
|
1192
1414
|
/** Format: uuid */
|
|
1193
1415
|
disk_type_id: string;
|
|
1194
1416
|
/** Format: uuid */
|
|
1195
1417
|
id: string;
|
|
1196
|
-
/** @description 系统盘随云服务器一并释放,不能卸载也不能单独删除 */
|
|
1197
|
-
is_system: boolean;
|
|
1198
1418
|
name: string;
|
|
1199
|
-
|
|
1419
|
+
/** Format: uuid */
|
|
1420
|
+
region_id: string;
|
|
1200
1421
|
/** Format: int64 */
|
|
1201
1422
|
size_gb: number;
|
|
1423
|
+
/**
|
|
1424
|
+
* Format: int64
|
|
1425
|
+
* @description IOPS this disk is allowed. Null when its type is not rate-limited.
|
|
1426
|
+
*
|
|
1427
|
+
* Computed from the disk's own capacity, so it grows when the disk is grown — but see the
|
|
1428
|
+
* note on the resize endpoint: growing a disk that is attached is refused, precisely because
|
|
1429
|
+
* the new figure would not take effect until it was attached again.
|
|
1430
|
+
*/
|
|
1431
|
+
iops: number | null;
|
|
1432
|
+
/**
|
|
1433
|
+
* Format: int64
|
|
1434
|
+
* @description Throughput this disk is allowed, in bytes per second. Null when its type is not rate-limited
|
|
1435
|
+
*/
|
|
1436
|
+
throughput_bytes_per_sec: number | null;
|
|
1202
1437
|
/** @enum {string} */
|
|
1203
1438
|
status: "provisioning" | "available" | "attaching" | "in_use" | "detaching" | "resizing" | "reverting" | "restoring" | "releasing" | "deleting" | "error";
|
|
1439
|
+
/** Format: uuid */
|
|
1440
|
+
order_id: string | null;
|
|
1441
|
+
/** Format: uuid */
|
|
1442
|
+
price_id: string | null;
|
|
1443
|
+
/** Format: uuid */
|
|
1444
|
+
subscription_item_id: string | null;
|
|
1445
|
+
/** @enum {string|null} */
|
|
1446
|
+
access_state: "pending" | "enabled" | "suspended" | "reclaimed" | null;
|
|
1447
|
+
task: components["schemas"]["Task"] | null;
|
|
1448
|
+
attachment?: components["schemas"]["DiskAttachment"] | null;
|
|
1449
|
+
/** Format: int64 */
|
|
1450
|
+
generation: number;
|
|
1451
|
+
/** Format: date-time */
|
|
1452
|
+
observed_at: string | null;
|
|
1204
1453
|
};
|
|
1205
1454
|
DiskTypeResource: {
|
|
1206
|
-
|
|
1455
|
+
/** Format: uuid */
|
|
1456
|
+
availability_zone_id: string;
|
|
1207
1457
|
/** Format: uuid */
|
|
1208
1458
|
id: string;
|
|
1209
|
-
|
|
1459
|
+
/**
|
|
1460
|
+
* Format: int64
|
|
1461
|
+
* @description IOPS a disk of `min_size_gb` gets. Null when this type is not rate-limited.
|
|
1462
|
+
*
|
|
1463
|
+
* Performance grows with capacity, so this and `iops_at_max_size` are the two ends of the
|
|
1464
|
+
* range. The exact figure for the size actually bought appears on the disk itself once it
|
|
1465
|
+
* exists.
|
|
1466
|
+
*/
|
|
1467
|
+
iops_at_min_size: number | null;
|
|
1468
|
+
/**
|
|
1469
|
+
* Format: int64
|
|
1470
|
+
* @description IOPS a disk of `max_size_gb` gets. Null when this type is not rate-limited
|
|
1471
|
+
*/
|
|
1472
|
+
iops_at_max_size: number | null;
|
|
1210
1473
|
/** Format: int64 */
|
|
1211
1474
|
max_size_gb: number;
|
|
1212
1475
|
/** @enum {string} */
|
|
@@ -1214,10 +1477,38 @@ export interface components {
|
|
|
1214
1477
|
/** Format: int64 */
|
|
1215
1478
|
min_size_gb: number;
|
|
1216
1479
|
name: string;
|
|
1217
|
-
|
|
1480
|
+
/** Format: uuid */
|
|
1481
|
+
region_id: string;
|
|
1218
1482
|
/** Format: int64 */
|
|
1219
1483
|
step_gb: number;
|
|
1220
|
-
|
|
1484
|
+
/**
|
|
1485
|
+
* Format: int64
|
|
1486
|
+
* @description Throughput a disk of `min_size_gb` gets, in **bytes per second**. Null when this type is
|
|
1487
|
+
* not rate-limited.
|
|
1488
|
+
*
|
|
1489
|
+
* Bytes rather than MiB so the number needs no rounding on the way out; divide by 1048576
|
|
1490
|
+
* for MiB/s at the point of display.
|
|
1491
|
+
*/
|
|
1492
|
+
throughput_at_min_size: number | null;
|
|
1493
|
+
/**
|
|
1494
|
+
* Format: int64
|
|
1495
|
+
* @description Throughput a disk of `max_size_gb` gets, in bytes per second. Null when this type is not rate-limited
|
|
1496
|
+
*/
|
|
1497
|
+
throughput_at_max_size: number | null;
|
|
1498
|
+
/** Format: uuid */
|
|
1499
|
+
product_id: string | null;
|
|
1500
|
+
/** Format: uuid */
|
|
1501
|
+
plan_id: string | null;
|
|
1502
|
+
lookup_key: string;
|
|
1503
|
+
name_translations: {
|
|
1504
|
+
[key: string]: string;
|
|
1505
|
+
};
|
|
1506
|
+
/** Format: uuid */
|
|
1507
|
+
snapshot_plan_id: string | null;
|
|
1508
|
+
/** Format: uuid */
|
|
1509
|
+
backup_plan_id: string | null;
|
|
1510
|
+
/** Format: uuid */
|
|
1511
|
+
private_image_plan_id: string | null;
|
|
1221
1512
|
};
|
|
1222
1513
|
DiskTypeListResponseBody: {
|
|
1223
1514
|
items: components["schemas"]["DiskTypeResource"][] | null;
|
|
@@ -1226,6 +1517,8 @@ export interface components {
|
|
|
1226
1517
|
architecture: string;
|
|
1227
1518
|
/** Format: uuid */
|
|
1228
1519
|
id: string;
|
|
1520
|
+
/** @description The account this image lets you log in as. The password set at creation belongs to this account */
|
|
1521
|
+
login_username: string;
|
|
1229
1522
|
/** Format: int64 */
|
|
1230
1523
|
min_disk_gb: number;
|
|
1231
1524
|
/** Format: int64 */
|
|
@@ -1233,20 +1526,49 @@ export interface components {
|
|
|
1233
1526
|
name: string;
|
|
1234
1527
|
os_family: string;
|
|
1235
1528
|
os_version: string;
|
|
1236
|
-
|
|
1237
|
-
|
|
1529
|
+
/** Format: uuid */
|
|
1530
|
+
region_id: string;
|
|
1531
|
+
/** @description False means a new password can only be set by rebuilding an instance created from this image */
|
|
1238
1532
|
supports_password_reset: boolean;
|
|
1533
|
+
lookup_key?: string;
|
|
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,43 @@ 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
|
+
lookup_key: string;
|
|
1588
|
+
name_translations: {
|
|
1589
|
+
[key: string]: string;
|
|
1590
|
+
};
|
|
1260
1591
|
};
|
|
1261
1592
|
InstanceTypeListResponseBody: {
|
|
1262
|
-
items: components["schemas"]["InstanceTypeResource"][]
|
|
1593
|
+
items: components["schemas"]["InstanceTypeResource"][];
|
|
1594
|
+
/** Format: int64 */
|
|
1595
|
+
page: number;
|
|
1596
|
+
/** Format: int64 */
|
|
1597
|
+
page_size: number;
|
|
1598
|
+
/** Format: int64 */
|
|
1599
|
+
total_count?: number;
|
|
1263
1600
|
};
|
|
1264
1601
|
RegionResource: {
|
|
1265
|
-
code: string;
|
|
1266
1602
|
country_code: string;
|
|
1267
1603
|
name: string;
|
|
1604
|
+
lookup_key: string;
|
|
1605
|
+
/** Format: uuid */
|
|
1606
|
+
id: string;
|
|
1268
1607
|
};
|
|
1269
1608
|
RegionListResponseBody: {
|
|
1270
1609
|
items: components["schemas"]["RegionResource"][] | null;
|
|
1271
1610
|
};
|
|
1272
1611
|
ZoneResource: {
|
|
1273
|
-
code: string;
|
|
1274
1612
|
name: string;
|
|
1613
|
+
lookup_key: string;
|
|
1614
|
+
/** Format: uuid */
|
|
1615
|
+
id: string;
|
|
1275
1616
|
};
|
|
1276
1617
|
ZoneListResponseBody: {
|
|
1277
1618
|
items: components["schemas"]["ZoneResource"][] | null;
|
|
@@ -1280,16 +1621,21 @@ export interface components {
|
|
|
1280
1621
|
items: components["schemas"]["DiskResource"][] | null;
|
|
1281
1622
|
};
|
|
1282
1623
|
CreateDiskRequestBody: {
|
|
1283
|
-
/**
|
|
1624
|
+
/**
|
|
1625
|
+
* Format: uuid
|
|
1626
|
+
* @description A disk type currently on sale. A withdrawn one is rejected even though its identifier still resolves
|
|
1627
|
+
*/
|
|
1284
1628
|
disk_type_id: string;
|
|
1285
1629
|
name: string;
|
|
1286
1630
|
/** Format: int64 */
|
|
1287
1631
|
size_gb: number;
|
|
1288
1632
|
/**
|
|
1289
1633
|
* Format: uuid
|
|
1290
|
-
* @description
|
|
1634
|
+
* @description Restore from this snapshot. When given, the capacity need only be no smaller than the snapshot
|
|
1291
1635
|
*/
|
|
1292
1636
|
snapshot_id?: string;
|
|
1637
|
+
price: components["schemas"]["CatalogReference"];
|
|
1638
|
+
order: components["schemas"]["OrderOptions"];
|
|
1293
1639
|
};
|
|
1294
1640
|
RenameDiskRequestBody: {
|
|
1295
1641
|
name: string;
|
|
@@ -1297,210 +1643,327 @@ export interface components {
|
|
|
1297
1643
|
ResizeDiskRequestBody: {
|
|
1298
1644
|
/**
|
|
1299
1645
|
* Format: int64
|
|
1300
|
-
* @description
|
|
1646
|
+
* @description Must be larger than the current capacity
|
|
1301
1647
|
*/
|
|
1302
1648
|
size_gb: number;
|
|
1649
|
+
price: components["schemas"]["CatalogReference"];
|
|
1650
|
+
order: components["schemas"]["OrderOptions"];
|
|
1303
1651
|
};
|
|
1304
1652
|
RevertDiskRequestBody: {
|
|
1305
1653
|
/**
|
|
1306
1654
|
* Format: uuid
|
|
1307
|
-
* @description
|
|
1655
|
+
* @description Must be the most recent snapshot of the disk
|
|
1308
1656
|
*/
|
|
1309
1657
|
snapshot_id: string;
|
|
1310
1658
|
};
|
|
1311
1659
|
FloatingIPResource: {
|
|
1312
1660
|
address: string;
|
|
1313
|
-
attached_fixed_ip: string | null;
|
|
1314
|
-
attached_port_id: string | null;
|
|
1315
1661
|
/** Format: int64 */
|
|
1316
1662
|
bandwidth_mbps: number | null;
|
|
1317
1663
|
/** Format: date-time */
|
|
1318
1664
|
created_at: string;
|
|
1319
|
-
/** Format: date-time */
|
|
1320
|
-
detached_at: string | null;
|
|
1321
1665
|
/** Format: uuid */
|
|
1322
1666
|
id: string;
|
|
1323
|
-
|
|
1324
|
-
|
|
1325
|
-
|
|
1326
|
-
|
|
1327
|
-
|
|
1328
|
-
|
|
1667
|
+
/** Format: uuid */
|
|
1668
|
+
region_id: string;
|
|
1669
|
+
/** @enum {string} */
|
|
1670
|
+
status: "pending" | "available" | "deleting" | "error" | "unknown";
|
|
1671
|
+
/** Format: uuid */
|
|
1672
|
+
order_id: string | null;
|
|
1673
|
+
/** Format: uuid */
|
|
1674
|
+
price_id: string | null;
|
|
1675
|
+
/** Format: uuid */
|
|
1676
|
+
subscription_item_id: string | null;
|
|
1677
|
+
/** @enum {string|null} */
|
|
1678
|
+
access_state: "pending" | "enabled" | "suspended" | "reclaimed" | null;
|
|
1679
|
+
task: components["schemas"]["Task"] | null;
|
|
1680
|
+
/** Format: uuid */
|
|
1681
|
+
bandwidth_order_id: string | null;
|
|
1682
|
+
/** Format: uuid */
|
|
1683
|
+
bandwidth_price_id: string | null;
|
|
1684
|
+
/** Format: uuid */
|
|
1685
|
+
bandwidth_subscription_item_id: string | null;
|
|
1686
|
+
/** @enum {string|null} */
|
|
1687
|
+
bandwidth_access_state: "pending" | "enabled" | "suspended" | "reclaimed" | null;
|
|
1688
|
+
/** Format: int64 */
|
|
1689
|
+
generation: number;
|
|
1690
|
+
/** Format: date-time */
|
|
1691
|
+
observed_at: string | null;
|
|
1692
|
+
binding: components["schemas"]["IPv4Binding"] | null;
|
|
1329
1693
|
};
|
|
1330
1694
|
FloatingIPListResponseBody: {
|
|
1331
1695
|
items: components["schemas"]["FloatingIPResource"][] | null;
|
|
1332
1696
|
};
|
|
1333
1697
|
AllocateFloatingIPRequestBody: {
|
|
1334
|
-
/** @description
|
|
1698
|
+
/** @description The address to allocate. Allocated by the platform when omitted */
|
|
1335
1699
|
address?: string;
|
|
1700
|
+
/**
|
|
1701
|
+
* Format: int64
|
|
1702
|
+
* @description The bandwidth ceiling of this address, in Mbit/s, applied to both directions.
|
|
1703
|
+
*
|
|
1704
|
+
* Required, and there is no "unlimited": an address with no ceiling runs at line rate and is
|
|
1705
|
+
* charged nothing for the traffic, while the address itself bills normally — so the invoice
|
|
1706
|
+
* looks correct and nothing anywhere reports it.
|
|
1707
|
+
*
|
|
1708
|
+
* It is billed separately from the address, per Mbit/s-hour, and appears as its own line on
|
|
1709
|
+
* the order. Changing it later goes through the bandwidth endpoint.
|
|
1710
|
+
*/
|
|
1711
|
+
bandwidth_mbps: number;
|
|
1336
1712
|
/** Format: uuid */
|
|
1337
1713
|
private_network_id: string;
|
|
1714
|
+
/** Format: uuid */
|
|
1715
|
+
ipv4_pool_id: string;
|
|
1716
|
+
price: components["schemas"]["CatalogReference"];
|
|
1717
|
+
bandwidth_price: components["schemas"]["CatalogReference"];
|
|
1718
|
+
order: components["schemas"]["OrderOptions"];
|
|
1338
1719
|
};
|
|
1339
1720
|
SetBandwidthRequestBody: {
|
|
1340
1721
|
/**
|
|
1341
1722
|
* Format: int64
|
|
1342
|
-
* @description
|
|
1723
|
+
* @description Applied to both directions
|
|
1343
1724
|
*/
|
|
1344
1725
|
mbps: number;
|
|
1726
|
+
price: components["schemas"]["CatalogReference"];
|
|
1727
|
+
order: components["schemas"]["OrderOptions"];
|
|
1345
1728
|
};
|
|
1346
1729
|
BindFloatingIPRequestBody: {
|
|
1347
1730
|
/** Format: uuid */
|
|
1348
|
-
|
|
1731
|
+
port_address_id: string;
|
|
1349
1732
|
};
|
|
1350
1733
|
InstanceResource: {
|
|
1351
|
-
|
|
1734
|
+
/** Format: uuid */
|
|
1735
|
+
availability_zone_id: string;
|
|
1352
1736
|
/** Format: date-time */
|
|
1353
1737
|
created_at: string;
|
|
1354
|
-
/** @description
|
|
1738
|
+
/** @description Hostname inside the instance; equals the instance id */
|
|
1355
1739
|
hostname: string;
|
|
1356
1740
|
/** Format: uuid */
|
|
1357
1741
|
id: string;
|
|
1358
1742
|
/**
|
|
1359
1743
|
* Format: uuid
|
|
1360
|
-
* @description
|
|
1744
|
+
* @description Non-empty when the instance was created from a platform image
|
|
1361
1745
|
*/
|
|
1362
1746
|
image_id: string | null;
|
|
1363
1747
|
/**
|
|
1364
1748
|
* Format: uuid
|
|
1365
|
-
* @description
|
|
1749
|
+
* @description The instance type in effect, and the basis for billing
|
|
1366
1750
|
*/
|
|
1367
1751
|
instance_type_id: string;
|
|
1368
|
-
/** @description
|
|
1752
|
+
/** @description IPv6 address of the primary network interface. Assigned automatically once IPv6 is enabled on the private network */
|
|
1369
1753
|
ipv6_address: string | null;
|
|
1754
|
+
/** @description Your own classification of this instance, as key-value pairs. Empty when never set */
|
|
1755
|
+
labels: {
|
|
1756
|
+
[key: string]: string;
|
|
1757
|
+
};
|
|
1758
|
+
/** @description The account to log in as over SSH. The password set at creation belongs to this account */
|
|
1759
|
+
login_username: string;
|
|
1370
1760
|
name: string;
|
|
1761
|
+
/** @description A free-text note about this instance. Empty when never set */
|
|
1762
|
+
notes: string;
|
|
1371
1763
|
/**
|
|
1372
1764
|
* Format: uuid
|
|
1373
|
-
* @description
|
|
1374
|
-
*/
|
|
1375
|
-
pending_instance_type_id: string | null;
|
|
1376
|
-
/**
|
|
1377
|
-
* Format: uuid
|
|
1378
|
-
* @description 从自制的私有镜像创建时非空
|
|
1765
|
+
* @description Non-empty when the instance was created from a private image
|
|
1379
1766
|
*/
|
|
1380
1767
|
private_image_id: string | null;
|
|
1381
|
-
/** @description
|
|
1768
|
+
/** @description Private address of the instance */
|
|
1382
1769
|
private_ip: string | null;
|
|
1383
|
-
/**
|
|
1770
|
+
/** Format: uuid */
|
|
1384
1771
|
private_network_id: string | null;
|
|
1385
|
-
/** @description
|
|
1772
|
+
/** @description Floating IPv4 addresses bound to the primary network interface; an empty array when none are bound */
|
|
1386
1773
|
public_ips: string[] | null;
|
|
1387
|
-
|
|
1774
|
+
/** Format: uuid */
|
|
1775
|
+
region_id: string;
|
|
1388
1776
|
/** @enum {string} */
|
|
1389
|
-
status: "
|
|
1390
|
-
/**
|
|
1777
|
+
status: "pending" | "building" | "active" | "stopped" | "paused" | "suspended" | "shelved" | "shelved_offloaded" | "rescued" | "resized" | "deleting" | "deleted" | "error" | "unknown";
|
|
1778
|
+
/** Format: uuid */
|
|
1391
1779
|
subnet_id: string | null;
|
|
1392
|
-
/**
|
|
1393
|
-
* Format: date-time
|
|
1394
|
-
* @description 非空表示已被平台停服,需先解除后才能操作
|
|
1395
|
-
*/
|
|
1396
|
-
suspended_at: string | null;
|
|
1397
1780
|
/** Format: date-time */
|
|
1398
1781
|
updated_at: string;
|
|
1782
|
+
/** @enum {string} */
|
|
1783
|
+
desired_state: "running" | "stopped" | "deleted";
|
|
1784
|
+
/** @enum {string} */
|
|
1785
|
+
power_state: "no_state" | "running" | "paused" | "shutdown" | "crashed" | "suspended" | "unknown";
|
|
1786
|
+
/** @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. */
|
|
1787
|
+
task_state: string;
|
|
1788
|
+
/** Format: int64 */
|
|
1789
|
+
generation: number;
|
|
1790
|
+
/** Format: date-time */
|
|
1791
|
+
observed_at: string | null;
|
|
1792
|
+
restrictions: components["schemas"]["InstanceRestriction"][];
|
|
1793
|
+
task: components["schemas"]["Task"] | null;
|
|
1794
|
+
/** Format: uuid */
|
|
1795
|
+
order_id: string | null;
|
|
1796
|
+
/** Format: uuid */
|
|
1797
|
+
price_id: string | null;
|
|
1798
|
+
/** Format: uuid */
|
|
1799
|
+
subscription_item_id: string | null;
|
|
1800
|
+
/** @enum {string|null} */
|
|
1801
|
+
access_state: "pending" | "enabled" | "suspended" | "reclaimed" | null;
|
|
1802
|
+
/**
|
|
1803
|
+
* Format: uuid
|
|
1804
|
+
* @description Non-empty when the instance was created from a disk you already had, instead of from an image
|
|
1805
|
+
*/
|
|
1806
|
+
source_disk_id: string | null;
|
|
1399
1807
|
};
|
|
1400
1808
|
InstanceListResponseBody: {
|
|
1401
|
-
items: components["schemas"]["InstanceResource"][]
|
|
1809
|
+
items: components["schemas"]["InstanceResource"][];
|
|
1810
|
+
/** Format: int64 */
|
|
1811
|
+
page: number;
|
|
1812
|
+
/** Format: int64 */
|
|
1813
|
+
page_size: number;
|
|
1814
|
+
/** Format: int64 */
|
|
1815
|
+
total_count?: number;
|
|
1402
1816
|
};
|
|
1403
1817
|
LaunchInstanceRequestBody: {
|
|
1818
|
+
/**
|
|
1819
|
+
* Format: uuid
|
|
1820
|
+
* @description Bind a floating IP you already hold, instead of allocating a new one. It must be idle and in
|
|
1821
|
+
* the same region.
|
|
1822
|
+
*
|
|
1823
|
+
* Mutually exclusive with `bandwidth_mbps`: an address you already hold has its own bandwidth
|
|
1824
|
+
* ceiling, set when it was allocated, and changing it is a separate operation.
|
|
1825
|
+
*
|
|
1826
|
+
* Like `bandwidth_mbps`, this happens **inside the creation**: if binding fails, no instance is
|
|
1827
|
+
* created. Binding afterwards is still possible from the instance page, but then it is two
|
|
1828
|
+
* operations and a failure in between leaves an instance you cannot reach.
|
|
1829
|
+
*
|
|
1830
|
+
* Only one instance can be created when it is used — one address binds to one interface.
|
|
1831
|
+
*/
|
|
1832
|
+
floating_ip_id?: string;
|
|
1404
1833
|
/**
|
|
1405
1834
|
* Format: int64
|
|
1406
|
-
* @description
|
|
1835
|
+
* @description Number of instances to create; 1 when omitted. Names are numbered automatically for several
|
|
1836
|
+
* @default 1
|
|
1407
1837
|
*/
|
|
1408
1838
|
count?: number;
|
|
1409
|
-
/** @description
|
|
1839
|
+
/** @description Have the platform generate a random password, returned only in this response */
|
|
1410
1840
|
generate_password?: boolean;
|
|
1411
1841
|
/**
|
|
1412
1842
|
* Format: uuid
|
|
1413
|
-
* @description
|
|
1843
|
+
* @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`
|
|
1844
|
+
*/
|
|
1845
|
+
boot_disk_id?: string;
|
|
1846
|
+
/**
|
|
1847
|
+
* Format: uuid
|
|
1848
|
+
* @description A platform image, and it must be one currently on sale. Exactly one of this, `private_image_id` and `boot_disk_id`
|
|
1414
1849
|
*/
|
|
1415
1850
|
image_id?: string;
|
|
1416
|
-
/**
|
|
1851
|
+
/**
|
|
1852
|
+
* Format: uuid
|
|
1853
|
+
* @description An instance type currently on sale. A withdrawn one is rejected even though its identifier still resolves
|
|
1854
|
+
*/
|
|
1417
1855
|
instance_type_id: string;
|
|
1856
|
+
/** @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 */
|
|
1857
|
+
login_username?: string;
|
|
1418
1858
|
name: string;
|
|
1419
|
-
/** @description root
|
|
1859
|
+
/** @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
1860
|
password?: string;
|
|
1421
1861
|
/**
|
|
1422
1862
|
* Format: uuid
|
|
1423
|
-
* @description
|
|
1863
|
+
* @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
1864
|
*/
|
|
1425
1865
|
port_id?: string;
|
|
1426
1866
|
/**
|
|
1427
1867
|
* Format: uuid
|
|
1428
|
-
* @description
|
|
1868
|
+
* @description A private image. Exactly one of this, `image_id` and `boot_disk_id`
|
|
1429
1869
|
*/
|
|
1430
1870
|
private_image_id?: string;
|
|
1431
|
-
/**
|
|
1432
|
-
* Format: int64
|
|
1433
|
-
* @description 系统盘容量(GB)。留空时按镜像要求与平台下限自动选择
|
|
1434
|
-
*/
|
|
1435
|
-
root_disk_gb?: number;
|
|
1436
|
-
/** @description 新建主网卡时必填,至少一个;不会自动使用默认安全组。使用 port_id 时忽略——那张网卡的安全组在创建它时已经定了 */
|
|
1871
|
+
/** @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
1872
|
security_group_ids?: string[] | null;
|
|
1438
1873
|
/**
|
|
1439
1874
|
* Format: uuid
|
|
1440
|
-
* @description
|
|
1875
|
+
* @description Create the primary network interface in this subnet. Exactly one of this and `port_id`
|
|
1441
1876
|
*/
|
|
1442
1877
|
subnet_id?: string;
|
|
1878
|
+
order: components["schemas"]["OrderOptions"];
|
|
1879
|
+
price: components["schemas"]["CatalogReference"];
|
|
1880
|
+
boot_disk?: components["schemas"]["NewBootDisk"];
|
|
1881
|
+
floating_ip?: components["schemas"]["NewFloatingIP"];
|
|
1443
1882
|
};
|
|
1444
|
-
|
|
1445
|
-
/** @description
|
|
1446
|
-
|
|
1447
|
-
|
|
1448
|
-
|
|
1449
|
-
|
|
1450
|
-
|
|
1883
|
+
SetInstanceLabelsRequestBody: {
|
|
1884
|
+
/** @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 */
|
|
1885
|
+
labels: {
|
|
1886
|
+
[key: string]: string;
|
|
1887
|
+
};
|
|
1888
|
+
};
|
|
1889
|
+
SetInstanceNotesRequestBody: {
|
|
1890
|
+
/** @description The complete note. Send an empty string to clear it */
|
|
1891
|
+
notes: string;
|
|
1451
1892
|
};
|
|
1452
1893
|
RenameInstanceRequestBody: {
|
|
1453
1894
|
name: string;
|
|
1454
1895
|
};
|
|
1455
|
-
|
|
1456
|
-
/** @
|
|
1457
|
-
action: "start" | "stop" | "reboot";
|
|
1458
|
-
/** @description 仅适用于 reboot。强制重启不等待操作系统正常关闭,未落盘的数据会丢失,用于系统已无响应的情况 */
|
|
1896
|
+
RebootInstanceRequestBody: {
|
|
1897
|
+
/** @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
1898
|
force?: boolean;
|
|
1460
1899
|
};
|
|
1900
|
+
RunCommandRequestBody: {
|
|
1901
|
+
/** @description Run by the login shell, so pipes, redirection and `&&` work. It cannot read standard input */
|
|
1902
|
+
command: string;
|
|
1903
|
+
/**
|
|
1904
|
+
* Format: int64
|
|
1905
|
+
* @description Kill the command after this long. 60 when omitted
|
|
1906
|
+
*/
|
|
1907
|
+
timeout_seconds?: number;
|
|
1908
|
+
};
|
|
1909
|
+
CommandResultResponseBody: {
|
|
1910
|
+
/**
|
|
1911
|
+
* Format: int64
|
|
1912
|
+
* @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
|
|
1913
|
+
*/
|
|
1914
|
+
exit_code: number | null;
|
|
1915
|
+
stderr: string;
|
|
1916
|
+
stdout: string;
|
|
1917
|
+
/** @description True when the command was still running at the timeout and was killed */
|
|
1918
|
+
timed_out: boolean;
|
|
1919
|
+
/** @description True when either stream hit the 1 MiB cap and the rest was discarded */
|
|
1920
|
+
truncated: boolean;
|
|
1921
|
+
};
|
|
1461
1922
|
ConsoleResponseBody: {
|
|
1462
|
-
/** @description
|
|
1923
|
+
/** @description Connection address of the remote console; single-use and expires within minutes */
|
|
1463
1924
|
console_url: string;
|
|
1464
1925
|
};
|
|
1465
1926
|
ConsoleOutputResponseBody: {
|
|
1466
|
-
/** @description
|
|
1927
|
+
/** @description Raw text of the console output, in the same line order as inside the instance */
|
|
1467
1928
|
output: string;
|
|
1468
1929
|
};
|
|
1469
1930
|
ResetPasswordRequestBody: {
|
|
1470
|
-
/** @description
|
|
1931
|
+
/** @description Have the platform generate a random password, returned only in this response */
|
|
1471
1932
|
generate_password?: boolean;
|
|
1472
|
-
/** @description
|
|
1933
|
+
/** @description New root password. Exactly one of this and `generate_password` */
|
|
1473
1934
|
password?: string;
|
|
1474
1935
|
};
|
|
1475
1936
|
ResetPasswordResponseBody: {
|
|
1476
|
-
/** @description
|
|
1937
|
+
/** @description The password generated by the platform, returned only in this response. Empty when the password was supplied in the request */
|
|
1477
1938
|
password: string;
|
|
1478
1939
|
};
|
|
1479
1940
|
RebuildInstanceRequestBody: {
|
|
1480
1941
|
generate_password?: boolean;
|
|
1481
1942
|
/**
|
|
1482
1943
|
* Format: uuid
|
|
1483
|
-
* @description
|
|
1944
|
+
* @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
1945
|
*/
|
|
1485
1946
|
image_id?: string;
|
|
1486
1947
|
password?: string;
|
|
1487
1948
|
/**
|
|
1488
1949
|
* Format: uuid
|
|
1489
|
-
* @description
|
|
1950
|
+
* @description A private image. Exactly one of this and `image_id`
|
|
1490
1951
|
*/
|
|
1491
1952
|
private_image_id?: string;
|
|
1492
1953
|
};
|
|
1493
1954
|
RebuildInstanceResponseBody: {
|
|
1494
1955
|
instance: components["schemas"]["InstanceResource"];
|
|
1495
|
-
/** @description
|
|
1956
|
+
/** @description Returned only in this response; store it immediately */
|
|
1496
1957
|
password: string;
|
|
1497
1958
|
};
|
|
1498
1959
|
ResizeInstanceRequestBody: {
|
|
1499
1960
|
/**
|
|
1500
1961
|
* Format: uuid
|
|
1501
|
-
* @description
|
|
1962
|
+
* @description Must be in the same region and availability zone as the current instance type
|
|
1502
1963
|
*/
|
|
1503
1964
|
instance_type_id: string;
|
|
1965
|
+
order: components["schemas"]["OrderOptions"];
|
|
1966
|
+
price: components["schemas"]["CatalogReference"];
|
|
1504
1967
|
};
|
|
1505
1968
|
AttachDiskRequestBody: {
|
|
1506
1969
|
/** Format: uuid */
|
|
@@ -1511,21 +1974,22 @@ export interface components {
|
|
|
1511
1974
|
floating_ip_id: string;
|
|
1512
1975
|
};
|
|
1513
1976
|
PortResource: {
|
|
1514
|
-
attached_instance_id: string | null;
|
|
1515
1977
|
/** Format: uuid */
|
|
1516
1978
|
id: string;
|
|
1517
|
-
ipv6_address: string | null;
|
|
1518
|
-
/** @description 主网卡随云服务器一并创建和释放,不可单独卸载 */
|
|
1519
|
-
is_primary: boolean;
|
|
1520
1979
|
mac: string | null;
|
|
1521
1980
|
name: string;
|
|
1522
|
-
private_ip: string | null;
|
|
1523
1981
|
/** Format: uuid */
|
|
1524
1982
|
private_network_id: string;
|
|
1525
|
-
/** @description
|
|
1983
|
+
/** @description Floating IPv4 addresses bound to this network interface; an empty array when none are bound */
|
|
1526
1984
|
public_ips: string[] | null;
|
|
1527
|
-
|
|
1528
|
-
|
|
1985
|
+
addresses?: components["schemas"]["PortAddress"][];
|
|
1986
|
+
attachment?: components["schemas"]["PortAttachment"] | null;
|
|
1987
|
+
/** @enum {string} */
|
|
1988
|
+
status: "pending" | "available" | "deleting" | "error" | "unknown";
|
|
1989
|
+
/** Format: int64 */
|
|
1990
|
+
generation: number;
|
|
1991
|
+
/** Format: date-time */
|
|
1992
|
+
observed_at: string | null;
|
|
1529
1993
|
};
|
|
1530
1994
|
PortListResponseBody: {
|
|
1531
1995
|
items: components["schemas"]["PortResource"][] | null;
|
|
@@ -1535,90 +1999,124 @@ export interface components {
|
|
|
1535
1999
|
port_id: string;
|
|
1536
2000
|
};
|
|
1537
2001
|
OperationLogResource: {
|
|
1538
|
-
/** @description
|
|
2002
|
+
/** @description Name of the operation; matches the operation id of the endpoint */
|
|
1539
2003
|
action: string;
|
|
1540
|
-
/** @description
|
|
2004
|
+
/** @description The user who initiated the operation. Empty when the platform performed it */
|
|
1541
2005
|
actor: string | null;
|
|
1542
|
-
/**
|
|
2006
|
+
/**
|
|
2007
|
+
* @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.
|
|
2008
|
+
*
|
|
2009
|
+
* 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.
|
|
2010
|
+
*/
|
|
2011
|
+
actor_name: string | null;
|
|
2012
|
+
/** @description True when the operation was performed by the platform */
|
|
1543
2013
|
by_platform: boolean;
|
|
1544
2014
|
/** Format: date-time */
|
|
1545
2015
|
created_at: string;
|
|
1546
|
-
/** @description
|
|
2016
|
+
/** @description Brief reason for the failure */
|
|
1547
2017
|
failure: string | null;
|
|
1548
2018
|
/** Format: uuid */
|
|
1549
2019
|
id: string;
|
|
1550
|
-
/** @description
|
|
2020
|
+
/** @description Path and query parameters of the request. Fields such as passwords are redacted */
|
|
1551
2021
|
payload: {
|
|
1552
2022
|
[key: string]: unknown;
|
|
1553
2023
|
};
|
|
1554
|
-
|
|
1555
|
-
|
|
2024
|
+
/** Format: uuid */
|
|
2025
|
+
region_id: string | null;
|
|
2026
|
+
/** @description Empty for create operations: the id of the new resource is in the response, not in the request path */
|
|
1556
2027
|
subject_id: string;
|
|
1557
2028
|
subject_type: string;
|
|
1558
2029
|
succeeded: boolean;
|
|
1559
2030
|
};
|
|
1560
2031
|
OperationLogListResponseBody: {
|
|
1561
|
-
items: components["schemas"]["OperationLogResource"][]
|
|
2032
|
+
items: components["schemas"]["OperationLogResource"][];
|
|
2033
|
+
/** Format: int64 */
|
|
2034
|
+
page: number;
|
|
2035
|
+
/** Format: int64 */
|
|
2036
|
+
page_size: number;
|
|
1562
2037
|
/** Format: int64 */
|
|
1563
|
-
|
|
2038
|
+
total_count?: number;
|
|
1564
2039
|
};
|
|
1565
2040
|
CreatePortRequestBody: {
|
|
1566
2041
|
name?: string;
|
|
1567
|
-
/** @description
|
|
1568
|
-
private_ip?: string;
|
|
1569
|
-
/** @description 至少一个,且必须属于同一个私有网络 */
|
|
2042
|
+
/** @description At least one, and all must belong to the same private network */
|
|
1570
2043
|
security_group_ids: string[] | null;
|
|
1571
2044
|
/** Format: uuid */
|
|
1572
2045
|
subnet_id: string;
|
|
2046
|
+
/** @description The private address to assign. Allocated automatically when omitted */
|
|
2047
|
+
address?: string;
|
|
1573
2048
|
};
|
|
1574
2049
|
PrivateImageResource: {
|
|
1575
2050
|
architecture: string;
|
|
1576
2051
|
/** Format: date-time */
|
|
1577
2052
|
created_at: string;
|
|
1578
|
-
/** @description
|
|
2053
|
+
/** @description Reason the capture failed; non-empty only when `status` is `error` */
|
|
1579
2054
|
failure: string | null;
|
|
1580
2055
|
/** Format: uuid */
|
|
1581
2056
|
id: string;
|
|
2057
|
+
/** @description The account this image lets you log in as. The password set at creation belongs to this account */
|
|
2058
|
+
login_username: string;
|
|
1582
2059
|
/**
|
|
1583
2060
|
* Format: int64
|
|
1584
|
-
* @description
|
|
2061
|
+
* @description The system disk of an instance created from this image cannot be smaller than this
|
|
1585
2062
|
*/
|
|
1586
2063
|
min_disk_gb: number;
|
|
1587
2064
|
/**
|
|
1588
2065
|
* Format: int64
|
|
1589
|
-
* @description
|
|
2066
|
+
* @description The instance type of an instance created from this image must have at least this much memory
|
|
1590
2067
|
*/
|
|
1591
2068
|
min_ram_mb: number;
|
|
1592
2069
|
name: string;
|
|
1593
2070
|
os_family: string;
|
|
1594
2071
|
os_version: string;
|
|
1595
|
-
/**
|
|
1596
|
-
|
|
2072
|
+
/** Format: uuid */
|
|
2073
|
+
region_id: string;
|
|
1597
2074
|
/**
|
|
1598
2075
|
* Format: int64
|
|
1599
|
-
* @description
|
|
2076
|
+
* @description Storage occupied by the image; 0 until the capture completes
|
|
1600
2077
|
*/
|
|
1601
2078
|
size_bytes: number;
|
|
1602
2079
|
/**
|
|
1603
2080
|
* Format: uuid
|
|
1604
|
-
* @description
|
|
2081
|
+
* @description The instance this image was captured from. The image remains usable after that instance is released
|
|
1605
2082
|
*/
|
|
1606
2083
|
source_instance_id: string | null;
|
|
1607
2084
|
/** @enum {string} */
|
|
1608
2085
|
status: "provisioning" | "uploading" | "available" | "deleting" | "error";
|
|
1609
|
-
/** @description
|
|
2086
|
+
/** @description False means a new password can only be set by rebuilding an instance created from this image */
|
|
1610
2087
|
supports_password_reset: boolean;
|
|
2088
|
+
/** Format: uuid */
|
|
2089
|
+
order_id: string | null;
|
|
2090
|
+
/** Format: uuid */
|
|
2091
|
+
price_id: string | null;
|
|
2092
|
+
/** Format: uuid */
|
|
2093
|
+
subscription_item_id: string | null;
|
|
2094
|
+
/** @enum {string|null} */
|
|
2095
|
+
access_state: "pending" | "enabled" | "suspended" | "reclaimed" | null;
|
|
2096
|
+
task: components["schemas"]["Task"] | null;
|
|
2097
|
+
/** Format: int64 */
|
|
2098
|
+
generation: number;
|
|
2099
|
+
/** Format: date-time */
|
|
2100
|
+
observed_at: string | null;
|
|
1611
2101
|
};
|
|
1612
2102
|
PrivateImageListResponseBody: {
|
|
1613
|
-
items: components["schemas"]["PrivateImageResource"][]
|
|
2103
|
+
items: components["schemas"]["PrivateImageResource"][];
|
|
2104
|
+
/** Format: int64 */
|
|
2105
|
+
page: number;
|
|
2106
|
+
/** Format: int64 */
|
|
2107
|
+
page_size: number;
|
|
2108
|
+
/** Format: int64 */
|
|
2109
|
+
total_count?: number;
|
|
1614
2110
|
};
|
|
1615
2111
|
CreatePrivateImageRequestBody: {
|
|
1616
2112
|
/**
|
|
1617
2113
|
* Format: uuid
|
|
1618
|
-
* @description
|
|
2114
|
+
* @description Captured from the system disk of this instance; data disks are not included
|
|
1619
2115
|
*/
|
|
1620
2116
|
instance_id: string;
|
|
1621
2117
|
name: string;
|
|
2118
|
+
price: components["schemas"]["CatalogReference"];
|
|
2119
|
+
order: components["schemas"]["OrderOptions"];
|
|
1622
2120
|
};
|
|
1623
2121
|
RenamePrivateImageRequestBody: {
|
|
1624
2122
|
name: string;
|
|
@@ -1631,9 +2129,10 @@ export interface components {
|
|
|
1631
2129
|
/** Format: uuid */
|
|
1632
2130
|
id: string;
|
|
1633
2131
|
name: string;
|
|
1634
|
-
|
|
2132
|
+
/** Format: uuid */
|
|
2133
|
+
region_id: string;
|
|
1635
2134
|
/** @enum {string} */
|
|
1636
|
-
status: "available" | "error";
|
|
2135
|
+
status: "pending" | "available" | "deleting" | "error" | "unknown";
|
|
1637
2136
|
/** Format: date-time */
|
|
1638
2137
|
updated_at: string;
|
|
1639
2138
|
};
|
|
@@ -1641,20 +2140,21 @@ export interface components {
|
|
|
1641
2140
|
items: components["schemas"]["PrivateNetworkResource"][] | null;
|
|
1642
2141
|
};
|
|
1643
2142
|
CreatePrivateNetworkRequestBody: {
|
|
1644
|
-
/** @description
|
|
2143
|
+
/** @description Must be an RFC 1918 private CIDR with a prefix length between /8 and /24, for example `10.0.0.0/16` */
|
|
1645
2144
|
cidr: string;
|
|
1646
2145
|
name: string;
|
|
1647
|
-
|
|
2146
|
+
/** Format: uuid */
|
|
2147
|
+
region_id: string;
|
|
1648
2148
|
};
|
|
1649
2149
|
RenamePrivateNetworkRequestBody: {
|
|
1650
2150
|
name: string;
|
|
1651
2151
|
};
|
|
1652
2152
|
IPv6ResponseBody: {
|
|
1653
|
-
/** @description
|
|
2153
|
+
/** @description The allocated /64 prefix; empty while IPv6 is disabled */
|
|
1654
2154
|
cidr: string;
|
|
1655
2155
|
enabled: boolean;
|
|
1656
2156
|
/**
|
|
1657
|
-
* @description
|
|
2157
|
+
* @description `active` means IPv6 is fully available
|
|
1658
2158
|
* @enum {string}
|
|
1659
2159
|
*/
|
|
1660
2160
|
status: "pending" | "active" | "draining";
|
|
@@ -1673,9 +2173,9 @@ export interface components {
|
|
|
1673
2173
|
};
|
|
1674
2174
|
CreateRouteRequestBody: {
|
|
1675
2175
|
description?: string;
|
|
1676
|
-
/** @description
|
|
2176
|
+
/** @description Destination CIDR. It cannot be `0.0.0.0/0`, nor the CIDR of a subnet of this network */
|
|
1677
2177
|
destination: string;
|
|
1678
|
-
/** @description
|
|
2178
|
+
/** @description Private address of an instance; must fall inside a subnet of this private network */
|
|
1679
2179
|
nexthop: string;
|
|
1680
2180
|
};
|
|
1681
2181
|
SubnetResource: {
|
|
@@ -1696,12 +2196,12 @@ export interface components {
|
|
|
1696
2196
|
items: components["schemas"]["SubnetResource"][] | null;
|
|
1697
2197
|
};
|
|
1698
2198
|
CreateSubnetRequestBody: {
|
|
1699
|
-
/** @description
|
|
2199
|
+
/** @description Must fall inside the CIDR of the private network and must not overlap an existing subnet */
|
|
1700
2200
|
cidr: string;
|
|
1701
2201
|
name: string;
|
|
1702
2202
|
};
|
|
1703
2203
|
NextFreeCidrResponseBody: {
|
|
1704
|
-
/** @description
|
|
2204
|
+
/** @description Empty when the private network has no free CIDR left for that prefix length */
|
|
1705
2205
|
cidr: string;
|
|
1706
2206
|
};
|
|
1707
2207
|
SecurityGroupResource: {
|
|
@@ -1710,7 +2210,7 @@ export interface components {
|
|
|
1710
2210
|
description: string;
|
|
1711
2211
|
/** Format: uuid */
|
|
1712
2212
|
id: string;
|
|
1713
|
-
/** @description
|
|
2213
|
+
/** @description The default security group is released with its private network and cannot be deleted individually */
|
|
1714
2214
|
is_default: boolean;
|
|
1715
2215
|
name: string;
|
|
1716
2216
|
/** Format: uuid */
|
|
@@ -1737,12 +2237,12 @@ export interface components {
|
|
|
1737
2237
|
id: string;
|
|
1738
2238
|
/**
|
|
1739
2239
|
* Format: int64
|
|
1740
|
-
* @description ICMP
|
|
2240
|
+
* @description Denotes the ICMP code rather than a port when the protocol is ICMP
|
|
1741
2241
|
*/
|
|
1742
2242
|
port_range_max: number | null;
|
|
1743
2243
|
/**
|
|
1744
2244
|
* Format: int64
|
|
1745
|
-
* @description ICMP
|
|
2245
|
+
* @description Denotes the ICMP type rather than a port when the protocol is ICMP
|
|
1746
2246
|
*/
|
|
1747
2247
|
port_range_min: number | null;
|
|
1748
2248
|
protocol: string | null;
|
|
@@ -1759,22 +2259,25 @@ export interface components {
|
|
|
1759
2259
|
ethertype: "IPv4" | "IPv6";
|
|
1760
2260
|
/**
|
|
1761
2261
|
* Format: int64
|
|
1762
|
-
* @description ICMP
|
|
2262
|
+
* @description Denotes the ICMP code (0–255) rather than a port when the protocol is ICMP
|
|
1763
2263
|
*/
|
|
1764
2264
|
port_range_max?: number | null;
|
|
1765
2265
|
/**
|
|
1766
2266
|
* Format: int64
|
|
1767
|
-
* @description ICMP
|
|
2267
|
+
* @description Denotes the ICMP type (0–255) rather than a port when the protocol is ICMP
|
|
1768
2268
|
*/
|
|
1769
2269
|
port_range_min?: number | null;
|
|
1770
|
-
/** @description
|
|
2270
|
+
/** @description For example `tcp`, `udp`, `icmp` or `ipv6-icmp`. All protocols when omitted */
|
|
1771
2271
|
protocol?: string;
|
|
1772
|
-
/** @description
|
|
2272
|
+
/** @description Equivalent to `0.0.0.0/0` or `::/0` when omitted */
|
|
1773
2273
|
remote_ip_prefix?: string;
|
|
1774
2274
|
};
|
|
1775
2275
|
SnapshotResource: {
|
|
1776
|
-
/**
|
|
1777
|
-
|
|
2276
|
+
/**
|
|
2277
|
+
* Format: uuid
|
|
2278
|
+
* @description A disk restored from this snapshot must reside in this availability zone
|
|
2279
|
+
*/
|
|
2280
|
+
availability_zone_id: string;
|
|
1778
2281
|
/** Format: date-time */
|
|
1779
2282
|
created_at: string;
|
|
1780
2283
|
/** Format: uuid */
|
|
@@ -1782,14 +2285,28 @@ export interface components {
|
|
|
1782
2285
|
/** Format: uuid */
|
|
1783
2286
|
id: string;
|
|
1784
2287
|
name: string;
|
|
1785
|
-
|
|
2288
|
+
/** Format: uuid */
|
|
2289
|
+
region_id: string;
|
|
1786
2290
|
/**
|
|
1787
2291
|
* Format: int64
|
|
1788
|
-
* @description
|
|
2292
|
+
* @description Capacity of the source disk when the snapshot was created. A disk restored from it cannot be smaller
|
|
1789
2293
|
*/
|
|
1790
2294
|
size_gb: number;
|
|
1791
2295
|
/** @enum {string} */
|
|
1792
2296
|
status: "provisioning" | "available" | "restoring" | "deleting" | "error";
|
|
2297
|
+
/** Format: uuid */
|
|
2298
|
+
order_id: string | null;
|
|
2299
|
+
/** Format: uuid */
|
|
2300
|
+
price_id: string | null;
|
|
2301
|
+
/** Format: uuid */
|
|
2302
|
+
subscription_item_id: string | null;
|
|
2303
|
+
/** @enum {string|null} */
|
|
2304
|
+
access_state: "pending" | "enabled" | "suspended" | "reclaimed" | null;
|
|
2305
|
+
task: components["schemas"]["Task"] | null;
|
|
2306
|
+
/** Format: int64 */
|
|
2307
|
+
generation: number;
|
|
2308
|
+
/** Format: date-time */
|
|
2309
|
+
observed_at: string | null;
|
|
1793
2310
|
};
|
|
1794
2311
|
SnapshotListResponseBody: {
|
|
1795
2312
|
items: components["schemas"]["SnapshotResource"][] | null;
|
|
@@ -1798,6 +2315,8 @@ export interface components {
|
|
|
1798
2315
|
/** Format: uuid */
|
|
1799
2316
|
disk_id: string;
|
|
1800
2317
|
name: string;
|
|
2318
|
+
price: components["schemas"]["CatalogReference"];
|
|
2319
|
+
order: components["schemas"]["OrderOptions"];
|
|
1801
2320
|
};
|
|
1802
2321
|
RenameSecurityGroupRequestBody: {
|
|
1803
2322
|
name: string;
|
|
@@ -1805,6 +2324,209 @@ export interface components {
|
|
|
1805
2324
|
RenameSnapshotRequestBody: {
|
|
1806
2325
|
name: string;
|
|
1807
2326
|
};
|
|
2327
|
+
/** @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. */
|
|
2328
|
+
OrderOptions: {
|
|
2329
|
+
idempotency_key: string;
|
|
2330
|
+
payment_plan?: components["schemas"]["PaymentPlan"];
|
|
2331
|
+
expected_amount?: string;
|
|
2332
|
+
redemption_code?: string;
|
|
2333
|
+
};
|
|
2334
|
+
/** @description Specify exactly one of id or lookup_key. A lookup key is scoped to the product of the resource service. */
|
|
2335
|
+
CatalogReference: {
|
|
2336
|
+
/** Format: uuid */
|
|
2337
|
+
id?: string;
|
|
2338
|
+
lookup_key?: string;
|
|
2339
|
+
};
|
|
2340
|
+
/**
|
|
2341
|
+
* @description A billable order has been created. Read it from the billing API to find out what is
|
|
2342
|
+
* owed and whether payment is still required.
|
|
2343
|
+
*
|
|
2344
|
+
* Only the identifier is returned. Amounts and state are not repeated here; the order
|
|
2345
|
+
* itself is the single source for them.
|
|
2346
|
+
*/
|
|
2347
|
+
PlacedOrder: {
|
|
2348
|
+
/**
|
|
2349
|
+
* Format: uuid
|
|
2350
|
+
* @description Identifies the order. Use it to read the order and, where payment is required,
|
|
2351
|
+
* to pay it.
|
|
2352
|
+
*
|
|
2353
|
+
* An order is created even when nothing is owed, such as a plan with no charge or one
|
|
2354
|
+
* covered entirely by granted credit. Such an order is already settled, and no
|
|
2355
|
+
* payment step applies.
|
|
2356
|
+
*/
|
|
2357
|
+
order_id: string;
|
|
2358
|
+
};
|
|
2359
|
+
/** @description A system disk purchased in the same order. Required when booting from an image; mutually exclusive with boot_disk_id. */
|
|
2360
|
+
NewBootDisk: {
|
|
2361
|
+
/** Format: uuid */
|
|
2362
|
+
disk_type_id: string;
|
|
2363
|
+
/** Format: int64 */
|
|
2364
|
+
size_gb: number;
|
|
2365
|
+
price: components["schemas"]["CatalogReference"];
|
|
2366
|
+
/** @default true */
|
|
2367
|
+
delete_with_instance?: boolean;
|
|
2368
|
+
};
|
|
2369
|
+
/** @description An address and bandwidth purchased in the same order. Mutually exclusive with floating_ip_id. */
|
|
2370
|
+
NewFloatingIP: {
|
|
2371
|
+
price: components["schemas"]["CatalogReference"];
|
|
2372
|
+
bandwidth_price: components["schemas"]["CatalogReference"];
|
|
2373
|
+
/** Format: int64 */
|
|
2374
|
+
bandwidth_mbps: number;
|
|
2375
|
+
/** Format: uuid */
|
|
2376
|
+
ipv4_pool_id: string;
|
|
2377
|
+
};
|
|
2378
|
+
/** @description An independent restriction on use. Removing one restriction never removes another source’s restriction or changes the user’s desired power state. */
|
|
2379
|
+
InstanceRestriction: {
|
|
2380
|
+
/** Format: uuid */
|
|
2381
|
+
id: string;
|
|
2382
|
+
/** @enum {string} */
|
|
2383
|
+
source: "billing" | "iam" | "operator";
|
|
2384
|
+
source_id: string;
|
|
2385
|
+
reason_code: string;
|
|
2386
|
+
/** Format: date-time */
|
|
2387
|
+
created_at: string;
|
|
2388
|
+
};
|
|
2389
|
+
PowerRequest: {
|
|
2390
|
+
/** Format: int64 */
|
|
2391
|
+
expected_generation?: number;
|
|
2392
|
+
};
|
|
2393
|
+
/** @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. */
|
|
2394
|
+
Task: {
|
|
2395
|
+
/** Format: uuid */
|
|
2396
|
+
id: string;
|
|
2397
|
+
/** @description Action requested from the owning service. */
|
|
2398
|
+
type: string;
|
|
2399
|
+
/** @enum {string} */
|
|
2400
|
+
state: "pending" | "running" | "succeeded" | "failed" | "canceled";
|
|
2401
|
+
/** @description Terminal failure. Absent while work can still recover. */
|
|
2402
|
+
error?: components["schemas"]["Error"];
|
|
2403
|
+
/** Format: date-time */
|
|
2404
|
+
created_at: string;
|
|
2405
|
+
/** Format: date-time */
|
|
2406
|
+
started_at: string | null;
|
|
2407
|
+
/** Format: date-time */
|
|
2408
|
+
completed_at: string | null;
|
|
2409
|
+
};
|
|
2410
|
+
PortAddress: {
|
|
2411
|
+
/** Format: uuid */
|
|
2412
|
+
id: string;
|
|
2413
|
+
/** Format: uuid */
|
|
2414
|
+
subnet_id: string;
|
|
2415
|
+
address: string;
|
|
2416
|
+
is_primary: boolean;
|
|
2417
|
+
/** @enum {string} */
|
|
2418
|
+
state: "reserved" | "assigned" | "releasing" | "released" | "unknown";
|
|
2419
|
+
/** Format: date-time */
|
|
2420
|
+
assigned_at: string | null;
|
|
2421
|
+
/** Format: date-time */
|
|
2422
|
+
released_at: string | null;
|
|
2423
|
+
};
|
|
2424
|
+
DiskAttachment: {
|
|
2425
|
+
/** Format: uuid */
|
|
2426
|
+
id: string;
|
|
2427
|
+
/** Format: uuid */
|
|
2428
|
+
instance_id: string;
|
|
2429
|
+
/** Format: uuid */
|
|
2430
|
+
disk_id: string;
|
|
2431
|
+
/** @enum {string} */
|
|
2432
|
+
role: "boot" | "data";
|
|
2433
|
+
delete_with_instance: boolean;
|
|
2434
|
+
/** @enum {string} */
|
|
2435
|
+
state: "reserved" | "attaching" | "attached" | "detaching" | "released" | "unknown";
|
|
2436
|
+
/** Format: date-time */
|
|
2437
|
+
attached_at: string | null;
|
|
2438
|
+
/** Format: date-time */
|
|
2439
|
+
detached_at: string | null;
|
|
2440
|
+
/** Format: date-time */
|
|
2441
|
+
released_at: string | null;
|
|
2442
|
+
device: string | null;
|
|
2443
|
+
};
|
|
2444
|
+
DiskAttachmentList: {
|
|
2445
|
+
items: components["schemas"]["DiskAttachment"][];
|
|
2446
|
+
/** Format: int64 */
|
|
2447
|
+
page: number;
|
|
2448
|
+
/** Format: int64 */
|
|
2449
|
+
page_size: number;
|
|
2450
|
+
/** Format: int64 */
|
|
2451
|
+
total_count: number;
|
|
2452
|
+
};
|
|
2453
|
+
PortAttachment: {
|
|
2454
|
+
/** Format: uuid */
|
|
2455
|
+
id: string;
|
|
2456
|
+
/** Format: uuid */
|
|
2457
|
+
instance_id: string;
|
|
2458
|
+
/** Format: uuid */
|
|
2459
|
+
port_id: string;
|
|
2460
|
+
/** @enum {string} */
|
|
2461
|
+
role: "primary" | "additional";
|
|
2462
|
+
delete_with_instance: boolean;
|
|
2463
|
+
/** @enum {string} */
|
|
2464
|
+
state: "reserved" | "attaching" | "attached" | "detaching" | "released" | "unknown";
|
|
2465
|
+
/** Format: date-time */
|
|
2466
|
+
attached_at: string | null;
|
|
2467
|
+
/** Format: date-time */
|
|
2468
|
+
detached_at: string | null;
|
|
2469
|
+
/** Format: date-time */
|
|
2470
|
+
released_at: string | null;
|
|
2471
|
+
};
|
|
2472
|
+
PortAttachmentList: {
|
|
2473
|
+
items: components["schemas"]["PortAttachment"][];
|
|
2474
|
+
/** Format: int64 */
|
|
2475
|
+
page: number;
|
|
2476
|
+
/** Format: int64 */
|
|
2477
|
+
page_size: number;
|
|
2478
|
+
/** Format: int64 */
|
|
2479
|
+
total_count: number;
|
|
2480
|
+
};
|
|
2481
|
+
LaunchInstanceResponseBody: {
|
|
2482
|
+
order: components["schemas"]["PlacedOrder"];
|
|
2483
|
+
/** @description Generated login password. Null when no password was generated. Keep it before leaving this response. */
|
|
2484
|
+
password: string | null;
|
|
2485
|
+
};
|
|
2486
|
+
IPv4PoolResource: {
|
|
2487
|
+
/** Format: uuid */
|
|
2488
|
+
id: string;
|
|
2489
|
+
/** Format: uuid */
|
|
2490
|
+
region_id: string;
|
|
2491
|
+
name: string;
|
|
2492
|
+
lookup_key: string;
|
|
2493
|
+
/** Format: uuid */
|
|
2494
|
+
plan_id: string | null;
|
|
2495
|
+
/** Format: uuid */
|
|
2496
|
+
bandwidth_plan_id: string | null;
|
|
2497
|
+
};
|
|
2498
|
+
IPv4PoolListResponseBody: {
|
|
2499
|
+
items: components["schemas"]["IPv4PoolResource"][];
|
|
2500
|
+
/** Format: int64 */
|
|
2501
|
+
page: number;
|
|
2502
|
+
/** Format: int64 */
|
|
2503
|
+
page_size: number;
|
|
2504
|
+
/** Format: int64 */
|
|
2505
|
+
total_count?: number;
|
|
2506
|
+
};
|
|
2507
|
+
IPv4Binding: {
|
|
2508
|
+
/** Format: uuid */
|
|
2509
|
+
id: string;
|
|
2510
|
+
/** Format: uuid */
|
|
2511
|
+
ipv4_allocation_id: string;
|
|
2512
|
+
/** Format: uuid */
|
|
2513
|
+
port_address_id: string;
|
|
2514
|
+
address: string;
|
|
2515
|
+
fixed_ip: string;
|
|
2516
|
+
/** @enum {string} */
|
|
2517
|
+
state: "binding" | "bound" | "unbinding" | "released" | "unknown";
|
|
2518
|
+
/** Format: date-time */
|
|
2519
|
+
bound_at: string | null;
|
|
2520
|
+
/** Format: date-time */
|
|
2521
|
+
unbound_at: string | null;
|
|
2522
|
+
/** Format: date-time */
|
|
2523
|
+
released_at: string | null;
|
|
2524
|
+
};
|
|
2525
|
+
/** @description Requested funding split. This does not select a card or payment provider; complete payment through Billing. */
|
|
2526
|
+
PaymentPlan: {
|
|
2527
|
+
balance_amount: string;
|
|
2528
|
+
provider_amount: string;
|
|
2529
|
+
};
|
|
1808
2530
|
};
|
|
1809
2531
|
responses: never;
|
|
1810
2532
|
parameters: never;
|
|
@@ -1817,7 +2539,7 @@ export interface operations {
|
|
|
1817
2539
|
"list-backups": {
|
|
1818
2540
|
parameters: {
|
|
1819
2541
|
query?: {
|
|
1820
|
-
/** @description
|
|
2542
|
+
/** @description Return only the backups of this disk */
|
|
1821
2543
|
disk_id?: string;
|
|
1822
2544
|
};
|
|
1823
2545
|
header?: never;
|
|
@@ -1865,7 +2587,7 @@ export interface operations {
|
|
|
1865
2587
|
[name: string]: unknown;
|
|
1866
2588
|
};
|
|
1867
2589
|
content: {
|
|
1868
|
-
"application/json": components["schemas"]["
|
|
2590
|
+
"application/json": components["schemas"]["PlacedOrder"];
|
|
1869
2591
|
};
|
|
1870
2592
|
};
|
|
1871
2593
|
/** @description Error */
|
|
@@ -1913,7 +2635,10 @@ export interface operations {
|
|
|
1913
2635
|
"delete-backup": {
|
|
1914
2636
|
parameters: {
|
|
1915
2637
|
query?: never;
|
|
1916
|
-
header
|
|
2638
|
+
header: {
|
|
2639
|
+
/** @description Reuse the same key for retries of the same action. A different request with the same key is rejected. */
|
|
2640
|
+
"Idempotency-Key": string;
|
|
2641
|
+
};
|
|
1917
2642
|
path: {
|
|
1918
2643
|
backupId: string;
|
|
1919
2644
|
};
|
|
@@ -1921,12 +2646,14 @@ export interface operations {
|
|
|
1921
2646
|
};
|
|
1922
2647
|
requestBody?: never;
|
|
1923
2648
|
responses: {
|
|
1924
|
-
/** @description
|
|
1925
|
-
|
|
2649
|
+
/** @description The action was accepted. Wait for the returned task to finish. */
|
|
2650
|
+
202: {
|
|
1926
2651
|
headers: {
|
|
1927
2652
|
[name: string]: unknown;
|
|
1928
2653
|
};
|
|
1929
|
-
content
|
|
2654
|
+
content: {
|
|
2655
|
+
"application/json": components["schemas"]["Task"];
|
|
2656
|
+
};
|
|
1930
2657
|
};
|
|
1931
2658
|
/** @description Error */
|
|
1932
2659
|
default: {
|
|
@@ -1995,7 +2722,7 @@ export interface operations {
|
|
|
1995
2722
|
[name: string]: unknown;
|
|
1996
2723
|
};
|
|
1997
2724
|
content: {
|
|
1998
|
-
"application/json": components["schemas"]["
|
|
2725
|
+
"application/json": components["schemas"]["PlacedOrder"];
|
|
1999
2726
|
};
|
|
2000
2727
|
};
|
|
2001
2728
|
/** @description Error */
|
|
@@ -2012,7 +2739,7 @@ export interface operations {
|
|
|
2012
2739
|
"list-disk-types": {
|
|
2013
2740
|
parameters: {
|
|
2014
2741
|
query: {
|
|
2015
|
-
|
|
2742
|
+
region_id: string;
|
|
2016
2743
|
};
|
|
2017
2744
|
header?: never;
|
|
2018
2745
|
path?: never;
|
|
@@ -2040,10 +2767,43 @@ export interface operations {
|
|
|
2040
2767
|
};
|
|
2041
2768
|
};
|
|
2042
2769
|
};
|
|
2770
|
+
"get-disk-type": {
|
|
2771
|
+
parameters: {
|
|
2772
|
+
query?: never;
|
|
2773
|
+
header?: never;
|
|
2774
|
+
path: {
|
|
2775
|
+
diskTypeId: string;
|
|
2776
|
+
};
|
|
2777
|
+
cookie?: never;
|
|
2778
|
+
};
|
|
2779
|
+
requestBody?: never;
|
|
2780
|
+
responses: {
|
|
2781
|
+
/** @description OK */
|
|
2782
|
+
200: {
|
|
2783
|
+
headers: {
|
|
2784
|
+
[name: string]: unknown;
|
|
2785
|
+
};
|
|
2786
|
+
content: {
|
|
2787
|
+
"application/json": components["schemas"]["DiskTypeResource"];
|
|
2788
|
+
};
|
|
2789
|
+
};
|
|
2790
|
+
/** @description Error */
|
|
2791
|
+
default: {
|
|
2792
|
+
headers: {
|
|
2793
|
+
[name: string]: unknown;
|
|
2794
|
+
};
|
|
2795
|
+
content: {
|
|
2796
|
+
"application/json": components["schemas"]["Error"];
|
|
2797
|
+
};
|
|
2798
|
+
};
|
|
2799
|
+
};
|
|
2800
|
+
};
|
|
2043
2801
|
"list-images": {
|
|
2044
2802
|
parameters: {
|
|
2045
2803
|
query: {
|
|
2046
|
-
|
|
2804
|
+
region_id: string;
|
|
2805
|
+
page?: number;
|
|
2806
|
+
page_size?: number;
|
|
2047
2807
|
};
|
|
2048
2808
|
header?: never;
|
|
2049
2809
|
path?: never;
|
|
@@ -2074,7 +2834,9 @@ export interface operations {
|
|
|
2074
2834
|
"list-instance-types": {
|
|
2075
2835
|
parameters: {
|
|
2076
2836
|
query: {
|
|
2077
|
-
|
|
2837
|
+
region_id: string;
|
|
2838
|
+
page?: number;
|
|
2839
|
+
page_size?: number;
|
|
2078
2840
|
};
|
|
2079
2841
|
header?: never;
|
|
2080
2842
|
path?: never;
|
|
@@ -2136,7 +2898,7 @@ export interface operations {
|
|
|
2136
2898
|
query?: never;
|
|
2137
2899
|
header?: never;
|
|
2138
2900
|
path: {
|
|
2139
|
-
|
|
2901
|
+
regionId: string;
|
|
2140
2902
|
};
|
|
2141
2903
|
cookie?: never;
|
|
2142
2904
|
};
|
|
@@ -2165,9 +2927,9 @@ export interface operations {
|
|
|
2165
2927
|
"list-disks": {
|
|
2166
2928
|
parameters: {
|
|
2167
2929
|
query?: {
|
|
2168
|
-
|
|
2169
|
-
/** @description
|
|
2170
|
-
|
|
2930
|
+
region_id?: string;
|
|
2931
|
+
/** @description Supplied together with `region_code` to filter attachable disks */
|
|
2932
|
+
availability_zone_id?: string;
|
|
2171
2933
|
};
|
|
2172
2934
|
header?: never;
|
|
2173
2935
|
path?: never;
|
|
@@ -2214,7 +2976,34 @@ export interface operations {
|
|
|
2214
2976
|
[name: string]: unknown;
|
|
2215
2977
|
};
|
|
2216
2978
|
content: {
|
|
2217
|
-
"application/json": components["schemas"]["
|
|
2979
|
+
"application/json": components["schemas"]["PlacedOrder"];
|
|
2980
|
+
};
|
|
2981
|
+
};
|
|
2982
|
+
/**
|
|
2983
|
+
* @description Payment required: **nothing was created.**
|
|
2984
|
+
*
|
|
2985
|
+
* Returned when `payment_method` is `online`. `meta.checkout_url` is where to send the
|
|
2986
|
+
* customer; `meta.order_id` is the order waiting on it.
|
|
2987
|
+
*
|
|
2988
|
+
* ## Why this is a status and not a field on a 200
|
|
2989
|
+
*
|
|
2990
|
+
* A field on a success response is something a client can forget to read, and forgetting it
|
|
2991
|
+
* means treating "we created nothing and are waiting for money" as "created" — which looks
|
|
2992
|
+
* identical from the outside until the bill does not add up. A 402 fails loudly in any
|
|
2993
|
+
* client that handles errors at all.
|
|
2994
|
+
*
|
|
2995
|
+
* ## What happens after they pay
|
|
2996
|
+
*
|
|
2997
|
+
* The money lands in the balance and the order is settled from it. The resource is **not**
|
|
2998
|
+
* created automatically: placing it again is the customer's move, because between paying
|
|
2999
|
+
* and coming back they may have changed their mind. The balance is theirs either way.
|
|
3000
|
+
*/
|
|
3001
|
+
402: {
|
|
3002
|
+
headers: {
|
|
3003
|
+
[name: string]: unknown;
|
|
3004
|
+
};
|
|
3005
|
+
content: {
|
|
3006
|
+
"application/json": components["schemas"]["Error"];
|
|
2218
3007
|
};
|
|
2219
3008
|
};
|
|
2220
3009
|
/** @description Error */
|
|
@@ -2262,7 +3051,10 @@ export interface operations {
|
|
|
2262
3051
|
"delete-disk": {
|
|
2263
3052
|
parameters: {
|
|
2264
3053
|
query?: never;
|
|
2265
|
-
header
|
|
3054
|
+
header: {
|
|
3055
|
+
/** @description Reuse the same key for retries of the same action. A different request with the same key is rejected. */
|
|
3056
|
+
"Idempotency-Key": string;
|
|
3057
|
+
};
|
|
2266
3058
|
path: {
|
|
2267
3059
|
diskId: string;
|
|
2268
3060
|
};
|
|
@@ -2270,12 +3062,14 @@ export interface operations {
|
|
|
2270
3062
|
};
|
|
2271
3063
|
requestBody?: never;
|
|
2272
3064
|
responses: {
|
|
2273
|
-
/** @description
|
|
2274
|
-
|
|
3065
|
+
/** @description The action was accepted. Wait for the returned task to finish. */
|
|
3066
|
+
202: {
|
|
2275
3067
|
headers: {
|
|
2276
3068
|
[name: string]: unknown;
|
|
2277
3069
|
};
|
|
2278
|
-
content
|
|
3070
|
+
content: {
|
|
3071
|
+
"application/json": components["schemas"]["Task"];
|
|
3072
|
+
};
|
|
2279
3073
|
};
|
|
2280
3074
|
/** @description Error */
|
|
2281
3075
|
default: {
|
|
@@ -2344,7 +3138,7 @@ export interface operations {
|
|
|
2344
3138
|
[name: string]: unknown;
|
|
2345
3139
|
};
|
|
2346
3140
|
content: {
|
|
2347
|
-
"application/json": components["schemas"]["
|
|
3141
|
+
"application/json": components["schemas"]["PlacedOrder"];
|
|
2348
3142
|
};
|
|
2349
3143
|
};
|
|
2350
3144
|
/** @description Error */
|
|
@@ -2361,7 +3155,10 @@ export interface operations {
|
|
|
2361
3155
|
"revert-disk": {
|
|
2362
3156
|
parameters: {
|
|
2363
3157
|
query?: never;
|
|
2364
|
-
header
|
|
3158
|
+
header: {
|
|
3159
|
+
/** @description Reuse the same key for retries of the same action. A different request with the same key is rejected. */
|
|
3160
|
+
"Idempotency-Key": string;
|
|
3161
|
+
};
|
|
2365
3162
|
path: {
|
|
2366
3163
|
diskId: string;
|
|
2367
3164
|
};
|
|
@@ -2373,13 +3170,13 @@ export interface operations {
|
|
|
2373
3170
|
};
|
|
2374
3171
|
};
|
|
2375
3172
|
responses: {
|
|
2376
|
-
/** @description
|
|
2377
|
-
|
|
3173
|
+
/** @description The action was accepted. Wait for the returned task to finish. */
|
|
3174
|
+
202: {
|
|
2378
3175
|
headers: {
|
|
2379
3176
|
[name: string]: unknown;
|
|
2380
3177
|
};
|
|
2381
3178
|
content: {
|
|
2382
|
-
"application/json": components["schemas"]["
|
|
3179
|
+
"application/json": components["schemas"]["Task"];
|
|
2383
3180
|
};
|
|
2384
3181
|
};
|
|
2385
3182
|
/** @description Error */
|
|
@@ -2441,7 +3238,7 @@ export interface operations {
|
|
|
2441
3238
|
[name: string]: unknown;
|
|
2442
3239
|
};
|
|
2443
3240
|
content: {
|
|
2444
|
-
"application/json": components["schemas"]["
|
|
3241
|
+
"application/json": components["schemas"]["PlacedOrder"];
|
|
2445
3242
|
};
|
|
2446
3243
|
};
|
|
2447
3244
|
/** @description Error */
|
|
@@ -2489,7 +3286,10 @@ export interface operations {
|
|
|
2489
3286
|
"release-floating-ip": {
|
|
2490
3287
|
parameters: {
|
|
2491
3288
|
query?: never;
|
|
2492
|
-
header
|
|
3289
|
+
header: {
|
|
3290
|
+
/** @description Reuse the same key for retries of the same action. A different request with the same key is rejected. */
|
|
3291
|
+
"Idempotency-Key": string;
|
|
3292
|
+
};
|
|
2493
3293
|
path: {
|
|
2494
3294
|
floatingIpId: string;
|
|
2495
3295
|
};
|
|
@@ -2497,12 +3297,14 @@ export interface operations {
|
|
|
2497
3297
|
};
|
|
2498
3298
|
requestBody?: never;
|
|
2499
3299
|
responses: {
|
|
2500
|
-
/** @description
|
|
2501
|
-
|
|
3300
|
+
/** @description The release has been accepted. */
|
|
3301
|
+
202: {
|
|
2502
3302
|
headers: {
|
|
2503
3303
|
[name: string]: unknown;
|
|
2504
3304
|
};
|
|
2505
|
-
content
|
|
3305
|
+
content: {
|
|
3306
|
+
"application/json": components["schemas"]["Task"];
|
|
3307
|
+
};
|
|
2506
3308
|
};
|
|
2507
3309
|
/** @description Error */
|
|
2508
3310
|
default: {
|
|
@@ -2536,7 +3338,7 @@ export interface operations {
|
|
|
2536
3338
|
[name: string]: unknown;
|
|
2537
3339
|
};
|
|
2538
3340
|
content: {
|
|
2539
|
-
"application/json": components["schemas"]["
|
|
3341
|
+
"application/json": components["schemas"]["PlacedOrder"];
|
|
2540
3342
|
};
|
|
2541
3343
|
};
|
|
2542
3344
|
/** @description Error */
|
|
@@ -2571,7 +3373,136 @@ export interface operations {
|
|
|
2571
3373
|
[name: string]: unknown;
|
|
2572
3374
|
};
|
|
2573
3375
|
content: {
|
|
2574
|
-
"application/json": components["schemas"]["FloatingIPResource"];
|
|
3376
|
+
"application/json": components["schemas"]["FloatingIPResource"];
|
|
3377
|
+
};
|
|
3378
|
+
};
|
|
3379
|
+
/** @description Error */
|
|
3380
|
+
default: {
|
|
3381
|
+
headers: {
|
|
3382
|
+
[name: string]: unknown;
|
|
3383
|
+
};
|
|
3384
|
+
content: {
|
|
3385
|
+
"application/json": components["schemas"]["Error"];
|
|
3386
|
+
};
|
|
3387
|
+
};
|
|
3388
|
+
};
|
|
3389
|
+
};
|
|
3390
|
+
"unbind-floating-ip": {
|
|
3391
|
+
parameters: {
|
|
3392
|
+
query?: never;
|
|
3393
|
+
header?: never;
|
|
3394
|
+
path: {
|
|
3395
|
+
floatingIpId: string;
|
|
3396
|
+
};
|
|
3397
|
+
cookie?: never;
|
|
3398
|
+
};
|
|
3399
|
+
requestBody?: never;
|
|
3400
|
+
responses: {
|
|
3401
|
+
/** @description OK */
|
|
3402
|
+
200: {
|
|
3403
|
+
headers: {
|
|
3404
|
+
[name: string]: unknown;
|
|
3405
|
+
};
|
|
3406
|
+
content: {
|
|
3407
|
+
"application/json": components["schemas"]["FloatingIPResource"];
|
|
3408
|
+
};
|
|
3409
|
+
};
|
|
3410
|
+
/** @description Error */
|
|
3411
|
+
default: {
|
|
3412
|
+
headers: {
|
|
3413
|
+
[name: string]: unknown;
|
|
3414
|
+
};
|
|
3415
|
+
content: {
|
|
3416
|
+
"application/json": components["schemas"]["Error"];
|
|
3417
|
+
};
|
|
3418
|
+
};
|
|
3419
|
+
};
|
|
3420
|
+
};
|
|
3421
|
+
"list-instances": {
|
|
3422
|
+
parameters: {
|
|
3423
|
+
query?: {
|
|
3424
|
+
/** @description Only instances carrying this label, written as `key:value` — for example `env:prod`. Both halves are matched exactly */
|
|
3425
|
+
label?: string;
|
|
3426
|
+
page?: number;
|
|
3427
|
+
page_size?: number;
|
|
3428
|
+
};
|
|
3429
|
+
header?: never;
|
|
3430
|
+
path?: never;
|
|
3431
|
+
cookie?: never;
|
|
3432
|
+
};
|
|
3433
|
+
requestBody?: never;
|
|
3434
|
+
responses: {
|
|
3435
|
+
/** @description OK */
|
|
3436
|
+
200: {
|
|
3437
|
+
headers: {
|
|
3438
|
+
[name: string]: unknown;
|
|
3439
|
+
};
|
|
3440
|
+
content: {
|
|
3441
|
+
"application/json": components["schemas"]["InstanceListResponseBody"];
|
|
3442
|
+
};
|
|
3443
|
+
};
|
|
3444
|
+
/** @description Error */
|
|
3445
|
+
default: {
|
|
3446
|
+
headers: {
|
|
3447
|
+
[name: string]: unknown;
|
|
3448
|
+
};
|
|
3449
|
+
content: {
|
|
3450
|
+
"application/json": components["schemas"]["Error"];
|
|
3451
|
+
};
|
|
3452
|
+
};
|
|
3453
|
+
};
|
|
3454
|
+
};
|
|
3455
|
+
"launch-instance": {
|
|
3456
|
+
parameters: {
|
|
3457
|
+
query?: never;
|
|
3458
|
+
header?: never;
|
|
3459
|
+
path?: never;
|
|
3460
|
+
cookie?: never;
|
|
3461
|
+
};
|
|
3462
|
+
requestBody: {
|
|
3463
|
+
content: {
|
|
3464
|
+
"application/json": components["schemas"]["LaunchInstanceRequestBody"];
|
|
3465
|
+
};
|
|
3466
|
+
};
|
|
3467
|
+
responses: {
|
|
3468
|
+
/** @description Accepted */
|
|
3469
|
+
202: {
|
|
3470
|
+
headers: {
|
|
3471
|
+
[name: string]: unknown;
|
|
3472
|
+
};
|
|
3473
|
+
content: {
|
|
3474
|
+
"application/json": components["schemas"]["LaunchInstanceResponseBody"];
|
|
3475
|
+
};
|
|
3476
|
+
};
|
|
3477
|
+
/** @description Error */
|
|
3478
|
+
default: {
|
|
3479
|
+
headers: {
|
|
3480
|
+
[name: string]: unknown;
|
|
3481
|
+
};
|
|
3482
|
+
content: {
|
|
3483
|
+
"application/json": components["schemas"]["Error"];
|
|
3484
|
+
};
|
|
3485
|
+
};
|
|
3486
|
+
};
|
|
3487
|
+
};
|
|
3488
|
+
"get-instance": {
|
|
3489
|
+
parameters: {
|
|
3490
|
+
query?: never;
|
|
3491
|
+
header?: never;
|
|
3492
|
+
path: {
|
|
3493
|
+
instanceId: string;
|
|
3494
|
+
};
|
|
3495
|
+
cookie?: never;
|
|
3496
|
+
};
|
|
3497
|
+
requestBody?: never;
|
|
3498
|
+
responses: {
|
|
3499
|
+
/** @description OK */
|
|
3500
|
+
200: {
|
|
3501
|
+
headers: {
|
|
3502
|
+
[name: string]: unknown;
|
|
3503
|
+
};
|
|
3504
|
+
content: {
|
|
3505
|
+
"application/json": components["schemas"]["InstanceResource"];
|
|
2575
3506
|
};
|
|
2576
3507
|
};
|
|
2577
3508
|
/** @description Error */
|
|
@@ -2585,24 +3516,27 @@ export interface operations {
|
|
|
2585
3516
|
};
|
|
2586
3517
|
};
|
|
2587
3518
|
};
|
|
2588
|
-
"
|
|
3519
|
+
"delete-instance": {
|
|
2589
3520
|
parameters: {
|
|
2590
3521
|
query?: never;
|
|
2591
|
-
header
|
|
3522
|
+
header: {
|
|
3523
|
+
/** @description Reuse the same key for retries of the same action. A different request with the same key is rejected. */
|
|
3524
|
+
"Idempotency-Key": string;
|
|
3525
|
+
};
|
|
2592
3526
|
path: {
|
|
2593
|
-
|
|
3527
|
+
instanceId: string;
|
|
2594
3528
|
};
|
|
2595
3529
|
cookie?: never;
|
|
2596
3530
|
};
|
|
2597
3531
|
requestBody?: never;
|
|
2598
3532
|
responses: {
|
|
2599
|
-
/** @description
|
|
2600
|
-
|
|
3533
|
+
/** @description The action was accepted. Wait for the returned task to finish. */
|
|
3534
|
+
202: {
|
|
2601
3535
|
headers: {
|
|
2602
3536
|
[name: string]: unknown;
|
|
2603
3537
|
};
|
|
2604
3538
|
content: {
|
|
2605
|
-
"application/json": components["schemas"]["
|
|
3539
|
+
"application/json": components["schemas"]["Task"];
|
|
2606
3540
|
};
|
|
2607
3541
|
};
|
|
2608
3542
|
/** @description Error */
|
|
@@ -2616,14 +3550,20 @@ export interface operations {
|
|
|
2616
3550
|
};
|
|
2617
3551
|
};
|
|
2618
3552
|
};
|
|
2619
|
-
"
|
|
3553
|
+
"rename-instance": {
|
|
2620
3554
|
parameters: {
|
|
2621
3555
|
query?: never;
|
|
2622
3556
|
header?: never;
|
|
2623
|
-
path
|
|
3557
|
+
path: {
|
|
3558
|
+
instanceId: string;
|
|
3559
|
+
};
|
|
2624
3560
|
cookie?: never;
|
|
2625
3561
|
};
|
|
2626
|
-
requestBody
|
|
3562
|
+
requestBody: {
|
|
3563
|
+
content: {
|
|
3564
|
+
"application/json": components["schemas"]["RenameInstanceRequestBody"];
|
|
3565
|
+
};
|
|
3566
|
+
};
|
|
2627
3567
|
responses: {
|
|
2628
3568
|
/** @description OK */
|
|
2629
3569
|
200: {
|
|
@@ -2631,7 +3571,7 @@ export interface operations {
|
|
|
2631
3571
|
[name: string]: unknown;
|
|
2632
3572
|
};
|
|
2633
3573
|
content: {
|
|
2634
|
-
"application/json": components["schemas"]["
|
|
3574
|
+
"application/json": components["schemas"]["InstanceResource"];
|
|
2635
3575
|
};
|
|
2636
3576
|
};
|
|
2637
3577
|
/** @description Error */
|
|
@@ -2645,26 +3585,28 @@ export interface operations {
|
|
|
2645
3585
|
};
|
|
2646
3586
|
};
|
|
2647
3587
|
};
|
|
2648
|
-
"
|
|
3588
|
+
"run-instance-command": {
|
|
2649
3589
|
parameters: {
|
|
2650
3590
|
query?: never;
|
|
2651
3591
|
header?: never;
|
|
2652
|
-
path
|
|
3592
|
+
path: {
|
|
3593
|
+
instanceId: string;
|
|
3594
|
+
};
|
|
2653
3595
|
cookie?: never;
|
|
2654
3596
|
};
|
|
2655
3597
|
requestBody: {
|
|
2656
3598
|
content: {
|
|
2657
|
-
"application/json": components["schemas"]["
|
|
3599
|
+
"application/json": components["schemas"]["RunCommandRequestBody"];
|
|
2658
3600
|
};
|
|
2659
3601
|
};
|
|
2660
3602
|
responses: {
|
|
2661
|
-
/** @description
|
|
2662
|
-
|
|
3603
|
+
/** @description OK */
|
|
3604
|
+
200: {
|
|
2663
3605
|
headers: {
|
|
2664
3606
|
[name: string]: unknown;
|
|
2665
3607
|
};
|
|
2666
3608
|
content: {
|
|
2667
|
-
"application/json": components["schemas"]["
|
|
3609
|
+
"application/json": components["schemas"]["CommandResultResponseBody"];
|
|
2668
3610
|
};
|
|
2669
3611
|
};
|
|
2670
3612
|
/** @description Error */
|
|
@@ -2678,7 +3620,7 @@ export interface operations {
|
|
|
2678
3620
|
};
|
|
2679
3621
|
};
|
|
2680
3622
|
};
|
|
2681
|
-
"
|
|
3623
|
+
"open-instance-console": {
|
|
2682
3624
|
parameters: {
|
|
2683
3625
|
query?: never;
|
|
2684
3626
|
header?: never;
|
|
@@ -2695,7 +3637,7 @@ export interface operations {
|
|
|
2695
3637
|
[name: string]: unknown;
|
|
2696
3638
|
};
|
|
2697
3639
|
content: {
|
|
2698
|
-
"application/json": components["schemas"]["
|
|
3640
|
+
"application/json": components["schemas"]["ConsoleResponseBody"];
|
|
2699
3641
|
};
|
|
2700
3642
|
};
|
|
2701
3643
|
/** @description Error */
|
|
@@ -2709,9 +3651,12 @@ export interface operations {
|
|
|
2709
3651
|
};
|
|
2710
3652
|
};
|
|
2711
3653
|
};
|
|
2712
|
-
"
|
|
3654
|
+
"get-instance-console-output": {
|
|
2713
3655
|
parameters: {
|
|
2714
|
-
query?:
|
|
3656
|
+
query?: {
|
|
3657
|
+
/** @description Number of trailing lines to return; 0 returns the entire output */
|
|
3658
|
+
lines?: number;
|
|
3659
|
+
};
|
|
2715
3660
|
header?: never;
|
|
2716
3661
|
path: {
|
|
2717
3662
|
instanceId: string;
|
|
@@ -2720,12 +3665,14 @@ export interface operations {
|
|
|
2720
3665
|
};
|
|
2721
3666
|
requestBody?: never;
|
|
2722
3667
|
responses: {
|
|
2723
|
-
/** @description
|
|
2724
|
-
|
|
3668
|
+
/** @description OK */
|
|
3669
|
+
200: {
|
|
2725
3670
|
headers: {
|
|
2726
3671
|
[name: string]: unknown;
|
|
2727
3672
|
};
|
|
2728
|
-
content
|
|
3673
|
+
content: {
|
|
3674
|
+
"application/json": components["schemas"]["ConsoleOutputResponseBody"];
|
|
3675
|
+
};
|
|
2729
3676
|
};
|
|
2730
3677
|
/** @description Error */
|
|
2731
3678
|
default: {
|
|
@@ -2738,7 +3685,7 @@ export interface operations {
|
|
|
2738
3685
|
};
|
|
2739
3686
|
};
|
|
2740
3687
|
};
|
|
2741
|
-
"
|
|
3688
|
+
"set-instance-labels": {
|
|
2742
3689
|
parameters: {
|
|
2743
3690
|
query?: never;
|
|
2744
3691
|
header?: never;
|
|
@@ -2749,7 +3696,7 @@ export interface operations {
|
|
|
2749
3696
|
};
|
|
2750
3697
|
requestBody: {
|
|
2751
3698
|
content: {
|
|
2752
|
-
"application/json": components["schemas"]["
|
|
3699
|
+
"application/json": components["schemas"]["SetInstanceLabelsRequestBody"];
|
|
2753
3700
|
};
|
|
2754
3701
|
};
|
|
2755
3702
|
responses: {
|
|
@@ -2773,7 +3720,7 @@ export interface operations {
|
|
|
2773
3720
|
};
|
|
2774
3721
|
};
|
|
2775
3722
|
};
|
|
2776
|
-
"
|
|
3723
|
+
"set-instance-notes": {
|
|
2777
3724
|
parameters: {
|
|
2778
3725
|
query?: never;
|
|
2779
3726
|
header?: never;
|
|
@@ -2784,7 +3731,7 @@ export interface operations {
|
|
|
2784
3731
|
};
|
|
2785
3732
|
requestBody: {
|
|
2786
3733
|
content: {
|
|
2787
|
-
"application/json": components["schemas"]["
|
|
3734
|
+
"application/json": components["schemas"]["SetInstanceNotesRequestBody"];
|
|
2788
3735
|
};
|
|
2789
3736
|
};
|
|
2790
3737
|
responses: {
|
|
@@ -2808,7 +3755,7 @@ export interface operations {
|
|
|
2808
3755
|
};
|
|
2809
3756
|
};
|
|
2810
3757
|
};
|
|
2811
|
-
"
|
|
3758
|
+
"reset-instance-password": {
|
|
2812
3759
|
parameters: {
|
|
2813
3760
|
query?: never;
|
|
2814
3761
|
header?: never;
|
|
@@ -2817,7 +3764,11 @@ export interface operations {
|
|
|
2817
3764
|
};
|
|
2818
3765
|
cookie?: never;
|
|
2819
3766
|
};
|
|
2820
|
-
requestBody
|
|
3767
|
+
requestBody: {
|
|
3768
|
+
content: {
|
|
3769
|
+
"application/json": components["schemas"]["ResetPasswordRequestBody"];
|
|
3770
|
+
};
|
|
3771
|
+
};
|
|
2821
3772
|
responses: {
|
|
2822
3773
|
/** @description OK */
|
|
2823
3774
|
200: {
|
|
@@ -2825,7 +3776,7 @@ export interface operations {
|
|
|
2825
3776
|
[name: string]: unknown;
|
|
2826
3777
|
};
|
|
2827
3778
|
content: {
|
|
2828
|
-
"application/json": components["schemas"]["
|
|
3779
|
+
"application/json": components["schemas"]["ResetPasswordResponseBody"];
|
|
2829
3780
|
};
|
|
2830
3781
|
};
|
|
2831
3782
|
/** @description Error */
|
|
@@ -2839,27 +3790,31 @@ export interface operations {
|
|
|
2839
3790
|
};
|
|
2840
3791
|
};
|
|
2841
3792
|
};
|
|
2842
|
-
"
|
|
3793
|
+
"reboot-instance": {
|
|
2843
3794
|
parameters: {
|
|
2844
|
-
query?:
|
|
2845
|
-
|
|
2846
|
-
|
|
3795
|
+
query?: never;
|
|
3796
|
+
header: {
|
|
3797
|
+
/** @description Reuse the same key for retries of the same action. A different request with the same key is rejected. */
|
|
3798
|
+
"Idempotency-Key": string;
|
|
2847
3799
|
};
|
|
2848
|
-
header?: never;
|
|
2849
3800
|
path: {
|
|
2850
3801
|
instanceId: string;
|
|
2851
3802
|
};
|
|
2852
3803
|
cookie?: never;
|
|
2853
3804
|
};
|
|
2854
|
-
requestBody
|
|
3805
|
+
requestBody: {
|
|
3806
|
+
content: {
|
|
3807
|
+
"application/json": components["schemas"]["RebootInstanceRequestBody"];
|
|
3808
|
+
};
|
|
3809
|
+
};
|
|
2855
3810
|
responses: {
|
|
2856
|
-
/** @description
|
|
2857
|
-
|
|
3811
|
+
/** @description The action was accepted. Wait for the returned task to finish. */
|
|
3812
|
+
202: {
|
|
2858
3813
|
headers: {
|
|
2859
3814
|
[name: string]: unknown;
|
|
2860
3815
|
};
|
|
2861
3816
|
content: {
|
|
2862
|
-
"application/json": components["schemas"]["
|
|
3817
|
+
"application/json": components["schemas"]["Task"];
|
|
2863
3818
|
};
|
|
2864
3819
|
};
|
|
2865
3820
|
/** @description Error */
|
|
@@ -2873,7 +3828,7 @@ export interface operations {
|
|
|
2873
3828
|
};
|
|
2874
3829
|
};
|
|
2875
3830
|
};
|
|
2876
|
-
"
|
|
3831
|
+
"rebuild-instance": {
|
|
2877
3832
|
parameters: {
|
|
2878
3833
|
query?: never;
|
|
2879
3834
|
header?: never;
|
|
@@ -2884,7 +3839,7 @@ export interface operations {
|
|
|
2884
3839
|
};
|
|
2885
3840
|
requestBody: {
|
|
2886
3841
|
content: {
|
|
2887
|
-
"application/json": components["schemas"]["
|
|
3842
|
+
"application/json": components["schemas"]["RebuildInstanceRequestBody"];
|
|
2888
3843
|
};
|
|
2889
3844
|
};
|
|
2890
3845
|
responses: {
|
|
@@ -2894,7 +3849,7 @@ export interface operations {
|
|
|
2894
3849
|
[name: string]: unknown;
|
|
2895
3850
|
};
|
|
2896
3851
|
content: {
|
|
2897
|
-
"application/json": components["schemas"]["
|
|
3852
|
+
"application/json": components["schemas"]["RebuildInstanceResponseBody"];
|
|
2898
3853
|
};
|
|
2899
3854
|
};
|
|
2900
3855
|
/** @description Error */
|
|
@@ -2908,7 +3863,7 @@ export interface operations {
|
|
|
2908
3863
|
};
|
|
2909
3864
|
};
|
|
2910
3865
|
};
|
|
2911
|
-
"
|
|
3866
|
+
"resize-instance": {
|
|
2912
3867
|
parameters: {
|
|
2913
3868
|
query?: never;
|
|
2914
3869
|
header?: never;
|
|
@@ -2919,17 +3874,17 @@ export interface operations {
|
|
|
2919
3874
|
};
|
|
2920
3875
|
requestBody: {
|
|
2921
3876
|
content: {
|
|
2922
|
-
"application/json": components["schemas"]["
|
|
3877
|
+
"application/json": components["schemas"]["ResizeInstanceRequestBody"];
|
|
2923
3878
|
};
|
|
2924
3879
|
};
|
|
2925
3880
|
responses: {
|
|
2926
|
-
/** @description
|
|
2927
|
-
|
|
3881
|
+
/** @description Accepted */
|
|
3882
|
+
202: {
|
|
2928
3883
|
headers: {
|
|
2929
3884
|
[name: string]: unknown;
|
|
2930
3885
|
};
|
|
2931
3886
|
content: {
|
|
2932
|
-
"application/json": components["schemas"]["
|
|
3887
|
+
"application/json": components["schemas"]["PlacedOrder"];
|
|
2933
3888
|
};
|
|
2934
3889
|
};
|
|
2935
3890
|
/** @description Error */
|
|
@@ -2943,28 +3898,61 @@ export interface operations {
|
|
|
2943
3898
|
};
|
|
2944
3899
|
};
|
|
2945
3900
|
};
|
|
2946
|
-
"
|
|
3901
|
+
"confirm-instance-resize": {
|
|
2947
3902
|
parameters: {
|
|
2948
3903
|
query?: never;
|
|
2949
|
-
header
|
|
3904
|
+
header: {
|
|
3905
|
+
/** @description Reuse the same key for retries of the same action. A different request with the same key is rejected. */
|
|
3906
|
+
"Idempotency-Key": string;
|
|
3907
|
+
};
|
|
2950
3908
|
path: {
|
|
2951
3909
|
instanceId: string;
|
|
2952
3910
|
};
|
|
2953
3911
|
cookie?: never;
|
|
2954
3912
|
};
|
|
2955
|
-
requestBody
|
|
2956
|
-
|
|
2957
|
-
|
|
3913
|
+
requestBody?: never;
|
|
3914
|
+
responses: {
|
|
3915
|
+
/** @description The action was accepted. Wait for the returned task to finish. */
|
|
3916
|
+
202: {
|
|
3917
|
+
headers: {
|
|
3918
|
+
[name: string]: unknown;
|
|
3919
|
+
};
|
|
3920
|
+
content: {
|
|
3921
|
+
"application/json": components["schemas"]["Task"];
|
|
3922
|
+
};
|
|
3923
|
+
};
|
|
3924
|
+
/** @description Error */
|
|
3925
|
+
default: {
|
|
3926
|
+
headers: {
|
|
3927
|
+
[name: string]: unknown;
|
|
3928
|
+
};
|
|
3929
|
+
content: {
|
|
3930
|
+
"application/json": components["schemas"]["Error"];
|
|
3931
|
+
};
|
|
3932
|
+
};
|
|
3933
|
+
};
|
|
3934
|
+
};
|
|
3935
|
+
"revert-instance-resize": {
|
|
3936
|
+
parameters: {
|
|
3937
|
+
query?: never;
|
|
3938
|
+
header: {
|
|
3939
|
+
/** @description Reuse the same key for retries of the same action. A different request with the same key is rejected. */
|
|
3940
|
+
"Idempotency-Key": string;
|
|
3941
|
+
};
|
|
3942
|
+
path: {
|
|
3943
|
+
instanceId: string;
|
|
2958
3944
|
};
|
|
3945
|
+
cookie?: never;
|
|
2959
3946
|
};
|
|
3947
|
+
requestBody?: never;
|
|
2960
3948
|
responses: {
|
|
2961
|
-
/** @description
|
|
2962
|
-
|
|
3949
|
+
/** @description The action was accepted. Wait for the returned task to finish. */
|
|
3950
|
+
202: {
|
|
2963
3951
|
headers: {
|
|
2964
3952
|
[name: string]: unknown;
|
|
2965
3953
|
};
|
|
2966
3954
|
content: {
|
|
2967
|
-
"application/json": components["schemas"]["
|
|
3955
|
+
"application/json": components["schemas"]["Task"];
|
|
2968
3956
|
};
|
|
2969
3957
|
};
|
|
2970
3958
|
/** @description Error */
|
|
@@ -2978,24 +3966,31 @@ export interface operations {
|
|
|
2978
3966
|
};
|
|
2979
3967
|
};
|
|
2980
3968
|
};
|
|
2981
|
-
"
|
|
3969
|
+
"start-instance": {
|
|
2982
3970
|
parameters: {
|
|
2983
3971
|
query?: never;
|
|
2984
|
-
header
|
|
3972
|
+
header: {
|
|
3973
|
+
/** @description Reuse the same key for retries of the same action. A different request with the same key is rejected. */
|
|
3974
|
+
"Idempotency-Key": string;
|
|
3975
|
+
};
|
|
2985
3976
|
path: {
|
|
2986
3977
|
instanceId: string;
|
|
2987
3978
|
};
|
|
2988
3979
|
cookie?: never;
|
|
2989
3980
|
};
|
|
2990
|
-
requestBody
|
|
3981
|
+
requestBody: {
|
|
3982
|
+
content: {
|
|
3983
|
+
"application/json": components["schemas"]["PowerRequest"];
|
|
3984
|
+
};
|
|
3985
|
+
};
|
|
2991
3986
|
responses: {
|
|
2992
|
-
/** @description
|
|
2993
|
-
|
|
3987
|
+
/** @description The action was accepted. Wait for the returned task to finish. */
|
|
3988
|
+
202: {
|
|
2994
3989
|
headers: {
|
|
2995
3990
|
[name: string]: unknown;
|
|
2996
3991
|
};
|
|
2997
3992
|
content: {
|
|
2998
|
-
"application/json": components["schemas"]["
|
|
3993
|
+
"application/json": components["schemas"]["Task"];
|
|
2999
3994
|
};
|
|
3000
3995
|
};
|
|
3001
3996
|
/** @description Error */
|
|
@@ -3009,24 +4004,31 @@ export interface operations {
|
|
|
3009
4004
|
};
|
|
3010
4005
|
};
|
|
3011
4006
|
};
|
|
3012
|
-
"
|
|
4007
|
+
"stop-instance": {
|
|
3013
4008
|
parameters: {
|
|
3014
4009
|
query?: never;
|
|
3015
|
-
header
|
|
4010
|
+
header: {
|
|
4011
|
+
/** @description Reuse the same key for retries of the same action. A different request with the same key is rejected. */
|
|
4012
|
+
"Idempotency-Key": string;
|
|
4013
|
+
};
|
|
3016
4014
|
path: {
|
|
3017
4015
|
instanceId: string;
|
|
3018
4016
|
};
|
|
3019
4017
|
cookie?: never;
|
|
3020
4018
|
};
|
|
3021
|
-
requestBody
|
|
4019
|
+
requestBody: {
|
|
4020
|
+
content: {
|
|
4021
|
+
"application/json": components["schemas"]["PowerRequest"];
|
|
4022
|
+
};
|
|
4023
|
+
};
|
|
3022
4024
|
responses: {
|
|
3023
|
-
/** @description
|
|
3024
|
-
|
|
4025
|
+
/** @description The action was accepted. Wait for the returned task to finish. */
|
|
4026
|
+
202: {
|
|
3025
4027
|
headers: {
|
|
3026
4028
|
[name: string]: unknown;
|
|
3027
4029
|
};
|
|
3028
4030
|
content: {
|
|
3029
|
-
"application/json": components["schemas"]["
|
|
4031
|
+
"application/json": components["schemas"]["Task"];
|
|
3030
4032
|
};
|
|
3031
4033
|
};
|
|
3032
4034
|
/** @description Error */
|
|
@@ -3042,7 +4044,10 @@ export interface operations {
|
|
|
3042
4044
|
};
|
|
3043
4045
|
"list-instance-disks": {
|
|
3044
4046
|
parameters: {
|
|
3045
|
-
query?:
|
|
4047
|
+
query?: {
|
|
4048
|
+
page?: number;
|
|
4049
|
+
page_size?: number;
|
|
4050
|
+
};
|
|
3046
4051
|
header?: never;
|
|
3047
4052
|
path: {
|
|
3048
4053
|
instanceId: string;
|
|
@@ -3057,7 +4062,7 @@ export interface operations {
|
|
|
3057
4062
|
[name: string]: unknown;
|
|
3058
4063
|
};
|
|
3059
4064
|
content: {
|
|
3060
|
-
"application/json": components["schemas"]["
|
|
4065
|
+
"application/json": components["schemas"]["DiskAttachmentList"];
|
|
3061
4066
|
};
|
|
3062
4067
|
};
|
|
3063
4068
|
/** @description Error */
|
|
@@ -3074,7 +4079,10 @@ export interface operations {
|
|
|
3074
4079
|
"attach-disk": {
|
|
3075
4080
|
parameters: {
|
|
3076
4081
|
query?: never;
|
|
3077
|
-
header
|
|
4082
|
+
header: {
|
|
4083
|
+
/** @description Reuse the same key for retries of the same action. A different request with the same key is rejected. */
|
|
4084
|
+
"Idempotency-Key": string;
|
|
4085
|
+
};
|
|
3078
4086
|
path: {
|
|
3079
4087
|
instanceId: string;
|
|
3080
4088
|
};
|
|
@@ -3086,13 +4094,13 @@ export interface operations {
|
|
|
3086
4094
|
};
|
|
3087
4095
|
};
|
|
3088
4096
|
responses: {
|
|
3089
|
-
/** @description
|
|
3090
|
-
|
|
4097
|
+
/** @description The action was accepted. Wait for the returned task to finish. */
|
|
4098
|
+
202: {
|
|
3091
4099
|
headers: {
|
|
3092
4100
|
[name: string]: unknown;
|
|
3093
4101
|
};
|
|
3094
4102
|
content: {
|
|
3095
|
-
"application/json": components["schemas"]["
|
|
4103
|
+
"application/json": components["schemas"]["Task"];
|
|
3096
4104
|
};
|
|
3097
4105
|
};
|
|
3098
4106
|
/** @description Error */
|
|
@@ -3109,7 +4117,10 @@ export interface operations {
|
|
|
3109
4117
|
"detach-disk": {
|
|
3110
4118
|
parameters: {
|
|
3111
4119
|
query?: never;
|
|
3112
|
-
header
|
|
4120
|
+
header: {
|
|
4121
|
+
/** @description Reuse the same key for retries of the same action. A different request with the same key is rejected. */
|
|
4122
|
+
"Idempotency-Key": string;
|
|
4123
|
+
};
|
|
3113
4124
|
path: {
|
|
3114
4125
|
instanceId: string;
|
|
3115
4126
|
diskId: string;
|
|
@@ -3118,13 +4129,13 @@ export interface operations {
|
|
|
3118
4129
|
};
|
|
3119
4130
|
requestBody?: never;
|
|
3120
4131
|
responses: {
|
|
3121
|
-
/** @description
|
|
3122
|
-
|
|
4132
|
+
/** @description The action was accepted. Wait for the returned task to finish. */
|
|
4133
|
+
202: {
|
|
3123
4134
|
headers: {
|
|
3124
4135
|
[name: string]: unknown;
|
|
3125
4136
|
};
|
|
3126
4137
|
content: {
|
|
3127
|
-
"application/json": components["schemas"]["
|
|
4138
|
+
"application/json": components["schemas"]["Task"];
|
|
3128
4139
|
};
|
|
3129
4140
|
};
|
|
3130
4141
|
/** @description Error */
|
|
@@ -3153,7 +4164,7 @@ export interface operations {
|
|
|
3153
4164
|
};
|
|
3154
4165
|
};
|
|
3155
4166
|
responses: {
|
|
3156
|
-
/** @description
|
|
4167
|
+
/** @description The current floating IP binding */
|
|
3157
4168
|
200: {
|
|
3158
4169
|
headers: {
|
|
3159
4170
|
[name: string]: unknown;
|
|
@@ -3185,7 +4196,7 @@ export interface operations {
|
|
|
3185
4196
|
};
|
|
3186
4197
|
requestBody?: never;
|
|
3187
4198
|
responses: {
|
|
3188
|
-
/** @description
|
|
4199
|
+
/** @description The current floating IP binding */
|
|
3189
4200
|
200: {
|
|
3190
4201
|
headers: {
|
|
3191
4202
|
[name: string]: unknown;
|
|
@@ -3207,7 +4218,10 @@ export interface operations {
|
|
|
3207
4218
|
};
|
|
3208
4219
|
"list-instance-ports": {
|
|
3209
4220
|
parameters: {
|
|
3210
|
-
query?:
|
|
4221
|
+
query?: {
|
|
4222
|
+
page?: number;
|
|
4223
|
+
page_size?: number;
|
|
4224
|
+
};
|
|
3211
4225
|
header?: never;
|
|
3212
4226
|
path: {
|
|
3213
4227
|
instanceId: string;
|
|
@@ -3222,7 +4236,7 @@ export interface operations {
|
|
|
3222
4236
|
[name: string]: unknown;
|
|
3223
4237
|
};
|
|
3224
4238
|
content: {
|
|
3225
|
-
"application/json": components["schemas"]["
|
|
4239
|
+
"application/json": components["schemas"]["PortAttachmentList"];
|
|
3226
4240
|
};
|
|
3227
4241
|
};
|
|
3228
4242
|
/** @description Error */
|
|
@@ -3239,7 +4253,10 @@ export interface operations {
|
|
|
3239
4253
|
"attach-port": {
|
|
3240
4254
|
parameters: {
|
|
3241
4255
|
query?: never;
|
|
3242
|
-
header
|
|
4256
|
+
header: {
|
|
4257
|
+
/** @description Reuse the same key for retries of the same action. A different request with the same key is rejected. */
|
|
4258
|
+
"Idempotency-Key": string;
|
|
4259
|
+
};
|
|
3243
4260
|
path: {
|
|
3244
4261
|
instanceId: string;
|
|
3245
4262
|
};
|
|
@@ -3251,13 +4268,13 @@ export interface operations {
|
|
|
3251
4268
|
};
|
|
3252
4269
|
};
|
|
3253
4270
|
responses: {
|
|
3254
|
-
/** @description
|
|
3255
|
-
|
|
4271
|
+
/** @description The action was accepted. Wait for the returned task to finish. */
|
|
4272
|
+
202: {
|
|
3256
4273
|
headers: {
|
|
3257
4274
|
[name: string]: unknown;
|
|
3258
4275
|
};
|
|
3259
4276
|
content: {
|
|
3260
|
-
"application/json": components["schemas"]["
|
|
4277
|
+
"application/json": components["schemas"]["Task"];
|
|
3261
4278
|
};
|
|
3262
4279
|
};
|
|
3263
4280
|
/** @description Error */
|
|
@@ -3274,7 +4291,10 @@ export interface operations {
|
|
|
3274
4291
|
"detach-port": {
|
|
3275
4292
|
parameters: {
|
|
3276
4293
|
query?: never;
|
|
3277
|
-
header
|
|
4294
|
+
header: {
|
|
4295
|
+
/** @description Reuse the same key for retries of the same action. A different request with the same key is rejected. */
|
|
4296
|
+
"Idempotency-Key": string;
|
|
4297
|
+
};
|
|
3278
4298
|
path: {
|
|
3279
4299
|
instanceId: string;
|
|
3280
4300
|
portId: string;
|
|
@@ -3283,13 +4303,13 @@ export interface operations {
|
|
|
3283
4303
|
};
|
|
3284
4304
|
requestBody?: never;
|
|
3285
4305
|
responses: {
|
|
3286
|
-
/** @description
|
|
3287
|
-
|
|
4306
|
+
/** @description The action was accepted. Wait for the returned task to finish. */
|
|
4307
|
+
202: {
|
|
3288
4308
|
headers: {
|
|
3289
4309
|
[name: string]: unknown;
|
|
3290
4310
|
};
|
|
3291
4311
|
content: {
|
|
3292
|
-
"application/json": components["schemas"]["
|
|
4312
|
+
"application/json": components["schemas"]["Task"];
|
|
3293
4313
|
};
|
|
3294
4314
|
};
|
|
3295
4315
|
/** @description Error */
|
|
@@ -3306,10 +4326,10 @@ export interface operations {
|
|
|
3306
4326
|
"list-operation-logs": {
|
|
3307
4327
|
parameters: {
|
|
3308
4328
|
query?: {
|
|
3309
|
-
/** @description
|
|
4329
|
+
/** @description Return a single kind of operation; the value matches the operation id of the endpoint */
|
|
3310
4330
|
action?: string;
|
|
3311
|
-
|
|
3312
|
-
|
|
4331
|
+
page?: number;
|
|
4332
|
+
page_size?: number;
|
|
3313
4333
|
};
|
|
3314
4334
|
header?: never;
|
|
3315
4335
|
path?: never;
|
|
@@ -3431,8 +4451,10 @@ export interface operations {
|
|
|
3431
4451
|
"list-private-images": {
|
|
3432
4452
|
parameters: {
|
|
3433
4453
|
query?: {
|
|
3434
|
-
/** @description
|
|
3435
|
-
|
|
4454
|
+
/** @description Return only the images of this region. An image can only be used in the region that holds it */
|
|
4455
|
+
region_id?: string;
|
|
4456
|
+
page?: number;
|
|
4457
|
+
page_size?: number;
|
|
3436
4458
|
};
|
|
3437
4459
|
header?: never;
|
|
3438
4460
|
path?: never;
|
|
@@ -3479,7 +4501,7 @@ export interface operations {
|
|
|
3479
4501
|
[name: string]: unknown;
|
|
3480
4502
|
};
|
|
3481
4503
|
content: {
|
|
3482
|
-
"application/json": components["schemas"]["
|
|
4504
|
+
"application/json": components["schemas"]["PlacedOrder"];
|
|
3483
4505
|
};
|
|
3484
4506
|
};
|
|
3485
4507
|
/** @description Error */
|
|
@@ -3527,7 +4549,10 @@ export interface operations {
|
|
|
3527
4549
|
"delete-private-image": {
|
|
3528
4550
|
parameters: {
|
|
3529
4551
|
query?: never;
|
|
3530
|
-
header
|
|
4552
|
+
header: {
|
|
4553
|
+
/** @description Reuse the same key for retries of the same action. A different request with the same key is rejected. */
|
|
4554
|
+
"Idempotency-Key": string;
|
|
4555
|
+
};
|
|
3531
4556
|
path: {
|
|
3532
4557
|
privateImageId: string;
|
|
3533
4558
|
};
|
|
@@ -3535,12 +4560,14 @@ export interface operations {
|
|
|
3535
4560
|
};
|
|
3536
4561
|
requestBody?: never;
|
|
3537
4562
|
responses: {
|
|
3538
|
-
/** @description
|
|
3539
|
-
|
|
4563
|
+
/** @description The action was accepted. Wait for the returned task to finish. */
|
|
4564
|
+
202: {
|
|
3540
4565
|
headers: {
|
|
3541
4566
|
[name: string]: unknown;
|
|
3542
4567
|
};
|
|
3543
|
-
content
|
|
4568
|
+
content: {
|
|
4569
|
+
"application/json": components["schemas"]["Task"];
|
|
4570
|
+
};
|
|
3544
4571
|
};
|
|
3545
4572
|
/** @description Error */
|
|
3546
4573
|
default: {
|
|
@@ -3591,8 +4618,8 @@ export interface operations {
|
|
|
3591
4618
|
"list-private-networks": {
|
|
3592
4619
|
parameters: {
|
|
3593
4620
|
query?: {
|
|
3594
|
-
/** @description
|
|
3595
|
-
|
|
4621
|
+
/** @description Returns every region when omitted */
|
|
4622
|
+
region_id?: string;
|
|
3596
4623
|
};
|
|
3597
4624
|
header?: never;
|
|
3598
4625
|
path?: never;
|
|
@@ -4067,8 +5094,8 @@ export interface operations {
|
|
|
4067
5094
|
"list-security-groups": {
|
|
4068
5095
|
parameters: {
|
|
4069
5096
|
query?: {
|
|
4070
|
-
|
|
4071
|
-
/** @description
|
|
5097
|
+
region_id?: string;
|
|
5098
|
+
/** @description Return only the security groups of this private network */
|
|
4072
5099
|
private_network_id?: string;
|
|
4073
5100
|
};
|
|
4074
5101
|
header?: never;
|
|
@@ -4324,7 +5351,7 @@ export interface operations {
|
|
|
4324
5351
|
"list-snapshots": {
|
|
4325
5352
|
parameters: {
|
|
4326
5353
|
query?: {
|
|
4327
|
-
/** @description
|
|
5354
|
+
/** @description Return only the snapshots of this disk */
|
|
4328
5355
|
disk_id?: string;
|
|
4329
5356
|
};
|
|
4330
5357
|
header?: never;
|
|
@@ -4372,7 +5399,7 @@ export interface operations {
|
|
|
4372
5399
|
[name: string]: unknown;
|
|
4373
5400
|
};
|
|
4374
5401
|
content: {
|
|
4375
|
-
"application/json": components["schemas"]["
|
|
5402
|
+
"application/json": components["schemas"]["PlacedOrder"];
|
|
4376
5403
|
};
|
|
4377
5404
|
};
|
|
4378
5405
|
/** @description Error */
|
|
@@ -4420,7 +5447,10 @@ export interface operations {
|
|
|
4420
5447
|
"delete-snapshot": {
|
|
4421
5448
|
parameters: {
|
|
4422
5449
|
query?: never;
|
|
4423
|
-
header
|
|
5450
|
+
header: {
|
|
5451
|
+
/** @description Reuse the same key for retries of the same action. A different request with the same key is rejected. */
|
|
5452
|
+
"Idempotency-Key": string;
|
|
5453
|
+
};
|
|
4424
5454
|
path: {
|
|
4425
5455
|
snapshotId: string;
|
|
4426
5456
|
};
|
|
@@ -4428,12 +5458,14 @@ export interface operations {
|
|
|
4428
5458
|
};
|
|
4429
5459
|
requestBody?: never;
|
|
4430
5460
|
responses: {
|
|
4431
|
-
/** @description
|
|
4432
|
-
|
|
5461
|
+
/** @description The action was accepted. Wait for the returned task to finish. */
|
|
5462
|
+
202: {
|
|
4433
5463
|
headers: {
|
|
4434
5464
|
[name: string]: unknown;
|
|
4435
5465
|
};
|
|
4436
|
-
content
|
|
5466
|
+
content: {
|
|
5467
|
+
"application/json": components["schemas"]["Task"];
|
|
5468
|
+
};
|
|
4437
5469
|
};
|
|
4438
5470
|
/** @description Error */
|
|
4439
5471
|
default: {
|
|
@@ -4481,4 +5513,68 @@ export interface operations {
|
|
|
4481
5513
|
};
|
|
4482
5514
|
};
|
|
4483
5515
|
};
|
|
5516
|
+
"get-task": {
|
|
5517
|
+
parameters: {
|
|
5518
|
+
query?: never;
|
|
5519
|
+
header?: never;
|
|
5520
|
+
path: {
|
|
5521
|
+
taskId: string;
|
|
5522
|
+
};
|
|
5523
|
+
cookie?: never;
|
|
5524
|
+
};
|
|
5525
|
+
requestBody?: never;
|
|
5526
|
+
responses: {
|
|
5527
|
+
/** @description The task. */
|
|
5528
|
+
200: {
|
|
5529
|
+
headers: {
|
|
5530
|
+
[name: string]: unknown;
|
|
5531
|
+
};
|
|
5532
|
+
content: {
|
|
5533
|
+
"application/json": components["schemas"]["Task"];
|
|
5534
|
+
};
|
|
5535
|
+
};
|
|
5536
|
+
/** @description The request could not be completed. */
|
|
5537
|
+
default: {
|
|
5538
|
+
headers: {
|
|
5539
|
+
[name: string]: unknown;
|
|
5540
|
+
};
|
|
5541
|
+
content: {
|
|
5542
|
+
"application/json": components["schemas"]["Error"];
|
|
5543
|
+
};
|
|
5544
|
+
};
|
|
5545
|
+
};
|
|
5546
|
+
};
|
|
5547
|
+
"list-ipv4-pools": {
|
|
5548
|
+
parameters: {
|
|
5549
|
+
query: {
|
|
5550
|
+
region_id: string;
|
|
5551
|
+
page?: number;
|
|
5552
|
+
page_size?: number;
|
|
5553
|
+
};
|
|
5554
|
+
header?: never;
|
|
5555
|
+
path?: never;
|
|
5556
|
+
cookie?: never;
|
|
5557
|
+
};
|
|
5558
|
+
requestBody?: never;
|
|
5559
|
+
responses: {
|
|
5560
|
+
/** @description OK */
|
|
5561
|
+
200: {
|
|
5562
|
+
headers: {
|
|
5563
|
+
[name: string]: unknown;
|
|
5564
|
+
};
|
|
5565
|
+
content: {
|
|
5566
|
+
"application/json": components["schemas"]["IPv4PoolListResponseBody"];
|
|
5567
|
+
};
|
|
5568
|
+
};
|
|
5569
|
+
/** @description Error */
|
|
5570
|
+
default: {
|
|
5571
|
+
headers: {
|
|
5572
|
+
[name: string]: unknown;
|
|
5573
|
+
};
|
|
5574
|
+
content: {
|
|
5575
|
+
"application/json": components["schemas"]["Error"];
|
|
5576
|
+
};
|
|
5577
|
+
};
|
|
5578
|
+
};
|
|
5579
|
+
};
|
|
4484
5580
|
}
|