Browse Source

API doc: 'access' support for creating trove instance

Story: 2006500
Task: 36471
Change-Id: Ie0c4ead89316001107c02450627eb5491ff8b521
changes/72/681372/6
Lingxian Kong 1 week ago
parent
commit
94dd0bd2b7

+ 11
- 11
api-ref/source/backups.inc View File

@@ -10,7 +10,7 @@ List, show details, create and delete backups.
10 10
 List database backups
11 11
 ~~~~~~~~~~~~~~~~~~~~~
12 12
 
13
-.. rest_method::  GET /v1.0/{accountId}/backups
13
+.. rest_method::  GET /v1.0/{project_id}/backups
14 14
 
15 15
 List all database backups information for a project. You can filter results by
16 16
 using query string parameters. The following filters are supported:
@@ -32,7 +32,7 @@ Request
32 32
 
33 33
 .. rest_parameters:: parameters.yaml
34 34
 
35
-   - accountId: accountId
35
+   - project_id: project_id
36 36
 
37 37
 
38 38
 Response Parameters
@@ -69,10 +69,10 @@ Response Example
69 69
 List database backups for an instance
70 70
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
71 71
 
72
-.. rest_method::  GET /v1.0/{accountId}/instances/{instanceId}/backups
72
+.. rest_method::  GET /v1.0/{project_id}/instances/{instanceId}/backups
73 73
 
74 74
 List all database backups for the specified instance. This is equivalent to
75
-``GET /v1.0/{accountId}/backups?instance_id={instanceId}``.
75
+``GET /v1.0/{project_id}/backups?instance_id={instanceId}``.
76 76
 
77 77
 Normal response codes: 200
78 78
 
@@ -87,7 +87,7 @@ Request
87 87
 .. rest_parameters:: parameters.yaml
88 88
 
89 89
    - instanceId: instanceId
90
-   - accountId: accountId
90
+   - project_id: project_id
91 91
 
92 92
 
93 93
 Response Parameters
@@ -124,7 +124,7 @@ Response Example
124 124
 Show database backup details
125 125
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
126 126
 
127
-.. rest_method::  GET /v1.0/{accountId}/backups/{backupId}
127
+.. rest_method::  GET /v1.0/{project_id}/backups/{backupId}
128 128
 
129 129
 Show detailes of a backup.
130 130
 
@@ -140,7 +140,7 @@ Request
140 140
 
141 141
 .. rest_parameters:: parameters.yaml
142 142
 
143
-   - accountId: accountId
143
+   - project_id: project_id
144 144
    - backupId: backup_id
145 145
 
146 146
 
@@ -177,7 +177,7 @@ Response Example
177 177
 Create database backup
178 178
 ~~~~~~~~~~~~~~~~~~~~~~
179 179
 
180
-.. rest_method::  POST /v1.0/{accountId}/backups
180
+.. rest_method::  POST /v1.0/{project_id}/backups
181 181
 
182 182
 Creates a database backup for instance.
183 183
 
@@ -198,7 +198,7 @@ Request
198 198
    - parent_id: backup_parentId
199 199
    - incremental: backup_incremental
200 200
    - description: backup_description
201
-   - accountId: accountId
201
+   - project_id: project_id
202 202
 
203 203
 
204 204
 Request Example
@@ -241,7 +241,7 @@ Response Example
241 241
 Delete database backup
242 242
 ~~~~~~~~~~~~~~~~~~~~~~
243 243
 
244
-.. rest_method::  DELETE /v1.0/{accountId}/backups/{backupId}
244
+.. rest_method::  DELETE /v1.0/{project_id}/backups/{backupId}
245 245
 
246 246
 Deletes a database backup.
247 247
 
@@ -258,4 +258,4 @@ Request
258 258
 .. rest_parameters:: parameters.yaml
259 259
 
260 260
    - backupId: backup_id
261
-   - accountId: accountId
261
+   - project_id: project_id

+ 14
- 14
api-ref/source/configurations.inc View File

@@ -10,7 +10,7 @@ Creates and lists all configuration groups.
10 10
 Create configuration group
11 11
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
12 12
 
13
-.. rest_method::  POST /v1.0/{accountId}/configurations
13
+.. rest_method::  POST /v1.0/{project_id}/configurations
14 14
 
15 15
 Creates a configuration group.
16 16
 
@@ -29,7 +29,7 @@ Request
29 29
    - datastore: datastore
30 30
    - values: values
31 31
    - name: name
32
-   - accountId: accountId
32
+   - project_id: project_id
33 33
 
34 34
 
35 35
 Request Example
@@ -51,7 +51,7 @@ Response Example
51 51
 List configuration groups
52 52
 ~~~~~~~~~~~~~~~~~~~~~~~~~
53 53
 
54
-.. rest_method::  GET /v1.0/{accountId}/configurations
54
+.. rest_method::  GET /v1.0/{project_id}/configurations
55 55
 
