summaryrefslogtreecommitdiff
path: root/api-ref/source/parameters.yaml
blob: 293aa9a6ce244bfcd64676f8a2eefa7ffd5f256c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
# variables in path
backup_id:
  description: |
    The ID of the backup.
  in: path
  required: true
  type: string
configId:
  description: |
    The ID of the configuration group.
  in: path
  required: false
  type: string
databaseName:
  description: |
    The name for the database.
  in: path
  required: false
  type: string
datastore_name:
  description: |
    The name of the data store.
  in: path
  required: false
  type: string
datastore_version_id:
  description: |
    The UUID of the data store version.
  in: path
  required: false
  type: string
flavorId:
  description: |
    The ID of the flavor.
  in: path
  required: false
  type: string
instanceId:
  description: |
    The ID of the database instance.
  in: path
  required: false
  type: string
parameter_name:
  description: |
    The name of the parameter for which to show
    details.
  in: path
  required: false
  type: string
project_id:
  description: |
    The project ID of the instance owner.
  in: path
  required: true
  type: string
user_name:
  description: |
      The name of the user.
  in: path
  required: false
  type: string
user_project:
  description: |
    The project ID of the user's project.
  in: path
  required: true
  type: string
# variables in body
access:
  description: |
    A ``access`` object defines how the database service is exposed.
  in: body
  required: false
  type: object
access_allowed_cidrs:
  description: |
    A list of IPv4, IPv6 or mix of both CIDRs that restrict access to the
    database service. ``0.0.0.0/0`` is used by default if this parameter is not
    provided.
  in: body
  required: false
  type: array
access_is_public:
  description: |
    Whether the database service is exposed to the public.
  in: body
  required: false
  type: boolean
availability_zone:
  description: |
    The availability zone of the instance.
  in: body
  required: false
  type: string
backup_description:
  description: |
    An optional description for the backup.
  in: body
  required: false
  type: string
backup_description1:
  description: |
    An optional description for the backup.
  in: body
  required: true
  type: string
backup_incremental:
  description: |
    Create an incremental backup based on the last full backup by setting this
    parameter to 1 or 0. It will create a full backup if no existing backup
    found.
  in: body
  required: false
  type: integer
backup_instanceId:
  description: |
    The ID of the instance to create backup for.
  in: body
  required: true
  type: string
backup_list:
  description: |
    A list of ``backup`` objects.
  in: body
  required: true
  type: array
backup_locationRef:
  description: |
    The URL of the backup location.
  in: body
  required: true
  type: string
backup_name:
  description: |
    Name of the backup.
  in: body
  required: true
  type: string
backup_parentId:
  description: |
    ID of the parent backup to perform an incremental backup from.
  in: body
  required: false
  type: string
backup_parentId1:
  description: |
    ID of the parent backup to perform an incremental backup from.
  in: body
  required: true
  type: string
backup_size:
  description: |
    Size of the backup, the unit is GB.
  in: body
  required: true
  type: string
backup_status:
  description: |
    Status of the backup.
  in: body
  required: true
  type: string
characterSet:
  description: |
    A set of symbols and encodings. Default is
    ``utf8``.  For information about supported character sets and
    collations, see `Character Sets and Collations in MySQL
    <https://dev.mysql.com/doc/refman/5.7/en/charset-mysql.html>`_.
  in: body
  required: false
  type: string
cluster_id:
   description: |
     The cluster ID of an instance.
   in: body
   required: false
   type: string
collate:
  description: |
    A set of rules for comparing characters in a
    character set. Default is ``utf8_general_ci``.  For information
    about supported character sets and collations, see `Character Sets
    and Collations in MySQL <https://dev.mysql.com/doc/refman/5.7/en
    /charset-mysql.html>`_.
  in: body
  required: false
  type: string
configuration:
  description: |
    ID of the configuration group that you want to
    attach to the instance.
  in: body
  required: true
  type: string
