forked from openstack/nova
-
Notifications
You must be signed in to change notification settings - Fork 0
/
dbaas.wadl
1240 lines (1193 loc) · 64.2 KB
/
dbaas.wadl
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
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE application [
<!ENTITY % common SYSTEM "common.ent">
%common;
]>
<application
xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:dbaas="http://docs.openstack.org/database/api/v1.0">
<grammars>
<include href="dbaas.xsd" />
</grammars>
<resources base="https://ord.databases.api.rackspacecloud.com">
<resource id="versions" path="">
<method href="#getVersions" />
</resource>
<resource id="version" path="{version}">
<method href="#getVersionInfo" />
<resource id="accountID" path="{accountID}">
<param name="accountID" style="template"
type="xsd:string">
<doc>The accountID of the owner of the specified instance.</doc></param>
<resource id="instances" path="instances">
<method href="#createInstance" />
<method href="#getInstance" />
<resource id="instanceDetails" path="detail">
<method href="#getInstanceDetails" />
</resource>
<resource id="instanceId" path="{instanceId}">
<param name="instanceId" style="template"
type="xsd:string" >
<doc>The instanceID for the specified database instance.</doc></param>
<method href="#getInstanceById" />
<method href="#deleteInstance" />
<resource id="instanceAction" path="action">
<method href="#resizeInstance" />
<method href="#resizeVolume" />
<method href="#restartInstance" />
</resource>
<resource id="databases" path="databases">
<method href="#createDatabase" />
<method href="#getDatabases" />
<resource id="databaseName" path="{databaseName}">
<param name="databaseName" style="template"
type="xsd:string" >
<doc>The name for the specified database.</doc></param>
<method href="#deleteDatabase" />
</resource>
</resource>
<resource id="users" path="users">
<method href="#createUser" />
<method href="#getUsers" />
<resource id="userId" path="{name}">
<param name="name" style="template"
type="xsd:string" >
<doc>The name for the specified user.</doc></param>
<method href="#deleteUser" />
</resource>
</resource>
<resource id="root" path="root">
<method href="#createRoot" />
<method href="#isRootEnabled" />
</resource>
</resource>
</resource>
<resource id="flavors" path="flavors">
<method href="#getFlavors" />
<resource id="flavorDetails" path="detail">
<method href="#getFlavorDetails" />
</resource>
<resource id="flavorId" path="{flavorId}">
<param name="flavorId" style="template" type="xsd:string" >
<doc>The flavor ID for the specified flavor.</doc></param>
<method href="#getFlavorById" />
</resource>
</resource>
</resource>
</resource>
</resources>
<!--Token Methods... -->
<!-- Version -->
<method name="GET" id="getVersionInfo">
<wadl:doc xml:lang="EN" title="List Version Details" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">
Returns detailed information about the specified version of the API.
</para>
<remark>Reviewer: in the DNS project, we have been requested by the customer to provide a table of parameters (should be pulled automatically if parms defined in wadl) and a table of attributes (for calls that allow detailed info about the object created to be specified. No doubt our DB customers will want this too.</remark>
<remark>Reviewer: These tables probably need 4 columns: name; parameter type: e.g. template, query, etc.; data type: string, etc.; required?; description.</remark>
<para>This operation returns detailed information about the specified version of the API.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List Version Details requests:</para>
<xsdxt:code href="../apidocs/src/resources/samples/db-version-request.xml"/>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<xsdxt:code href="../apidocs/src/resources/samples/db-version-request.json"/>
</doc>
</representation>
</request>
<response status="202">
<representation mediaType="application/xml" >
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List Version Details responses:</para>
<xsdxt:code href="../apidocs/src/resources/samples/db-version-response.xml"/>
</doc>
</representation>
<representation mediaType="application/json" >
<doc>
<xsdxt:code href="../apidocs/src/resources/samples/db-version-response.json"/>
</doc>
</representation>
</response>
&commonFaults;
&getFaults;
</method>
<method name="GET" id="getVersions">
<wadl:doc xml:lang="EN" title="List Versions" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">
Lists information about all versions of the API.
</para>
<para>This operation lists information about all versions of the API.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List Versions requests:</para>
<xsdxt:code href="../apidocs/src/resources/samples/db-versions-request.xml"/>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<xsdxt:code href="../apidocs/src/resources/samples/db-versions-request.json"/>
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml" >
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List Versions responses:</para>
<xsdxt:code href="../apidocs/src/resources/samples/db-versions-response.xml"/>
</doc>
</representation>
<representation mediaType="application/json" >
<doc>
<xsdxt:code href="../apidocs/src/resources/samples/db-versions-response.json"/>
</doc>
</representation>
</response>
&commonFaults;
&getFaults;
</method>
<!-- Instance -->
<method name="POST" id="createInstance">
<wadl:doc xml:lang="EN" title="Create Database Instance" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Creates a new database instance.</para>
<para>This operation asynchronously provisions a new database instance. This call requires the user to specify a flavor and a volume size. The service then provisions the instance with the requested flavor and sets up a volume of the specified size, which is the storage for the database instance.</para>
<note><title>Notes</title><itemizedlist>
<listitem>
<para>You can create only one database instance per <command>POST</command> request.</para>
</listitem>
<listitem>
<para>You can create a database instance with one or more databases, and users associated to those databases.</para>
</listitem>
<listitem>
<para>The default binding for the MySQL instance is port 3306.</para>
</listitem>
</itemizedlist></note>
<para>The following table lists the required and optional attributes for Create Instance:</para>
<table rules="all">
<caption>Required and Optional Attributes for Create Instance</caption>
<thead>
<tr>
<td colspan="1">Applies To </td>
<td colspan="1">Name </td>
<td colspan="3">Description</td>
<td colspan="1">Required</td>
</tr>
</thead>
<tbody>
<tr>
<td colspan="1" rowspan="3">Instance</td>
<td colspan="1">flavorRef</td>
<td colspan="3"><para>Reference (href) to a flavor as specified in the response from the List Flavors API call.
This is the actual URI as specified by the href field in the link. For example, in the following List Flavors response, the link to flavor id 1 is specified as
"https://ord.databases.api.rackspacecloud.com/v1.0/1234/flavors/1".</para>
<note>Rather than the flavor URI, you can also pass the flavor id (integer) as the value for flavorRef. For example, the flavor id for the flavor URI shown above is "1".</note>
<para>Refer to <xref linkend="GET_getFlavors__version___accountID__flavors_flavors"/> for details.</para></td>
<td colspan="1">Yes</td>
</tr>
<tr>
<td colspan="1">size</td>
<td colspan="3">Specifies the volume size in gigabytes (GB). The value specified must be between 1 and 10.</td>
<td colspan="1">Yes</td>
</tr>
<tr>
<td colspan="1">name</td>
<td colspan="3">Name of the instance to create.</td>
<td colspan="1">No</td>
</tr>
<tr>
<td colspan="1" rowspan="3">Database</td>
<td colspan="1">name</td>
<td colspan="3">Specifies database names for creating databases on instance creation. Refer to <xref linkend="POST_createDatabase__version___accountID__instances__instanceId__databases_databases"/> for the required xml/json format.</td>
<td colspan="1">No</td>
</tr>
<tr>
<td colspan="1">character_set</td>
<td colspan="3">Set of symbols and encodings. The default character set is <code>utf8</code>.</td>
<td colspan="1">No</td>
</tr>
<tr>
<td colspan="1">collate</td>
<td colspan="3">Set of rules for comparing characters in a character set. The default value for collate is <code>utf8_general_ci</code>.</td>
<td colspan="1">No</td>
</tr>
<tr>
<td colspan="1" rowspan="3">User</td>
<td colspan="1">name</td>
<td colspan="3">Specifies user name for the database on instance creation. Refer to <xref linkend="POST_createUser__version___accountID__instances__instanceId__users_user_management"/> for the required xml/json format.</td>
<td colspan="1">No</td>
</tr>
<tr>
<td colspan="1">password</td>
<td colspan="3">Specifies password for those users on instance creation. Refer to <xref linkend="POST_createUser__version___accountID__instances__instanceId__users_user_management"/> for the required xml/json format.</td>
<td colspan="1">No</td>
</tr>
<tr>
<td colspan="1">(database) name</td>
<td colspan="3">Specifies names of databases that those users can access on instance creation. Refer to Refer to <xref linkend="POST_createUser__version___accountID__instances__instanceId__users_user_management"/> for the required xml/json format.</td>
<td colspan="1">No</td>
</tr>
</tbody>
</table>
<para>Refer to <xref linkend="database_instance_status"/> for a list of possible database instance statuses that may be returned.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml"
element="dbaas:DatabaseInstance">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Create Database Instance requests and responses:</para>
<xsdxt:code href="../apidocs/src/resources/samples/db-create-instance-request.xml"/>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<xsdxt:code href="../apidocs/src/resources/samples/db-create-instance-request.json"/>
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml" element="dbaas:DatabaseInstance" >
<doc>
<xsdxt:code href="../apidocs/src/resources/samples/db-create-instance-response.xml"/>
</doc>
</representation>
<representation mediaType="application/json" >
<doc>
<xsdxt:code href="../apidocs/src/resources/samples/db-create-instance-response.json"/>
<para xmlns="http://docbook.org/ns/docbook">For convenience, notice in the response examples above that resources contain links to themselves. This allows a client to easily obtain
resource URIs rather than to construct them. There are two kinds of link relations
associated with resources. A <code>self</code> link contains a <emphasis>versioned</emphasis> link to the resource. These
links should be used in cases where the link will be followed immediately. A <code>bookmark</code>
link provides a permanent link to a resource that is appropriate for long term storage.</para>
</doc>
</representation>
</response>
&commonFaults;
&getFaults;
</method>
<method name="DELETE" id="deleteInstance">
<wadl:doc xml:lang="EN" title="Delete Database Instance" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Deletes the specified database instance.</para>
<para>This operation deletes the specified database instance, including any associated data.</para>
<para>Refer to <xref linkend="database_instance_status"/> for a list of possible database instance statuses that may be returned.</para>
<note>This operation does not delete any read slaves.</note>
<remark>Reviewer: please provide a description of read slaves that I can add to the previous note.</remark>
<note>This operation is not allowed when the instance state is either <code>REBUILDING</code> or <code>BUILDING</code>.</note>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Delete Database Instance requests:</para>
<xsdxt:code href="../apidocs/src/resources/samples/db-delete-instance-request.xml"/>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<xsdxt:code href="../apidocs/src/resources/samples/db-delete-instance-request.json"/>
</doc>
</representation>
</request>
<response status="202" />
&commonFaults;
<response status="422" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="dbaas:unprocessableEntity">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Delete Database Instance responses:</para>
<xsdxt:code href="../apidocs/src/resources/samples/db-delete-instance-response.xml"/>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<xsdxt:code href="../apidocs/src/resources/samples/db-delete-instance-response.json"/>
</doc>
</representation>
</response>
&getFaults;
</method>
<method name="GET" id="getInstance">
<wadl:doc xml:lang="EN" title="List All Database Instances" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Lists the status and summary information for all database instances.</para>
<para>This operation lists the status and summary information for all database instances.</para>
<para>Refer to <xref linkend="database_instance_status"/> for a list of possible database instance statuses that may be returned.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List All Database Instances Detail requests:</para>
<xsdxt:code href="../apidocs/src/resources/samples/db-instances-index-request.xml"/>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<xsdxt:code href="../apidocs/src/resources/samples/db-instances-index-request.json"/>
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml" >
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List All Database Instances responses:</para>
<xsdxt:code href="../apidocs/src/resources/samples/db-instances-index-response.xml"/>
</doc>
</representation>
<representation mediaType="application/json" >
<doc>
<xsdxt:code href="../apidocs/src/resources/samples/db-instances-index-response.json"/>
</doc>
</representation>
</response>
&commonFaults;
&getFaults;
</method>
<method name="GET" id="getInstanceDetails">
<wadl:doc xml:lang="EN" title="List All Database Instances Detail" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Lists the status and details for all database instances.</para>
<para>This operation lists the status and details for all database instances.</para>
<para>Refer to <xref linkend="database_instance_status"/> for a list of possible database instance statuses that may be returned.</para>
<para>The list operations return a DNS-resolvable hostname associated with the database instance instead of an IP address. Since the hostname always resolves to the correct IP address of the database instance, this relieves the user from the task of maintaining the mapping. Note that although the IP address may likely change on resizing, migrating, and so forth, the hostname always resolves to the correct database instance.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List All Database Instances Detail requests:</para>
<xsdxt:code href="../apidocs/src/resources/samples/db-instances-detail-request.xml"/>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<xsdxt:code href="../apidocs/src/resources/samples/db-instances-detail-request.json"/>
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml" element="dbaas:DatabaseInstances" >
<doc>
<?hard-pagebreak?>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List All Database Instances Detail responses:</para>
<xsdxt:code href="../apidocs/src/resources/samples/db-instances-detail-response.xml"/>
</doc>
</representation>
<representation mediaType="application/json" element="dbaas:DatabaseInstances" >
<doc>
<xsdxt:code href="../apidocs/src/resources/samples/db-instances-detail-response.json"/>
</doc>
</representation>
</response>
&commonFaults;
&getFaults;
</method>
<method name="GET" id="getInstanceById">
<wadl:doc xml:lang="EN" title="List Database Instance Status and Details" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Lists status and details for a specified database instance or all database instances associated with an account.</para>
<para>This operation lists the status and details of the specified database instance or, if no database instance is specified, all database instances associated with an account.</para>
<para>If a database instance is specified, this operation lists the volume size in gigabytes (GB) and the approximate GB used.</para>
<note>After instance creation, the used size of your volume will be
greater than 0. This is expected and due to the automatic creation of
non-empty transaction logs for mysql optimization.</note>
<para>Refer to <xref linkend="database_instance_status"/> for a list of possible database instance statuses that may be returned.</para>
<para>The list operations return a DNS-resolvable hostname associated with the database instance instead of an IP address. Since the hostname always resolves to the correct IP address of the database instance, this relieves the user from the task of maintaining the mapping. Note that although the IP address may likely change on resizing, migrating, and so forth, the hostname always resolves to the correct database instance.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List Database Instance Status and Details requests:</para>
<xsdxt:code href="../apidocs/src/resources/samples/db-instance-status-detail-request.xml"/>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<xsdxt:code href="../apidocs/src/resources/samples/db-instance-status-detail-request.xml"/>
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml"
element="dbaas:DatabaseInstance" >
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List Database Instance Status and Details responses:</para>
<xsdxt:code href="../apidocs/src/resources/samples/db-instance-status-detail-response.xml"/>
</doc>
</representation>
<representation mediaType="application/json"
element="dbaas:DatabaseInstance" >
<doc>
<xsdxt:code href="../apidocs/src/resources/samples/db-instance-status-detail-response.json"/>
</doc>
</representation>
</response>
&commonFaults;
&getFaults;
</method>
<!-- Instance Actions -->
<method name="POST" id="restartInstance">
<wadl:doc xml:lang="EN" title="Restart Instance" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Restart the database service on the instance.</para>
<para>The restart operation will restart only the MySQL Instance. Restarting MySQL will erase any dynamic configuration settings that you have made within MySQL.</para>
<note>The MySQL service will be unavailable until the instance restarts.</note>
<para>This operation returns a 202 Accepted response.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml" element="dbaas:Restart">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Restart Instance requests:</para>
<xsdxt:code href="../apidocs/src/resources/samples/db-instance-restart-request.xml"/>
</doc>
</representation>
<representation mediaType="application/json" element="dbaas:Restart">
<doc>
<xsdxt:code href="../apidocs/src/resources/samples/db-instance-restart-request.json"/>
</doc>
</representation>
</request>
<response status="202">
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Restart Instance responses:</para>
<xsdxt:code href="../apidocs/src/resources/samples/db-instance-restart-response.xml"/>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<xsdxt:code href="../apidocs/src/resources/samples/db-instance-restart-response.json"/>
</doc>
</representation>
</response>
&commonFaults;
&getFaults;
&postPutFaults;
</method>
<method name="POST" id="resizeInstance">
<wadl:doc xml:lang="EN" title="Resize the Instance" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Resize the memory of the instance.</para>
<para>This operation changes the memory size of the instance, assuming a valid flavorRef is provided. Restarts MySQL in the process.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml"
element="dbaas:Resize">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Resize Instance requests:</para>
<xsdxt:code href="../apidocs/src/resources/samples/db-instance-resize-instance-request.xml"/>
</doc>
</representation>
<representation mediaType="application/json"
element="dbaas:Resize">
<doc>
<xsdxt:code href="../apidocs/src/resources/samples/db-instance-resize-instance-request.json"/>
</doc>
</representation>
</request>
<response status="202">
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Resize Instance responses:</para>
<xsdxt:code href="../apidocs/src/resources/samples/db-instance-resize-instance-response.xml"/>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<xsdxt:code href="../apidocs/src/resources/samples/db-instance-resize-instance-response.json"/>
</doc>
</representation>
</response>
&commonFaults;
&getFaults;
&postPutFaults;
</method>
<method name="POST" id="resizeVolume">
<wadl:doc xml:lang="EN" title="Resize the Instance Volume" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Resize the volume attached to the Instance.</para>
<para>This operation supports resizing the attached volume for an instance. It supports only increasing the volume size and does not support decreasing the size.
The volume size is in gigabytes (GB) and must be an integer.</para>
<note>You cannot increase the volume to a size larger than the API volume size limit specifies.</note>
<para>This operation returns a 202 Accepted response.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml"
element="dbaas:Resize">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Resize Instance Volume requests:</para>
<xsdxt:code href="../apidocs/src/resources/samples/db-instance-resize-volume-request.xml"/>
</doc>
</representation>
<representation mediaType="application/json"
element="dbaas:Resize">
<doc>
<xsdxt:code href="../apidocs/src/resources/samples/db-instance-resize-volume-request.json"/>
</doc>
</representation>
</request>
<response status="202">
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Resize Instance Volume responses:</para>
<xsdxt:code href="../apidocs/src/resources/samples/db-instance-resize-volume-response.xml"/>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<xsdxt:code href="../apidocs/src/resources/samples/db-instance-resize-volume-response.json"/>
</doc>
</representation>
</response>
&commonFaults;
&getFaults;
&postPutFaults;
</method>
<!-- Database -->
<method name="POST" id="createDatabase">
<wadl:doc xml:lang="EN" title="Create Database" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Creates a new database within the specified instance.</para>
<para>This operation creates a new database within the specified instance.</para>
<para>The <code>name</code> of the database is a required attribute.</para>
<para>The following additional attributes can be specified for each database: <code>collate</code> and <code>character_set</code>.</para>
<table rules="all">
<caption>Required and Optional Attributes for Create Database</caption>
<thead>
<tr>
<td colspan="1">Name </td>
<td colspan="3">Description</td>
<td colspan="1">Required</td>
</tr>
</thead>
<tbody>
<tr>
<td colspan="1">name</td>
<td colspan="3">Specifies the database name for creating the database. Refer to the request examples for the required xml/json format.</td>
<td colspan="1">Yes</td>
</tr>
<tr>
<td colspan="1">character_set</td>
<td colspan="3">Set of symbols and encodings. The default character set is <code>utf8</code>.</td>
<td colspan="1">No</td>
</tr>
<tr>
<td colspan="1">collate</td>
<td colspan="3">Set of rules for comparing characters in a character set. The default value for collate is <code>utf8_general_ci</code>.</td>
<td colspan="1">No</td>
</tr>
</tbody>
</table>
<para>See the MySQL documentation for information about supported character sets and collations at <link
xlink:href="http://dev.mysql.com/doc/refman/5.1/en/charset-mysql.html"
>http://dev.mysql.com/doc/refman/5.1/en/charset-mysql.html</link>.</para>
<para>Refer to the following tables for information about characters that are valid/invalid for creating database names.</para>
<table rules="all" width="40%">
<caption>Valid Characters That Can Be Used in a Database Name</caption>
<col width="100%"/>
<thead>
<tr>
<td>Character</td>
</tr>
</thead>
<tbody>
<tr>
<td>Letters (upper and lower cases allowed)</td>
</tr>
<tr>
<td>Numbers</td>
</tr>
<tr>
<td>'@', '?', '#', and spaces are allowed, but <emphasis>not</emphasis> at the beginning and end of the database name</td>
</tr>
<tr>
<td>"_" is allowed anywhere in the database name</td>
</tr>
</tbody>
</table>
<table rules="all" width="40%">
<?dbfo keep-together="always"?>
<caption>Characters That <emphasis>Cannot</emphasis> Be Used in a Database Name</caption>
<col width="100%"/>
<thead>
<tr>
<td>Character</td>
</tr>
</thead>
<tbody>
<tr>
<td>Single quotes</td>
</tr>
<tr>
<td>Double quotes</td>
</tr>
<tr>
<td>Back quotes</td>
</tr>
<tr>
<td>Semicolons</td>
</tr>
<tr>
<td>Commas</td>
</tr>
<tr>
<td>Backslashes</td>
</tr>
<tr>
<td>Forwardslashes</td>
</tr>
</tbody>
</table>
<table rules="all">
<caption>Length Restrictions for Database Name</caption>
<thead>
<tr>
<td>Restriction</td>
<td>Value</td>
</tr>
</thead>
<tbody>
<tr>
<td>Database-name maximum length</td>
<td>64</td>
</tr>
</tbody>
</table>
</wadl:doc>
<request>
<representation mediaType="application/xml"
element="dbaas:Database" >
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Create Database requests:<?rax-fo keep-with-next?></para>
<xsdxt:code href="../apidocs/src/resources/samples/db-create-databases-request.xml"/>
</doc>
</representation>
<representation mediaType="application/json"
element="dbaas:Database" >
<doc>
<xsdxt:code href="../apidocs/src/resources/samples/db-create-databases-request.json"/>
</doc>
</representation>
</request>
<response status="202" >
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Create Database responses:</para>
<xsdxt:code href="../apidocs/src/resources/samples/db-create-databases-response.xml"/>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<xsdxt:code href="../apidocs/src/resources/samples/db-create-databases-response.json"/>
</doc>
</representation>
</response>
&commonFaults;
&getFaults;
</method>
<method name="GET" id="getDatabases">
<wadl:doc xml:lang="EN" title="List Databases for Instance" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Lists databases for the specified instance.</para>
<para>This operation lists the databases for the specified instance.</para>
<note>This operation returns only the user-defined databases, not the system databases. The system databases (mysql, information_schema, lost+found) can only be viewed by a database administrator.</note>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List Databases for Instance requests:</para>
<xsdxt:code href="../apidocs/src/resources/samples/db-list-databases-request.xml"/>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<xsdxt:code href="../apidocs/src/resources/samples/db-list-databases-request.json"/>
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml"
element="dbaas:Databases" >
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List Databases for Instance responses:</para>
<xsdxt:code href="../apidocs/src/resources/samples/db-list-databases-response.xml"/>
</doc>
</representation>
<representation mediaType="application/json"
element="dbaas:Databases" >
<doc>
<xsdxt:code href="../apidocs/src/resources/samples/db-list-databases-response.json"/>
</doc>
</representation>
</response>
&commonFaults;
&getFaults;
</method>
<method name="DELETE" id="deleteDatabase">
<wadl:doc xml:lang="EN" title="Delete Database" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Deletes the specified database.</para>
<para>This operation deletes the requested database within the specified database instance. Note that all data associated with the database is also deleted.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Delete Database requests:</para>
<xsdxt:code href="../apidocs/src/resources/samples/db-delete-databases-request.xml"/>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<xsdxt:code href="../apidocs/src/resources/samples/db-delete-databases-request.json"/>
</doc>
</representation>
</request>
<response status="202" >
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Delete Database responses:</para>
<xsdxt:code href="../apidocs/src/resources/samples/db-delete-databases-response.xml"/>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<xsdxt:code href="../apidocs/src/resources/samples/db-delete-databases-response.json"/>
</doc>
</representation>
</response>
&commonFaults;
&getFaults;
</method>
<!-- User -->
<method name="POST" id="createUser">
<wadl:doc xml:lang="EN" title="Create User" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Creates a user for the specified database instance.</para>
<para>This operation asynchronously provisions a new user for the specified database instance based on the configuration defined in the request object. Once the request is validated and progress has started on the provisioning process, a 202 Accepted response object is returned.</para>
<remark>Writer: please add the following note back into the doc once the List User Details call is added back into the API: Using the identifier, the caller can check on the progress of the operation by performing a GET on users/name (for more details on this operation see the "List User Details" section of this document).</remark>
<para>If the corresponding request cannot be fulfilled due to insufficient or invalid data, an HTTP 400 "Bad Request" error response is returned with information regarding the nature of the failure. Failures in the validation process are non-recoverable and require the caller to correct the cause of the failure and POST the request again.</para>
<para>The following table lists the required attributes for Create User. Refer to the request examples for the required xml/json format:</para>
<table rules="all" width="500">
<caption>Required Attributes for Create User</caption>
<thead>
<tr>
<td colspan="1">Applies To</td>
<td colspan="1">Name </td>
<td colspan="2">Description</td>
<td colspan="1">Required</td>
</tr>
</thead>
<tbody>
<tr>
<td colspan="1" rowspan="3">User</td>
<td colspan="1">name</td>
<td colspan="2">Name of the user for the
database.</td>
<td colspan="1">Yes</td>
</tr>
<tr>
<td colspan="1">password</td>
<td colspan="2">User password for database
access.</td>
<td colspan="1">Yes</td>
</tr>
<tr>
<td colspan="1">(database) name</td>
<td colspan="2"><para>Name of the database that the user can access. One or more database names must be specified.</para></td>
<td colspan="1">No</td>
</tr>
</tbody>
</table>
<note>A user is granted all privileges on the specified databases.</note>
<para>Refer to the following tables for information about characters that are valid/invalid for creating database names, user names, and passwords.</para>
<table rules="all" width="40%">
<caption>Valid Characters That Can Be Used in a Database Name, User Name, and Password</caption>
<col width="100%"/>
<thead>
<tr>
<td>Character</td>
</tr>
</thead>
<tbody>
<tr>
<td>Letters (upper and lower cases allowed)</td>
</tr>
<tr>
<td>Numbers</td>
</tr>
<tr>
<td>'@', '?', '#', and spaces are allowed, but <emphasis>not</emphasis> at the beginning and end of the database name, user name, and password</td>
</tr>
<tr>
<td>"_" is allowed anywhere in the database name, user name, and password</td>
</tr>
</tbody>
</table>
<table rules="all" width="40%">
<caption>Characters That <emphasis>Cannot</emphasis> Be Used in a Database Name, User Name, and Password</caption>
<col width="100%"/>
<thead>
<tr>
<td>Character</td>
</tr>
</thead>
<tbody>
<tr>
<td>Single quotes</td>
</tr>
<tr>
<td>Double quotes</td>
</tr>
<tr>
<td>Back quotes</td>
</tr>
<tr>
<td>Semicolons</td>
</tr>
<tr>
<td>Commas</td>
</tr>
<tr>
<td>Backslashes</td>
</tr>
<tr>
<td>Forwardslashes</td>
</tr>
<tr>
<td>Spaces at the front or end of the user name or password</td>
</tr>
</tbody>
</table>
<table rules="all">
<caption>Length Restrictions for Database Name, User Name, and Password</caption>
<thead>
<tr>
<td>Restriction</td>
<td>Value</td>
</tr>
</thead>
<tbody>
<tr>
<td>Database name maximum length</td>
<td>64</td>
</tr>
<tr>
<td>User name maximum length</td>
<td>16</td>
</tr>
<tr>
<td>Password maximum length</td>
<td>unlimited (no restrictions)</td>
</tr>
</tbody>
</table>
</wadl:doc>
<request>
<representation mediaType="application/xml"
element="dbaas:Users" >
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Create User requests:</para>
<xsdxt:code href="../apidocs/src/resources/samples/db-create-users-request.xml"/>
</doc>
</representation>
<representation mediaType="application/json" >
<doc>
<xsdxt:code href="../apidocs/src/resources/samples/db-create-users-request.json"/>
</doc>
</representation>
</request>
<response status="202" >
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the Create User responses:</para>
<xsdxt:code href="../apidocs/src/resources/samples/db-create-users-response.xml"/>
</doc>
</representation>
<representation mediaType="application/json" >
<doc>
<xsdxt:code href="../apidocs/src/resources/samples/db-create-users-response.json"/>
</doc>
</representation>
</response>
&commonFaults;
&getFaults;
</method>
<method name="GET" id="getUsers">
<wadl:doc xml:lang="EN" title="List Users in Database Instance" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Lists the users in the specified database instance.</para>
<para>This operation lists the users in the specified database instance, along with the associated databases for that user. </para>
<note>This operation does not return the system users (database administrators that administer the health of the database). Also, this operation returns the "root" user only if "root" user has been enabled.</note>
<para>The following notes apply to MySQL users:</para>
<itemizedlist spacing="compact">
<listitem>
<para>User names can be up to 16 characters long.</para>
</listitem>
<listitem>
<para>When you create accounts with INSERT, you must use FLUSH PRIVILEGES to tell the server to reload the grant tables.</para>
</listitem>
<listitem>
<para>For additional information, refer to: <link
xlink:href="http://dev.mysql.com/doc/refman/5.1/en/user-account-management.html"
>http://dev.mysql.com/doc/refman/5.1/en/user-account-management.html</link></para>
</listitem>
</itemizedlist>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<doc>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List Users in Database Instance requests:</para>
<xsdxt:code href="../apidocs/src/resources/samples/db-list-users-request.xml"/>
</doc>
</representation>
<representation mediaType="application/json">
<doc>
<xsdxt:code href="../apidocs/src/resources/samples/db-list-users-request.json"/>
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml"
element="dbaas:Users" >
<doc>
<?hard-pagebreak?>
<para xmlns="http://docbook.org/ns/docbook">The following examples show the List Users in Database Instance responses:</para>
<xsdxt:code href="../apidocs/src/resources/samples/db-list-users-response.xml"/>
</doc>
</representation>
<representation mediaType="application/json"
element="dbaas:Users" >
<doc>
<xsdxt:code href="../apidocs/src/resources/samples/db-list-users-response.json"/>
</doc>
</representation>
</response>
&commonFaults;
&getFaults;