56 56
 Lists all configuration groups.
57 57
 
@@ -70,7 +70,7 @@ Request
70 70
 
71 71
 .. rest_parameters:: parameters.yaml
72 72
 
73
-   - accountId: accountId
73
+   - project_id: project_id
74 74
 
75 75
 
76 76
 Response Example
@@ -85,7 +85,7 @@ Response Example
85 85
 List configuration group instances
86 86
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
87 87
 
88
-.. rest_method::  GET /v1.0/{accountId}/configurations/{configId}/instances
88
+.. rest_method::  GET /v1.0/{project_id}/configurations/{configId}/instances
89 89
 
90 90
 Lists the instances associated with the specified configuration group.
91 91
 
@@ -102,7 +102,7 @@ Request
102 102
 .. rest_parameters:: parameters.yaml
103 103
 
104 104
    - configId: configId
105
-   - accountId: accountId
105
+   - project_id: project_id
106 106
 
107 107
 
108 108
 Response Example
@@ -117,7 +117,7 @@ Response Example
117 117
 Delete configuration group
118 118
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
119 119
 
120
-.. rest_method::  DELETE /v1.0/{accountId}/configurations/{configId}
120
+.. rest_method::  DELETE /v1.0/{project_id}/configurations/{configId}
121 121
 
122 122
 Deletes a configuration group.
123 123
 
@@ -134,7 +134,7 @@ Request
134 134
 .. rest_parameters:: parameters.yaml
135 135
 
136 136
    - configId: configId
137
-   - accountId: accountId
137
+   - project_id: project_id
138 138
 
139 139
 
140 140
 
@@ -142,7 +142,7 @@ Request
142 142
 Patch configuration group
143 143
 ~~~~~~~~~~~~~~~~~~~~~~~~~
144 144
 
145
-.. rest_method::  PATCH /v1.0/{accountId}/configurations/{configId}
145
+.. rest_method::  PATCH /v1.0/{project_id}/configurations/{configId}
146 146
 
147 147
 Sets new values for a configuration group.
148 148
 
@@ -160,7 +160,7 @@ Request
160 160
 
161 161
    - values: values
162 162
    - configId: configId
163
-   - accountId: accountId
163
+   - project_id: project_id
164 164
 
165 165
 
166 166
 Request Example
@@ -182,7 +182,7 @@ Response Example
182 182
 Show configuration group details
183 183
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
184 184
 
185
-.. rest_method::  GET /v1.0/{accountId}/configurations/{configId}
185
+.. rest_method::  GET /v1.0/{project_id}/configurations/{configId}
186 186
 
187 187
 Lists details about a configuration group, including its values.
188 188
 
@@ -199,7 +199,7 @@ Request
199 199
 .. rest_parameters:: parameters.yaml
200 200
 
201 201
    - configId: configId
202
-   - accountId: accountId
202
+   - project_id: project_id
203 203
 
204 204
 
205 205
 Response Example
@@ -214,7 +214,7 @@ Response Example
214 214
 Update configuration group
215 215
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
216 216
 
217
-.. rest_method::  PUT /v1.0/{accountId}/configurations/{configId}
217
+.. rest_method::  PUT /v1.0/{project_id}/configurations/{configId}
218 218
 
219 219
 Sets new values for a configuration group. Also lets you change the name and
220 220
 description of the configuration group.
@@ -234,7 +234,7 @@ Request
234 234
    - description: description
235 235
    - name: name
236 236
    - configId: configId
237
-   - accountId: accountId
237
+   - project_id: project_id
238 238
 
239 239
 
240 240
 Request Example

+ 10
- 10
api-ref/source/database-instance-actions.inc View File

@@ -10,7 +10,7 @@ Resizes instances and volumes and restarts instances.
10 10
 Restart instance
11 11
 ~~~~~~~~~~~~~~~~
12 12
 
13
-.. rest_method::  POST /v1.0/{accountId}/instances/{instanceId}/action
13
+.. rest_method::  POST /v1.0/{project_id}/instances/{instanceId}/action
14 14
 
15 15
 Restarts the database service for an instance.
16 16
 
@@ -34,7 +34,7 @@ Request
34 34
 .. rest_parameters:: parameters.yaml
35 35
 
36 36
    - instanceId: instanceId
37
-   - accountId: accountId
37
+   - project_id: project_id
38 38
 
39 39
 
40 40
 Request Example
@@ -49,7 +49,7 @@ Request Example
49 49
 Resize instance
50 50
 ~~~~~~~~~~~~~~~
51 51
 
52
-.. rest_method::  POST /v1.0/{accountId}/instances/{instanceId}/action
52
+.. rest_method::  POST /v1.0/{project_id}/instances/{instanceId}/action
53 53
 
54 54
 Resizes the memory for an instance.
55 55
 