configuration1:
  description: |
    A ``configuration`` object.
  in: body
  required: false
  type: object
configuration_id:
  description: |
    The ID of a configuration.
  in: body
  required: true
  type: string
configuration_link_href:
  description: |
    The ``href`` attribute of a configuration link.
  in: body
  required: true
  type: string
configuration_link_rel:
  description: |
    The ``rel`` attribute of a configuration link.
  in: body
  required: true
  type: string
configuration_links:
  description: |
    The ``links`` object of a configuration.
  in: body
  required: true
  type: array
configuration_name:
  description: |
    The name of a configuration.
  in: body
  required: true
  type: string
created:
  description: |
    The date and time when the resource was created.

    The date and time stamp format is `ISO 8601
    <https://en.wikipedia.org/wiki/ISO_8601>`_:

    ::

       CCYY-MM-DDThh:mm:ss±hh:mm

    For example, ``2015-08-27T09:49:58-05:00``.

    The ``±hh:mm`` value, if included, is the time zone as an offset
    from UTC. In the previous example, the offset value is ``-05:00``.
  in: body
  required: true
  type: string
database_name:
  description: |
    The name of a database.
  in: body
  required: true
  type: string
databases:
  description: |
    A ``databases`` object.
  in: body
  required: false
  type: array
datastore:
  description: |
    Data store assigned to the configuration group.
    Required if you did not configure the default data store.
  in: body
  required: true
  type: string
datastore1:
  description: |
    A ``datastore`` object.
  in: body
  required: false
  type: object
datastore2:
  description: |
    A ``datastore`` object.
  in: body
  required: true
  type: object
datastore_type:
   description: |
     The type of a datastore.
   in: body
   required: false
   type: string
datastore_type1:
   description: |
     The type of a datastore.
   in: body
   required: true
   type: string
datastore_version:
  description: |
    Name of the datastore version to use when
    creating/updating the instance.
  in: body
  required: false
  type: string
datastore_version1:
  description: |
    Name or ID of a datastore version.
  in: body
  required: true
  type: string
datastore_version_id1:
  description: |
    The UUID of the data store version.
  in: body
  required: true
  type: string
datastore_version_name:
  description: |
    The name of the datastore version.
  in: body
  required: true
  type: string
description:
  description: |
    New description of the configuration group.
  in: body
  required: true
  type: string
encrypted_rpc_messaging:
  description: |
    Whether the instance is using encrypted
    rpm messaging feature or not.
  in: body
  required: false
  type: boolean
flavor:
  description: |
    A ``flavor`` object, which includes the flavor ID
    (integer) and flavor relative links.
  in: body
  required: true
  type: object
flavor_link_href:
  description: |
    The ``href`` attribute of a flavor link.
  in: body
  required: true
  type: string
flavor_link_rel:
  description: |
    The ``rel`` attribute of a flavor link.
  in: body
  required: true
  type: string
flavor_links:
  description: |
    The ``links`` object of a flavor.
  in: body
  required: true
  type: array
flavorId1:
  description: |
    The ID of the flavor.
  in: body
  required: true
  type: string
flavorRef:
  description: |
    Reference (href), which is the actual URI to a
    flavor as it appears in the list flavors response.  Rather than
    the flavor URI, you can also pass the flavor ID (integer) as the
    ``flavorRef`` value. For example, ``1``.
  in: body
  required: true
  type: string
instance:
  description: |
    An ``instance`` object.
  in: body
  required: true
  type: object
instance_fault:
  description: |
    The ``fault`` object of an instance.
  in: body
  required: false
  type: object
instance_fault_created:
  description: |
    The update timestamp of the fault message
    for an instance.
  in: body
  required: true
  type: string
instance_fault_details:
  description: |
    The detail fault explanation of an instance.
  in: body
  required: true
  type: string
instance_fault_message:
  description: |
    The fault message of an instance.
  in: body
  required: true
  type: string
