Debian Codegraph @

api-ref/source/v1/parameters.yaml

raw
1 # variables in headers
2 x-openstack-request-id_req:
3 description: |
4 The global request ID, which is a unique common ID
5 for tracking each request in OpenStack services.
6 The format of the global request ID must be ``req-`` + UUID (UUID4).
7 If not in accordance with the format, it is ignored.
8 It is associated with the request and appears in the log lines
9 for that request.
10 The global request ID appears in the Blazar logs and all cross
11 services it interacts with.
12 in: header
13 required: false
14 type: string
15 x-openstack-request-id_resp:
16 description: |
17 The local request ID, which is a unique ID generated automatically
18 for tracking each request to blazar.
19 It is associated with the request and appears in the log lines
20 for that request.
21 in: header
22 required: true
23 type: string
24
25
26 # variables in path
27 floatingip_id_path:
28 description: |
29 The ID of the floating IP.
30 in: path
31 required: true
32 type: string
33 host_id_path:
34 description: |
35 The ID of the host.
36 in: path
37 required: true
38 type: string
39 lease_id_path:
40 description: |
41 The UUID of the lease.
42 in: path
43 required: true
44 type: string
45 property_name:
46 description: |
47 The name of the property.
48 in: path
49 required: true
50 type: string
51
52
53 # variables in query
54 allocation_lease_id_query:
55 description: |
56 Filter allocations results by lease id
57 in: query
58 required: false
59 type: string
60 allocation_reservation_id_query:
61 description: |
62 Filter allocations results by reservation id
63 in: query
64 required: false
65 type: string
66 resource_property_all:
67 description: |
68 Whether to include all resource properties, public and private.
69 in: query
70 required: false
71 type: string
72 resource_property_detail:
73 description: |
74 Whether to include values along for each property and if the property
75 is private.
76 in: query
77 required: false
78 type: string
79
80
81 # variables in body
82 allocation:
83 description: |
84 An ``allocation`` object. This object describes a mapping
85 between resource_id and reservations.
86 in: body
87 required: true
88 type: array
89 allocation_end_date:
90 description: |
91 The end date of the lease.
92 in: body
93 required: true
94 type: string
95 allocation_start_date:
96 description: |
97 The start date of the lease.
98 in: body
99 required: true
100 type: string
101 allocations:
102 description: |
103 A list of ``allocation`` objects.
104 in: body
105 required: true
106 type: array
107 created_at:
108 description: |
109 The date and time when the object was created.
110 in: body
111 required: true
112 type: string
113 event:
114 description: |
115 An ``event`` object.
116 in: body
117 required: true
118 type: object
119 event_id:
120 description: |
121 The UUID of the event.
122 in: body
123 required: true
124 type: string
125 event_lease_id:
126 description: |
127 The UUID of the lease to which the event belongs.
128 in: body
129 required: true
130 type: string
131 event_status:
132 description: |
133 The status of the event.
134 in: body
135 required: true
136 type: string
137 event_time:
138 description: |
139 The date and time of the event.
140 in: body
141 required: true
142 type: string
143 event_type:
144 description: |
145 The type of the event.
146 in: body
147 required: true
148 type: string
149 events:
150 description: |
151 A list of ``event`` objects.
152 in: body
153 required: true
154 type: array
155 events_optional:
156 description: |
157 A list of ``event`` objects.
158 in: body
159 required: false
160 type: array
161
162 ## parameters for floating IP
163
164 floating_ip_address:
165 description:
166 The floating IP address.
167 in: body
168 required: true
169 type: string
170 floating_ip_address_create:
171 description:
172 The floating IP address. The IP must be the out side of allocation_pools
173 and within its subnet's CIDR network.
174 in: body
175 required: true
176 type: string
177 floating_network_id:
178 description:
179 An external network ID the floating IP belongs to.
180 in: body
181 required: true
182 type: string
183 floating_subnet_id:
184 description: |
185 An external subnet ID the floating IP belongs to.
186 in: body
187 required: true
188 type: boolean
189 floatingip:
190 description: |
191 A ``floatingip`` object.
192 in: body
193 required: true
194 type: object
195 floatingip_id:
196 description:
197 The ID of the floating ip resources.
198 in: body
199 required: true
200 type: string
201 floatingip_reservable:
202 description: |
203 The flag which represents whether the floating IP is reservable or not.
204 in: body
205 required: true
206 type: boolean
207 floatingips:
208 description: |
209 A list of ``floatingip`` objects.
210 in: body
211 required: true
212 type: array
213
214 ## parameters for host
215
216 host:
217 description: |
218 A ``host`` object.
219 in: body
220 required: true
221 type: object
222 host_cpu_info:
223 description: |
224 Information of the CPU of the host.
225 in: body
226 required: true
227 type: string
228 host_extra_capability:
229 description: |
230 The extra capability of the host.
231
232 .. note:: Any key-value pair can be stored as one of extra capabilities of
233 the host.
234 in: body
235 required: false
236 type: any
237 host_hypervisor_hostname:
238 description: |
239 The hypervisor name of the host.
240 in: body
241 required: true
242 type: string
243 host_hypervisor_type:
244 description: |
245 The hypervisor type the host.
246 in: body
247 required: true
248 type: string
249 host_hypervisor_version:
250 description: |
251 The hypervisor version of the host.
252 in: body
253 required: true
254 type: integer
255 host_id:
256 description: |
257 The ID of the host.
258 in: body
259 required: true
260 type: string
261 host_local_gb:
262 description: |
263 Gigabytes of the disk of the host.
264 in: body
265 required: true
266 type: integer
267 host_memory_mb:
268 description: |
269 Megabytes of the memory of the host.
270 in: body
271 required: true
272 type: integer
273 host_name:
274 description: |
275 The name of the host.
276 in: body
277 required: true
278 type: string
279 host_reservable:
280 description: |
281 The flag which represents whether the host is reservable or not.
282 in: body
283 required: true
284 type: boolean
285 host_service_name:
286 description: |
287 The compute service name of the host.
288 in: body
289 required: true
290 type: string
291 host_status:
292 description: |
293 The status of the host.
294
295 .. note:: This is null currently.
296 in: body
297 required: true
298 type: string
299 host_trust_id:
300 description: |
301 The UUID of the trust of the host operator.
302 in: body
303 required: true
304 type: string
305 host_vcpus:
306 description: |
307 The number of the VCPUs of the host.
308 in: body
309 required: true
310 type: integer
311 hosts:
312 description: |
313 A list of ``host`` objects.
314 in: body
315 required: true
316 type: array
317
318 ## parameters for leases
319
320 lease:
321 description: |
322 A ``lease`` object.
323 in: body
324 required: true
325 type: object
326 lease_before_end_date:
327 description: |
328 The date and time for the before-end-action of the lease.
329 in: body
330 required: true
331 type: string
332 lease_before_end_date_optional:
333 description: |
334 The date and time for the before-end-action of the lease.
335 in: body
336 required: false
337 type: string
338 lease_degraded:
339 description: |
340 The flag for reserved resources of the lease.
341 This is set True while *missing_resources* or *resources_changed* of
342 reservations is set True.
343 in: body
344 required: true
345 type: boolean
346 lease_end_date:
347 description: |
348 The end date and time of the lease.
349 in: body
350 required: true
351 type: string
352 lease_end_date_optional:
353 description: |
354 The end date and time of the lease.
355 in: body
356 required: false
357 type: string
358 lease_id:
359 description: |
360 The UUID of the lease.
361 in: body
362 required: true
363 type: string
364 lease_name:
365 description: |
366 The name of the lease.
367 in: body
368 required: true
369 type: string
370 lease_name_optional:
371 description: |
372 The name of the lease.
373 in: body
374 required: false
375 type: string
376 lease_project_id:
377 description: |
378 The UUID the project which owns the lease.
379 in: body
380 required: true
381 type: string
382 lease_start_date:
383 description: |
384 The start date and time of the lease.
385
386 .. note:: If ``now`` is specified, the lease starts immediately.
387 in: body
388 required: true
389 type: string
390 lease_start_date_optional:
391 description: |
392 The start date and time of the lease.
393
394 .. note:: If ``now`` is specified, the lease starts immediately.
395 in: body
396 required: false
397 type: string
398 lease_start_date_resp:
399 description: |
400 The start date and time of the lease.
401 in: body
402 required: true
403 type: string
404 lease_status:
405 description: |
406 The status of the lease.
407 in: body
408 required: true
409 type: string
410 lease_trust_id:
411 description: |
412 The UUID of the trust of the lease owner.
413 in: body
414 required: true
415 type: string
416 lease_user_id:
417 description: |
418 The UUID of the lease owner.
419 in: body
420 required: true
421 type: string
422 leases:
423 description: |
424 A list of ``lease`` objects.
425 in: body
426 required: true
427 type: array
428 property_private:
429 description: |
430 Whether the property is private.
431
432 in: body
433 required: true
434 type: boolean
435 reservation:
436 description: |
437 A ``reservation`` object.
438 in: body
439 required: true
440 type: object
441 reservation_affinity:
442 description: |
443 The affinity of instances to reserve. The value should be ``True``, ``False`` or ``None``.
444 in: body
445 required: true
446 type: trilean
447 reservation_affinity_optional:
448 description: |
449 The affinity of instances to reserve. The value should be ``True``, ``False`` or ``None``.
450 in: body
451 required: false
452 type: trilean
453 reservation_aggregate_id:
454 description: |
455 The aggregate ID of the reservation.
456 in: body
457 required: true
458 type: integer
459 reservation_allocation:
460 description: |
461 A list of ``reservation allocation`` objects. The object consists of
462 reservation id and its lease_id.
463 in: body
464 required: true
465 type: array
466 reservation_amount:
467 description: |
468 The amount of instances to reserve. The value should be greater than 0.
469 in: body
470 required: true
471 type: integer
472 reservation_amount_optional:
473 description: |
474 The amount of instances to reserve. The value should be greater than 0.
475 in: body
476 required: false
477 type: integer
478 reservation_before_end:
479 description: |
480 The before-end-action of the reservation.
481
482 .. note:: ``default`` and ``snapshot`` actions are supported.
483 in: body
484 required: true
485 type: string
486 reservation_before_end_optional:
487 description: |
488 The before-end-action of the reservation.
489
490 .. note:: ``default`` and ``snapshot`` actions are supported.
491 in: body
492 required: false
493 type: string
494 reservation_disk_gb:
495 description: |
496 Gigabytes of the local disk per the instance.
497 in: body
498 required: true
499 type: string
500 reservation_disk_gb_optional:
501 description: |
502 Gigabytes of the local disk per the instance.
503 in: body
504 required: false
505 type: string
506 reservation_flavor_id:
507 description: |
508 The flavor ID used for launching instances on reserved resources.
509 in: body
510 required: true
511 type: string
512 reservation_hypervisor_properties:
513 description: |
514 Properties of the hypervisor to reserve.
515 in: body
516 required: true
517 type: string
518 reservation_hypervisor_properties_optional:
519 description: |
520 Properties of the hypervisor to reserve.
521 in: body
522 required: true
523 type: string
524 reservation_id:
525 description: |
526 The UUID of the reservation.
527 in: body
528 required: true
529 type: string
530 reservation_lease_id:
531 description: |
532 The UUID of the lease to which the reservation belongs.
533 in: body
534 required: true
535 type: string
536 reservation_max:
537 description: |
538 The maximum number of hosts to reserve. The value should be greater than or equal to ``min`` value.
539 in: body
540 required: true
541 type: integer
542 reservation_max_optional:
543 description: |
544 The maximum number of hosts to reserve. The value should be greater than or equal to ``min``.
545 in: body
546 required: false
547 type: integer
548 reservation_memory_mb:
549 description: |
550 Megabytes of memory per the instance.
551 in: body
552 required: true
553 type: integer
554 reservation_memory_mb_optional:
555 description: |
556 Megabytes of memory per the instance.
557 in: body
558 required: false
559 type: integer
560 reservation_min:
561 description: |
562 The minimum number of hosts to reserve. The value should be greater than 0.
563 in: body
564 required: true
565 type: integer
566 reservation_min_optional:
567 description: |
568 The minimum number of hosts to reserve. The value should be greater than 0.
569 in: body
570 required: false
571 type: integer
572 reservation_missing_resources:
573 description: |
574 The flag for the capacity of reserved resources.
575 It is set True while the amount of reserved resources is less than the
576 request.
577 in: body
578 required: true
579 type: boolean
580 reservation_resource_id:
581 description: |
582 The ID of the resource object of the reservation.
583 in: body
584 required: true
585 type: string
586 reservation_resource_properties:
587 description: |
588 Properties of the resource to reserve.
589 in: body
590 required: true
591 type: string
592 reservation_resource_properties_optional:
593 description: |
594 Properties of the resource to reserve.
595 in: body
596 required: false
597 type: string
598 reservation_resource_type:
599 description: |
600 The type of the resource to reserve.
601
602 .. note:: ``physical:host`` and ``virtual:instance`` types are supported.
603 in: body
604 required: true
605 type: string
606 reservation_resource_type_resp:
607 description: |
608 The type of the resource to reserve.
609 in: body
610 required: true
611 type: string
612 reservation_resources_changed:
613 description: |
614 The flag for changes of reserved resources.
615 If it is set True if reserved resources were changed after the lease
616 started.
617 in: body
618 required: true
619 type: boolean
620 reservation_server_group_id:
621 description: |
622 The server group ID specified when launch instances on reserved resources.
623 in: body
624 required: true
625 type: string
626 reservation_status:
627 description: |
628 The status of the reservation.
629 in: body
630 required: true
631 type: string
632 reservation_vcpus:
633 description: |
634 The number of VCPUs per the instance.
635 in: body
636 required: true
637 type: integer
638 reservation_vcpus_optional:
639 description: |
640 The number of VCPUs per the instance.
641 in: body
642 required: false
643 type: integer
644 reservations:
645 description: |
646 A list of ``reservation`` objects.
647 in: body
648 required: true
649 type: array
650 reservations_optional:
651 description: |
652 A list of ``reservation`` objects.
653 in: body
654 required: false
655 type: array
656 resource_properties:
657 description: |
658 A list of ``resource_property`` objects.
659
660 in: body
661 required: true
662 type: array
663 resource_properties_private:
664 description: |
665 Whether the property is private.
666
667 in: body
668 required: false
669 type: boolean
670 resource_properties_property:
671 description: |
672 The name of the property.
673
674 in: body
675 required: true
676 type: any
677 resource_properties_values:
678 description: |
679 A list of values for the property.
680
681 in: body
682 required: false
683 type: array
684 resource_property:
685 description: |
686 The updated ``resource_property`` object.
687
688 in: body
689 required: true
690 type: any
691 resource_property_id:
692 description: |
693 The updated ``resource_property`` UUID.
694
695 in: body
696 required: true
697 type: string
698 resource_property_private:
699 description: |
700 Whether the updated ``resource_property`` is private.
701
702 in: body
703 required: true
704 type: boolean
705 resource_property_property_name:
706 description: |
707 The updated ``resource_property`` property_name.
708
709 in: body
710 required: true
711 type: string
712 resource_property_resource_type:
713 description: |
714 The updated ``resource_property`` resource type.
715
716 in: body
717 required: true
718 type: string
719 updated_at:
720 description: |
721 The date and time when the object was updated.
722 in: body
723 required: true
724 type: string