@@ -70,7 +70,7 @@ Request
70 70
 .. rest_parameters:: parameters.yaml
71 71
 
72 72
    - instanceId: instanceId
73
-   - accountId: accountId
73
+   - project_id: project_id
74 74
 
75 75
 
76 76
 Request Example
@@ -85,7 +85,7 @@ Request Example
85 85
 Resize instance volume
86 86
 ~~~~~~~~~~~~~~~~~~~~~~
87 87
 
88
-.. rest_method::  POST /v1.0/{accountId}/instances/{instanceId}/action
88
+.. rest_method::  POST /v1.0/{project_id}/instances/{instanceId}/action
89 89
 
90 90
 Resizes the volume that is attached to an instance.
91 91
 
@@ -109,7 +109,7 @@ Request
109 109
 .. rest_parameters:: parameters.yaml
110 110
 
111 111
    - instanceId: instanceId
112
-   - accountId: accountId
112
+   - project_id: project_id
113 113
 
114 114
 
115 115
 Request Example
@@ -124,7 +124,7 @@ Request Example
124 124
 Promote instance to replica source
125 125
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
126 126
 
127
-.. rest_method::  POST /v1.0/{accountId}/instances/{instanceId}/action
127
+.. rest_method::  POST /v1.0/{project_id}/instances/{instanceId}/action
128 128
 
129 129
 Promotes a replica.
130 130
 
@@ -158,7 +158,7 @@ Request
158 158
 .. rest_parameters:: parameters.yaml
159 159
 
160 160
    - instanceId: instanceId
161
-   - accountId: accountId
161
+   - project_id: project_id
162 162
 
163 163
 
164 164
 Request Example
@@ -173,7 +173,7 @@ Request Example
173 173
 Delete replication base instance
174 174
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
175 175
 
176
-.. rest_method::  POST /v1.0/{accountId}/instances/{instanceId}/action
176
+.. rest_method::  POST /v1.0/{project_id}/instances/{instanceId}/action
177 177
 
178 178
 Deletes the base instance in a replication set.
179 179
 
@@ -211,7 +211,7 @@ Request
211 211
 .. rest_parameters:: parameters.yaml
212 212
 
213 213
    - instanceId: instanceId
214
-   - accountId: accountId
214
+   - project_id: project_id
215 215
 
216 216
 
217 217
 Request Example

+ 12
- 12
api-ref/source/database-instance-logs.inc View File

@@ -10,7 +10,7 @@ List, show details, enable, disable, publish, and discard logs for instances.
10 10
 List instance logs
11 11
 ~~~~~~~~~~~~~~~~~~
12 12
 
13
-.. rest_method:: GET /v1.0/{accountId}/instances/{instanceId}/log
13
+.. rest_method:: GET /v1.0/{project_id}/instances/{instanceId}/log
14 14
 
15 15
 Listing all logs for an instance.
16 16
 
@@ -32,7 +32,7 @@ Request
32 32
 .. rest_parameters:: parameters.yaml
33 33
 
34 34
    - instanceId: instanceId
35
-   - accountId: accountId
35
+   - project_id: project_id
36 36
 
37 37
 
38 38
 Response Parameters
@@ -63,7 +63,7 @@ Response Example
63 63
 Show instance log details
64 64
 ~~~~~~~~~~~~~~~~~~~~~~~~~
65 65
 
66
-.. rest_method:: POST /v1.0/{accountId}/instances/{instanceId}/log
66
+.. rest_method:: POST /v1.0/{project_id}/instances/{instanceId}/log
67 67
 
68 68
 Show details for a instance log.
69 69
 
@@ -81,7 +81,7 @@ Request
81 81
 .. rest_parameters:: parameters.yaml
82 82
 
83 83
    - instanceId: instanceId
84
-   - accountId: accountId
84
+   - project_id: project_id
85 85
    - name: log_name
86 86
 
87 87
 
@@ -120,7 +120,7 @@ Response Example
120 120
 Enable instance log
121 121
 ~~~~~~~~~~~~~~~~~~~
122 122
 
123
-.. rest_method:: POST /v1.0/{accountId}/instances/{instanceId}/log
123
+.. rest_method:: POST /v1.0/{project_id}/instances/{instanceId}/log
124 124
 
125 125
 Enable a log type for a instance.
126 126
 
@@ -138,7 +138,7 @@ Request
138 138
 .. rest_parameters:: parameters.yaml
139 139
 
140 140
    - instanceId: instanceId
141
-   - accountId: accountId
141
+   - project_id: project_id
142 142
    - name: log_name
143 143
    - enable: log_enable_action
144 144
 
@@ -178,7 +178,7 @@ Response Example
178 178
 Disable instance log
179 179
 ~~~~~~~~~~~~~~~~~~~~
180 180
 
181
-.. rest_method:: POST /v1.0/{accountId}/instances/{instanceId}/log
181
+.. rest_method:: POST /v1.0/{project_id}/instances/{instanceId}/log
182 182
 