instance_hostname:
  description: |
    The hostname of an instance.
  in: body
  require: false
  type: string
instance_ip_address:
  description: |
    The IP address of an instance.
  in: body
  require: false
  type: string
instance_link_href:
  description: |
    The ``href`` attribute of an instance link.
  in: body
  required: true
  type: string
instance_link_rel:
  description: |
    The ``rel`` attribute of an instance link.
  in: body
  required: true
  type: string
instance_links:
  description: |
    The ``links`` object of of the instance.
  in: body
  required: true
  type: array
instance_log:
  description: |
    A ``log`` objects.
  in: body
  required: true
  type: array
instance_logs:
  description: |
    A list of ``log`` objects.
  in: body
  required: true
  type: array
instance_replica_id:
  description:
    The ID of a replica instance.
  in: body
  required: true
  type: string
instance_replica_link_href:
  description: |
    The ``href`` attribute of a replica instance link.
  in: body
  required: true
  type: string
instance_replica_link_rel:
  description: |
    The ``rel`` attribute of a replica instance link.
  in: body
  required: true
  type: string
instance_replica_links:
  description:
    The ``links`` object of a replica instance.
  in: body
  required: true
  type: array
instance_replicas:
  description: |
    The ``replicas`` object of an instance.
  in: body
  required: false
  type: array
instance_status:
  description: |
    Status of the instance.
  in: body
  required: true
  type: string
instanceId1:
  description: |
    The ID of the database instance.
  in: body
  required: true
  type: string
instanceName:
  description: |
    Name of the instance.
  in: body
  required: false
  type: string
instanceName1:
  description: |
    Name of the instance.
  in: body
  required: true
  type: string
local_storage_used:
  description: |
    The used space of the ephemeral disk, in gigabytes (GB).
  in: body
  required: false
  type: float
locality:
  description: |
    The scheduler hint when creating underlying
    Nova instances. Valide values are:
    ``affinity``, ``anti-affinity``.
  in: body
  required: false
  type: string
log_container:
  description: |
    The object store container where the published
    log data will be stored. Defaults to ``None``
    before the log has been published.
  in: body
  required: true
  type: string
log_disable_action:
  description: |
    To disable a log type, this should always set to 1.
  in: body
  required: false
  type: integer
log_discard_action:
  description: |
    To discard a log type which has been published previously,
    this should always set to 1.
  in: body
  required: false
  type: integer
log_enable_action:
  description: |
    To enable a log type, this should always set to 1.
  in: body
  required: false
  type: integer
log_metafile:
  description: |
    The log metafile location.
  in: body
  required: true
  type: string
log_name:
  description: |
    The name of the log.
  in: body
  required: true
  type: string
log_pending_size:
  description: |
    Log file size pending to be published.
  in: body
  required: true
  type: string
log_prefix:
  description: |
    If the log has been published, thi is the prefix location
    of where the log data are stored. Otherwize the prefix is
    ``None``.
  in: body
  required: true
  type: string
log_publish_action:
  description: |
    To publish a log type, this should always set to 1.
  in: body
  required: false
  type: integer
log_published_size:
  description: |
    Published size of the log.
  in: body
  required: true
  type: string
log_status:
  description: |
    The log status.
  in: body
  required: true
  type: string
log_type:
  description: |
    The type of the log.
  in: body
  required: true
  type: string
module_id:
  description: |
    The ID of a module.
  in: body
  required: true
  type: string
modules:
  description: |
    The ``modules`` object.
  in: body
  required: false
  type: object
name:
  description: |
    Name of the configuration group you are creating.
  in: body
  required: true
  type: string
nics:
  description: |
     Network interfaces for database service inside Nova instances.
     ``NOTE:`` For backward compatibility, this parameter uses the same schema
     as novaclient creating servers, but only ``net-id`` is supported and can
     only be specified once. This parameter is required in service tenant
     deployment model.
  in: body
  required: false
  type: array