183 183
 Disable a log type for a instance.
184 184
 
@@ -196,7 +196,7 @@ Request
196 196
 .. rest_parameters:: parameters.yaml
197 197
 
198 198
    - instanceId: instanceId
199
-   - accountId: accountId
199
+   - project_id: project_id
200 200
    - name: log_name
201 201
    - disable: log_disable_action
202 202
 
@@ -236,7 +236,7 @@ Response Example
236 236
 Publish instance log
237 237
 ~~~~~~~~~~~~~~~~~~~~
238 238
 
239
-.. rest_method:: POST /v1.0/{accountId}/instances/{instanceId}/log
239
+.. rest_method:: POST /v1.0/{project_id}/instances/{instanceId}/log
240 240
 
241 241
 Publish a log type for a instance.
242 242
 
@@ -256,7 +256,7 @@ Request
256 256
 .. rest_parameters:: parameters.yaml
257 257
 
258 258
    - instanceId: instanceId
259
-   - accountId: accountId
259
+   - project_id: project_id
260 260
    - name: log_name
261 261
    - publish: log_publish_action
262 262
 
@@ -296,7 +296,7 @@ Response Example
296 296
 Discard instance log
297 297
 ~~~~~~~~~~~~~~~~~~~~
298 298
 
299
-.. rest_method:: POST /v1.0/{accountId}/instances/{instanceId}/log
299
+.. rest_method:: POST /v1.0/{project_id}/instances/{instanceId}/log
300 300
 
301 301
 Discard all previously published logs for a instance.
302 302
 
@@ -314,7 +314,7 @@ Request
314 314
 .. rest_parameters:: parameters.yaml
315 315
 
316 316
    - instanceId: instanceId
317
-   - accountId: accountId
317
+   - project_id: project_id
318 318
    - name: log_name
319 319
    - discard: log_discard_action
320 320
 

+ 57
- 63
api-ref/source/database-instances.inc View File

@@ -13,7 +13,7 @@ root is enabled, for instances.
13 13
 List database instances
14 14
 ~~~~~~~~~~~~~~~~~~~~~~~
15 15
 
16
-.. rest_method::  GET /v1.0/{accountId}/instances
16
+.. rest_method::  GET /v1.0/{project_id}/instances
17 17
 
18 18
 Lists information, including status, for all database instances.
19 19
 
@@ -31,7 +31,7 @@ Request
31 31
 
32 32
 .. rest_parameters:: parameters.yaml
33 33
 
34
-   - accountId: accountId
34
+   - project_id: project_id
35 35
 
36 36
 
37 37
 Response Example
@@ -46,7 +46,7 @@ Response Example
46 46
 Show database instance details
47 47
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
48 48
 
49
-.. rest_method::  GET /v1.0/{accountId}/instances/{instanceId}
49
+.. rest_method::  GET /v1.0/{project_id}/instances/{instanceId}
50 50
 
51 51
 Shows database instance details.
52 52
 
@@ -82,7 +82,7 @@ Request
82 82
 .. rest_parameters:: parameters.yaml
83 83
 
84 84
    - instanceId: instanceId
85
-   - accountId: accountId
85
+   - project_id: project_id
86 86
 
87 87
 
88 88
 Response Example
@@ -97,24 +97,15 @@ Response Example
97 97
 Create database instance
98 98
 ~~~~~~~~~~~~~~~~~~~~~~~~
99 99
 
100
-.. rest_method::  POST /v1.0/{accountId}/instances
100
+.. rest_method::  POST /v1.0/{project_id}/instances
101 101
 
102 102
 Creates a database instance.
103 103
 
104
-Asynchronously provisions a database instance. You must specify a
105
-flavor and a volume size. The service provisions the instance with
106
-a volume of the requested size, which serves as storage for the
107
-database instance.
108
-
109
- **Notes**
110
-
111
-- You can create only one database instance per POST request.
112
-
113
-- You can create a database instance with one or more databases. You
114
-  can also associate users with each database.
115
-
116
-- The port on which the database instance is listening is database
117
-  specific.
104
+Asynchronously provisions a database instance. You must specify a flavor ID, a
105
+volume size and the tenant network ID. The service provisions the instance with
106
+a volume of the requested size, which serves as storage for the database
107
+instance. The database service can only be access within the tenant network,
108
+unless the ``access`` parameter is defined.
118 109
 
119 110
 Normal response codes: 200
120 111
 
@@ -128,36 +119,39 @@ Request
128 119
 
129 120
 .. rest_parameters:: parameters.yaml
130 121
 
131
-   - users: users
132
-   - users.name: user_name1
133
-   - users.password: user_password
134
-   - users.host: user_host
135
-   - users.databases: user_databases
136
-   - users.databases.name: user_database_name
137
-   - datastore: datastore1
138
-   - datastore.type: datastore_type
139
-   - datastore.version: datastore_version
140
-   - name: instanceName1
141
-   - flavorRef: flavorRef
142
-   - volume: volume
143
-   - volume.size: volume_size
144
-   - volume.type: volume_type
145
-   - modules: modules
146
-   - modules.id: module_id
147
-   - restorePoint: restore_point
148
-   - restorePoint.backupRef: restore_point_backupref
149
-   - availability_zone: availability_zone
150
-   - nics: nics
151
-   - replica_of: replica_of
152
-   - replica_count: replica_count
153
-   - locality: locality
154
-   - region_name: region_name
155
-   - databases: databases
156
-   - databases.characterSet: characterSet
157
-   - databases.collate: collate
158
-   - instance: instance
159
-   - configuration: configuration
160
-   - accountId: accountId
122
+    - project_id: project_id
123
+    - users: users
124
+    - users.name: user_name1
125
+    - users.password: user_password
126
+    - users.host: user_host
127
+    - users.databases: user_databases
128
+    - users.databases.name: user_database_name
129
+    - datastore: datastore1
130
+    - datastore.type: datastore_type
131
+    - datastore.version: datastore_version
132
+    - name: instanceName1
133
+    - flavorRef: flavorRef
134
+    - volume: volume
135
+    - volume.size: volume_size
136
+    - volume.type: volume_type
137
+    - modules: modules
138
+    - modules.id: module_id
139
+    - restorePoint: restore_point
140
+    - restorePoint.backupRef: restore_point_backupref
141
+    - availability_zone: availability_zone
142
+    - nics: nics
143
+    - replica_of: replica_of
144
+    - replica_count: replica_count
145
+    - locality: locality
146
+    - region_name: region_name
147
+    - databases: databases
148
+    - databases.characterSet: characterSet
149
+    - databases.collate: collate
150
+    - instance: instance
151
+    - configuration: configuration
152
+    - access: access
153
+    - access.is_public: access_is_public
154
+    - access.allowed_cidrs: access_allowed_cidrs
161 155
 
162 156
 
163 157
 Request Example
@@ -233,7 +227,7 @@ Response Example
233 227
 Attach configuration group
234 228
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
235 229
 
236
-.. rest_method::  PUT /v1.0/{accountId}/instances/{instanceId}
230
+.. rest_method::  PUT /v1.0/{project_id}/instances/{instanceId}
237 231
 
238 232
 Attaches a configuration group to an instance.
239 233
 
@@ -252,7 +246,7 @@ Request
252 246
 
253 247
    - configuration: configuration
254 248
    - instanceId: instanceId
255
-   - accountId: accountId
249
+   - project_id: project_id
256 250
 
257 251
 
258 252
 Request Example
@@ -267,7 +261,7 @@ Request Example
267 261
 Detach configuration group
268 262
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
269 263
 
270
-.. rest_method::  PUT /v1.0/{accountId}/instances/{instanceId}
264
+.. rest_method::  PUT /v1.0/{project_id}/instances/{instanceId}
271 265
 
272 266
 Detaches a configuration group from an instance.
273 267
 
@@ -290,7 +284,7 @@ Request
290 284
 
291 285
    - configuration: configuration
292 286
    - instanceId: instanceId
293
-   - accountId: accountId
287
+   - project_id: project_id
294 288
 
295 289
 Request Example
296 290
 ---------------
@@ -304,7 +298,7 @@ Request Example
304 298
 Detach replica
305 299
 ~~~~~~~~~~~~~~
306 300
 
307
-.. rest_method::  PATCH /v1.0/{accountId}/instances/{instanceId}
301
+.. rest_method::  PATCH /v1.0/{project_id}/instances/{instanceId}
308 302
 
309 303
 Detaches a replica from its replication source.
310 304
 
@@ -331,7 +325,7 @@ Request
331 325
    - replica_of: replica_of
332 326
    - slave_of: slave_of
333 327
    - instanceId: instanceId
334
-   - accountId: accountId
328
+   - project_id: project_id
335 329
 
336 330
 
337 331
 Request Example
@@ -346,7 +340,7 @@ Request Example
346 340
 Update instance name
347 341
 ~~~~~~~~~~~~~~~~~~~~
348 342
 
349
-.. rest_method::  PATCH /v1.0/{accountId}/instances/{instanceId}
343
+.. rest_method::  PATCH /v1.0/{project_id}/instances/{instanceId}
350 344
 
351 345
 Update the instance name.
352 346
 
@@ -366,7 +360,7 @@ Request
366 360
    - instance: instance
367 361
    - name: instanceName
368 362
    - instanceId: instanceId
369
-   - accountId: accountId
363
+   - project_id: project_id
370 364
 
371 365
 
372 366
 Request Example
@@ -381,7 +375,7 @@ Request Example
381 375
 Upgrade datastore version