quota_in_use:
  description: |
    The used quota for a resource.
  in: body
  required: true
  type: integer
quota_limit:
  description: |
    The limit of a resource quota.
  in: body
  required: true
  type: integer
quota_list:
  description: |
    A list of resource quotas.
  in: body
  required: true
  type: array
quota_reserved:
  description: |
    The reserved quota for a resource.
  in: body
  required: true
  type: integer
quota_resource:
  description: |
    The resource name.
  in: body
  required: true
  type: string
quotas:
  description: |
    Dictionary that defines the resources quota.
  in: body
  required: true
  type: string
region_name:
  description: |
    The region name of an instance.
  in: body
  required: false
  type: string
region_name2:
  description: |
    The region name of an instance.
  in: body
  required: true
  type: string
replica_count:
  description: |
    Number of replicas to create (defaults to 1).
  in: body
  required: false
  type: integer
replica_of:
  description: |
    ID or name of an existing instance to replicate
    from.
  in: body
  required: false
  type: string
restore_point:
  description: |
    The ``restorePoint`` object. Use this paramter
    to create an instance from a backup.
  in: body
  required: false
  type: object
restore_point_backupref:
  description:
    The backup id used from which a new instance
    is created.
  in: body
  required: true
  type: string
root_password:
  description: |
    The password of the database root user(i.e. the
    administrative user).
  in: body
  required: false
  type: string
server_id:
   description: |
     The ID of the underlying Nova instance for an instance.
   in: body
   required: false
   type: string
shard_id:
   description: |
     The shard ID of an instance.
   in: body
   required: false
   type: string
slave_of:
  description: |
    To detach a replica, set ``slave_of`` to null.
  in: body
  required: true
  type: string
tenant_id:
  description: |
    The ID of a tenant.
  in: body
  required: false
  type: string
updated:
  description: |
    The date and time when the resource was updated.

    The date and time stamp format is `ISO 8601
    <https://en.wikipedia.org/wiki/ISO_8601>`_:

    ::

       CCYY-MM-DDThh:mm:ss±hh:mm

    The ``±hh:mm`` value, if included, is the time zone as an offset
    from UTC.

    For example, ``2015-08-27T09:49:58-05:00``.

    The UTC time zone is assumed.
  in: body
  required: true
  type: string
user_database_name:
  description: |
    The name of a database which the user
    can access.
  in: body
  required: true
  type: string
user_databases:
  description: |
    The ``databases`` object. This is a list
    of databases which the user can access.
  in: body
  required: false
  type: array
user_host:
  description: |
    A host allowed for a user.
  in: body
  required: false
  type: string
user_name1:
  description: |
    The name of a user.
  in: body
  required: true
  type: string
user_password:
  description: |
    The password of a user.
  in: body
  required: true
  type: string
users:
  description: |
    A ``users`` object.
  in: body
  required: false
  type: array
values:
  description: |
    Dictionary that lists configuration parameter
    names and associated values.
  in: body
  required: true
  type: string
volume:
  description: |
    A ``volume`` object.
  in: body
  required: false
  type: object
volume_id:
  description: |
    The ID of a volume.
  in: body
  required: false
  type: string
volume_size:
  description: |
    The volume size, in gigabytes (GB). A valid value
    is from 1 to 50(this limit is controlled by the
    configuration ``max_accepted_volume_size``).
  in: body
  required: true
  type: integer
volume_size2:
  description: |
    The volume size, in gigabytes (GB).
  in: body
  required: true
  type: integer
volume_type:
  description: |
    The volume type to use. You can list the
    available volume types on your system by using the ``cinder type-
    list`` command.  If you want to specify a volume type, you must
    also specify a volume size.
  in: body
  required: false
  type: string
volume_used:
  description: |
    The used space of the volume, in gigabytes (GB).
  in: body
  required: false
  type: float