382 376
 ~~~~~~~~~~~~~~~~~~~~~~~~~
383 377
 
384
-.. rest_method::  PATCH /v1.0/{accountId}/instances/{instanceId}
378
+.. rest_method::  PATCH /v1.0/{project_id}/instances/{instanceId}
385 379
 
386 380
 Upgrade datastore version.
387 381
 
@@ -405,7 +399,7 @@ Request
405 399
    - instance: instance
406 400
    - datastore_version: datastore_version
407 401
    - instanceId: instanceId
408
-   - accountId: accountId
402
+   - project_id: project_id
409 403
 
410 404
 
411 405
 Request Example
@@ -420,7 +414,7 @@ Request Example
420 414
 Delete database instance
421 415
 ~~~~~~~~~~~~~~~~~~~~~~~~
422 416
 
423
-.. rest_method::  DELETE /v1.0/{accountId}/instances/{instanceId}
417
+.. rest_method::  DELETE /v1.0/{project_id}/instances/{instanceId}
424 418
 
425 419
 Deletes a database instance, including any associated data.
426 420
 
@@ -442,7 +436,7 @@ Request
442 436
 .. rest_parameters:: parameters.yaml
443 437
 
444 438
    - instanceId: instanceId
445
-   - accountId: accountId
439
+   - project_id: project_id
446 440
 
447 441
 
448 442
 
@@ -450,7 +444,7 @@ Request
450 444
 List configuration defaults
451 445
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
452 446
 
453
-.. rest_method::  GET /v1.0/{accountId}/instances/{instanceId}/configuration
447
+.. rest_method::  GET /v1.0/{project_id}/instances/{instanceId}/configuration
454 448
 
455 449
 Lists the configuration defaults for an instance.
456 450
 
@@ -467,7 +461,7 @@ Request
467 461
 .. rest_parameters:: parameters.yaml
468 462
 
469 463
    - instanceId: instanceId
470
-   - accountId: accountId
464
+   - project_id: project_id
471 465
 
472 466
 
473 467
 Response Example

+ 6
- 6
api-ref/source/databases.inc View File

@@ -10,7 +10,7 @@ Creates, lists all, and deletes databases.
10 10
 Delete database
11 11
 ~~~~~~~~~~~~~~~
12 12
 
13
-.. rest_method::  DELETE /v1.0/{accountId}/instances/{instanceId}/databases/{databaseName}
13
+.. rest_method::  DELETE /v1.0/{project_id}/instances/{instanceId}/databases/{databaseName}
14 14
 
15 15
 Deletes a database.
16 16
 
@@ -31,7 +31,7 @@ Request
31 31
 
32 32
    - instanceId: instanceId
33 33
    - databaseName: databaseName
34
-   - accountId: accountId
34
+   - project_id: project_id
35 35
 
36 36
 
37 37
 
@@ -39,7 +39,7 @@ Request
39 39
 Create database
40 40
 ~~~~~~~~~~~~~~~
41 41
 
42
-.. rest_method::  POST /v1.0/{accountId}/instances/{instanceId}/databases
42
+.. rest_method::  POST /v1.0/{project_id}/instances/{instanceId}/databases
43 43
 
44 44
 Creates a database within an instance.
45 45
 
@@ -59,7 +59,7 @@ Request
59 59
    - collate: collate
60 60
    - name: name
61 61
    - instanceId: instanceId
62
-   - accountId: accountId
62
+   - project_id: project_id
63 63
 
64 64
 
65 65
 Request Example
@@ -74,7 +74,7 @@ Request Example
74 74
 List instance databases
75 75
 ~~~~~~~~~~~~~~~~~~~~~~~
76 76
 
77
-.. rest_method::  GET /v1.0/{accountId}/instances/{instanceId}/databases
77
+.. rest_method::  GET /v1.0/{project_id}/instances/{instanceId}/databases
78 78
 
79 79
 Lists databases for an instance.
80 80
 
@@ -96,7 +96,7 @@ Request
96 96
 .. rest_parameters:: parameters.yaml
97 97
 
98 98
    - instanceId: instanceId
99
-   - accountId: accountId
99
+   - project_id: project_id
100 100
 
101 101
 
102 102
 Response Example

+ 6
- 6
api-ref/source/datastores.inc View File

@@ -11,7 +11,7 @@ shows parameter details for a data store version.
11 11
 Show configuration parameter details
12 12
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
13 13
 
14
-.. rest_method::  GET /v1.0/{accountId}/datastores/versions/{datastore_version_id}/parameters/{parameter_name}
14
+.. rest_method::  GET /v1.0/{project_id}/datastores/versions/{datastore_version_id}/parameters/{parameter_name}
15 15
 
16 16
 Displays details for a configuration parameter associated with a data store
17 17
 version.
@@ -33,7 +33,7 @@ Request
33 33
 
34 34
    - parameter_name: parameter_name
35 35
    - datastore_version_id: datastore_version_id
36
-   - accountId: accountId
36
+   - project_id: project_id
37 37
 
38 38
 
39 39
 Response Example
@@ -48,7 +48,7 @@ Response Example
48 48
 List datastore versions
49 49
 ~~~~~~~~~~~~~~~~~~~~~~~
50 50
 
51
-.. rest_method::  GET /v1.0/{accountId}/datastores/{datastore_name}/versions
51
+.. rest_method::  GET /v1.0/{project_id}/datastores/{datastore_name}/versions
52 52
 
53 53
 Lists the available versions of a data store.
54 54
 
@@ -65,7 +65,7 @@ Request
65 65
 .. rest_parameters:: parameters.yaml
66 66
 
67 67
    - datastore_name: datastore_name
68
-   - accountId: accountId
68
+   - project_id: project_id
69 69
 
70 70
 
71 71
 Response Example
@@ -80,7 +80,7 @@ Response Example
80 80
 List configuration parameters
81 81
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
82 82
 
83
-.. rest_method::  GET /v1.0/{accountId}/datastores/versions/{datastore_version_id}/parameters
83
+.. rest_method::  GET /v1.0/{project_id}/datastores/versions/{datastore_version_id}/parameters
84 84
 
85 85
 Lists the available configuration parameters for a data store version.
86 86
 
@@ -101,7 +101,7 @@ Request
101 101
 .. rest_parameters:: parameters.yaml
102 102
 
103 103
    - datastore_version_id: datastore_version_id
104
-   - accountId: accountId
104
+   - project_id: project_id
105 105
 
106 106
 
107 107
 Response Example

+ 27
- 7
api-ref/source/parameters.yaml View File

@@ -1,10 +1,4 @@
1 1
 # variables in path
2
-accountId:
3
-  description: |
4
-    The account ID of the owner of the instance.
5
-  in: path
6
-  required: false
7
-  type: string
8 2
 backup_id:
9 3
   description: |
10 4
     The ID of the backup.
@@ -54,6 +48,12 @@ parameter_name:
54 48
   in: path
55 49
   required: false
56 50
   type: string
51
+project_id:
52
+  description: |
53
+    The project ID of the instance owner.
54
+  in: path
55
+  required: true
56
+  type: string
57 57
 user_name:
58 58
   description: |
59 59
       The name of the user.
@@ -61,6 +61,26 @@ user_name:
61 61
   required: false
62 62
   type: string
63 63
 # variables in body
64
+access:
65
+  description: |
66
+    A ``access`` object defines how the database service is exposed.
67
+  in: body
68
+  required: false
69
+  type: object
70
+access_allowed_cidrs:
71
+  description: |
72
+    A list of IPv4, IPv6 or mix of both CIDRs that restrict access to the
73
+    database service. ``0.0.0.0/0`` is used by default if this parameter is not
74
+    provided.
75
+  in: body
76
+  required: false
77
+  type: array
78
+access_is_public:
79
+  description: |
80
+    Whether the database service is exposed to the public.
81
+  in: body
82
+  required: false
83
+  type: boolean
64 84
 availability_zone:
65 85
   description: |
66 86
     The availability zone of the instance.
@@ -582,7 +602,7 @@ nics:
582 602
   description: |
583 603
      Network interfaces for database service inside Nova instances.
584 604
      ``NOTE:`` For backward compatibility, this parameter uses the same schema
585
-     as novaclient creating servers, but only ``net-id`` is supported ans can
605
+     as novaclient creating servers, but only ``net-id`` is supported and can
586 606
      only be specified once. This parameter is required in service tenant
587 607
      deployment model.
588 608
   in: body

+ 32
- 25
api-ref/source/samples/db-create-instance-request.json View File

@@ -1,30 +1,37 @@
1 1
 {
2
-    "instance": {
2
+  "instance": {
3
+    "name": "test",
4
+    "flavorRef": 1,
5
+    "volume": {"size": 2},
6
+    "nics": [{"net-id": "a5330d7d-0e8c-48b4-9f6c-0f2c4ab1b854"}],
7
+    "datastore": {
8
+      "type": "mysql",
9
+      "version": "5.7"
10
+    },
11
+    "databases": [
12
+      {
13
+        "character_set": "utf8",
14
+        "collate": "utf8_general_ci",
15
+        "name": "sampledb"
16
+      },
17
+      {
18
+        "name": "nextround"
19
+      }
20
+    ],
21
+    "users": [
22
+      {
3 23
         "databases": [
4
-            {
5
-                "character_set": "utf8",
6
-                "collate": "utf8_general_ci",
7
-                "name": "sampledb"
8
-            },
9
-            {
10
-                "name": "nextround"
11
-            }
24
+          {
25
+              "name": "sampledb"
26
+          }
12 27
         ],
13
-        "flavorRef": 1,
14
-        "name": "json_rack_instance",
15
-        "users": [
16
-            {
17
-                "databases": [
18
-                    {
19
-                        "name": "sampledb"
20
-                    }
21
-                ],
22
-                "name": "demouser",
23
-                "password": "demopassword"
24
-            }
25
-        ],
26
-        "volume": {
27
-            "size": 2
28
-        }
28
+        "name": "demouser",
29
+        "password": "demopassword"
30
+      }
31
+    ],
32
+    "access": {
33
+      "is_public": true,
34
+      "allowed_cidrs": ["202.78.240.0/24"]
29 35
     }
36
+  }
30 37
 }

+ 12
- 12
api-ref/source/user-management.inc View File

@@ -10,7 +10,7 @@ Creates, lists all, and deletes users.
10 10
 Enable root user
11 11
 ~~~~~~~~~~~~~~~~
12 12
 
13
-.. rest_method::  POST /v1.0/{accountId}/instances/{instanceId}/root
13
+.. rest_method::  POST /v1.0/{project_id}/instances/{instanceId}/root
14 14
 
15 15
 Enables the root user for a database instance and returns the root password.
16 16
 
@@ -38,7 +38,7 @@ Request
38 38
 .. rest_parameters:: parameters.yaml
39 39
 
40 40
    - instanceId: instanceId
41
-   - accountId: accountId
41
+   - project_id: project_id
42 42
 
43 43
 
44 44
 Response Example
@@ -53,7 +53,7 @@ Response Example
53 53
 Show root-enabled status for database instance
54 54
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
55 55
 
56
-.. rest_method::  GET /v1.0/{accountId}/instances/{instanceId}/root
56
+.. rest_method::  GET /v1.0/{project_id}/instances/{instanceId}/root
57 57
 
58 58
 Shows root-enabled status for a database instance.
59 59
 
@@ -73,7 +73,7 @@ Request
73 73
 .. rest_parameters:: parameters.yaml
74 74
 
75 75
    - instanceId: instanceId
76
-   - accountId: accountId
76
+   - project_id: project_id
77 77
 
78 78
 
79 79
 Response Example
@@ -88,7 +88,7 @@ Response Example
88 88
 Disable root user
89 89
 ~~~~~~~~~~~~~~~~~
90 90
 
91
-.. rest_method::  DELETE /v1.0/{accountId}/instances/{instanceId}/root
91
+.. rest_method::  DELETE /v1.0/{project_id}/instances/{instanceId}/root
92 92
 
93 93
 Disables the root user.
94 94
 
@@ -105,7 +105,7 @@ Request
105 105
 .. rest_parameters:: parameters.yaml
106 106
 
107 107
    - instanceId: instanceId
108
-   - accountId: accountId
108
+   - project_id: project_id
109 109
 
110 110
 
111 111
 
@@ -113,7 +113,7 @@ Request
113 113
 Delete user
114 114
 ~~~~~~~~~~~
115 115
 
116
-.. rest_method::  DELETE /v1.0/{accountId}/instances/{instanceId}/users/{name}
116
+.. rest_method::  DELETE /v1.0/{project_id}/instances/{instanceId}/users/{name}
117 117
 
118 118
 Deletes a user for a database instance.
119 119
 
@@ -130,7 +130,7 @@ Request
130 130
 .. rest_parameters:: parameters.yaml
131 131
 
132 132
    - instanceId: instanceId
133
-   - accountId: accountId
133
+   - project_id: project_id
134 134
    - name: user_name
135 135
 
136 136
 
@@ -139,7 +139,7 @@ Request
139 139
 Create user
140 140
 ~~~~~~~~~~~
141 141
 
142
-.. rest_method::  POST /v1.0/{accountId}/instances/{instanceId}/users
142
+.. rest_method::  POST /v1.0/{project_id}/instances/{instanceId}/users
143 143
 
144 144
 Creates a user for a database instance.
145 145
 
@@ -244,7 +244,7 @@ Request
244 244
 .. rest_parameters:: parameters.yaml
245 245
 
246 246
    - instanceId: instanceId
247
-   - accountId: accountId
247
+   - project_id: project_id
248 248
 
249 249
 Request Example
250 250
 ---------------
@@ -258,7 +258,7 @@ Request Example
258 258
 List database instance users
259 259
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
260 260
 
261
-.. rest_method::  GET /v1.0/{accountId}/instances/{instanceId}/users
261
+.. rest_method::  GET /v1.0/{project_id}/instances/{instanceId}/users
262 262
 
263 263
 Lists the users in a database instance and the associated databases for that
264 264
 user.
@@ -293,7 +293,7 @@ Request
293 293
 .. rest_parameters:: parameters.yaml
294 294
 
295 295
    - instanceId: instanceId
296
-   - accountId: accountId
296
+   - project_id: project_id
297 297
 
298 298
 
299 299
 Response Example

Loading…
Cancel
Save