blob: d8a81aa1e9cbe7dd18fbe430a8afb36db1c88e7e [file] [log] [blame]
Craig Citroe633be12015-03-02 13:40:36 -08001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070075<h1><a href="sqladmin_v1beta4.html">Cloud SQL Admin API</a> . <a href="sqladmin_v1beta4.backupRuns.html">backupRuns</a></h1>
Craig Citroe633be12015-03-02 13:40:36 -080076<h2>Instance Methods</h2>
77<p class="toc_element">
Takashi Matsuo06694102015-09-11 13:55:40 -070078 <code><a href="#delete">delete(project, instance, id)</a></code></p>
79<p class="firstline">Deletes the backup taken by a backup run.</p>
80<p class="toc_element">
Craig Citroe633be12015-03-02 13:40:36 -080081 <code><a href="#get">get(project, instance, id)</a></code></p>
82<p class="firstline">Retrieves a resource containing information about a backup run.</p>
83<p class="toc_element">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -070084 <code><a href="#insert">insert(project, instance, body)</a></code></p>
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -070085<p class="firstline">Creates a new backup run on demand. This method is applicable only to Second Generation instances.</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -070086<p class="toc_element">
Craig Citroe633be12015-03-02 13:40:36 -080087 <code><a href="#list">list(project, instance, maxResults=None, pageToken=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070088<p class="firstline">Lists all backup runs associated with a given instance and configuration in the reverse chronological order of the backup initiation time.</p>
Craig Citroe633be12015-03-02 13:40:36 -080089<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<h3>Method Details</h3>
93<div class="method">
Takashi Matsuo06694102015-09-11 13:55:40 -070094 <code class="details" id="delete">delete(project, instance, id)</code>
95 <pre>Deletes the backup taken by a backup run.
96
97Args:
98 project: string, Project ID of the project that contains the instance. (required)
99 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800100 id: string, The ID of the Backup Run to delete. To find a Backup Run ID, use the list method. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700101
102Returns:
103 An object of the form:
104
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700105 { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700106 "status": "A String", # The status of an operation. Valid values are PENDING, RUNNING, DONE, UNKNOWN.
107 "importContext": { # Database instance import context. # The context for import operation, if applicable.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400108 "kind": "sql#importContext", # This is always sql#importContext.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700109 "database": "A String", # The target database for the import. If fileType is SQL, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If fileType is CSV, one database must be specified.
Takashi Matsuo06694102015-09-11 13:55:40 -0700110 "fileType": "A String", # The file type for the specified uri.
111 # SQL: The file contains SQL statements.
112 # CSV: The file contains CSV data.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700113 "uri": "A String", # Path to the import file in Cloud Storage, in the form gs://bucketName/fileName. Compressed gzip files (.gz) are supported when fileType is SQL. The instance must have write permissions to the bucket and read access to the file.
114 "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
Takashi Matsuo06694102015-09-11 13:55:40 -0700115 "csvImportOptions": { # Options for importing data as CSV.
116 "table": "A String", # The table to which CSV data is imported.
117 "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
118 "A String",
119 ],
120 },
121 },
122 "kind": "sql#operation", # This is always sql#operation.
123 "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
124 "exportContext": { # Database instance export context. # The context for export operation, if applicable.
125 "kind": "sql#exportContext", # This is always sql#exportContext.
126 "fileType": "A String", # The file type for the specified uri.
127 # SQL: The file contains SQL statements.
128 # CSV: The file contains CSV data.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700129 "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the requests succeeds, but the operation fails. If fileType is SQL and the filename ends with .gz, the contents are compressed.
Takashi Matsuo06694102015-09-11 13:55:40 -0700130 "csvExportOptions": { # Options for exporting data as CSV.
131 "selectQuery": "A String", # The select query used to extract the data.
132 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700133 "databases": [ # Databases to be exported.
134 # MySQL instances: If fileType is SQL and no database is specified, all databases are exported, except for the mysql system database. If fileType is CSV, you can specify one database, either by using this property or by using the csvExportOptions.selectQuery property, which takes precedence over this property.
135 # PostgreSQL instances: Specify exactly one database to be exported. If fileType is CSV, this database must match the database used in the csvExportOptions.selectQuery property.
Takashi Matsuo06694102015-09-11 13:55:40 -0700136 "A String",
137 ],
138 "sqlExportOptions": { # Options for exporting data as SQL statements.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700139 "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.
Takashi Matsuo06694102015-09-11 13:55:40 -0700140 "A String",
141 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700142 "mysqlExportOptions": { # Options for exporting from MySQL.
143 "masterData": 42, # Option to include SQL statement required to set up replication. If set to 1, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates. If set to 2, the CHANGE MASTER TO statement is written as a SQL comment, and has no effect. All other values are ignored.
144 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800145 "schemaOnly": True or False, # Export only schemas.
Takashi Matsuo06694102015-09-11 13:55:40 -0700146 },
147 },
148 "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
149 "targetProject": "A String", # The project ID of the target instance related to this operation.
150 "targetId": "A String", # Name of the database instance related to this operation.
151 "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400152 "targetLink": "A String",
Takashi Matsuo06694102015-09-11 13:55:40 -0700153 "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
154 "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
155 "kind": "sql#operationErrors", # This is always sql#operationErrors.
156 "errors": [ # The list of errors encountered while processing this operation.
157 { # Database instance operation error.
158 "kind": "sql#operationError", # This is always sql#operationError.
159 "code": "A String", # Identifies the specific error that occurred.
160 "message": "A String", # Additional information about the error encountered.
161 },
162 ],
163 },
164 "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
165 "selfLink": "A String", # The URI of this resource.
166 "user": "A String", # The email address of the user who initiated this operation.
167 }</pre>
168</div>
169
170<div class="method">
Craig Citroe633be12015-03-02 13:40:36 -0800171 <code class="details" id="get">get(project, instance, id)</code>
172 <pre>Retrieves a resource containing information about a backup run.
173
174Args:
175 project: string, Project ID of the project that contains the instance. (required)
176 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
177 id: string, The ID of this Backup Run. (required)
178
179Returns:
180 An object of the form:
181
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700182 { # A BackupRun resource.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700183 "status": "A String", # The status of this run.
184 "kind": "sql#backupRun", # This is always sql#backupRun.
185 "description": "A String", # The description of this run, only applicable to on-demand backups.
186 "windowStartTime": "A String", # The start time of the backup window during which this the backup was attempted in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
187 "enqueuedTime": "A String", # The time the run was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
188 "instance": "A String", # Name of the database instance.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700189 "location": "A String", # The location of the backup.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700190 "startTime": "A String", # The time the backup operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
191 "error": { # Database instance operation error. # Information about why the backup operation failed. This is only present if the run has the FAILED status.
192 "kind": "sql#operationError", # This is always sql#operationError.
193 "code": "A String", # Identifies the specific error that occurred.
194 "message": "A String", # Additional information about the error encountered.
195 },
196 "endTime": "A String", # The time the backup operation completed in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
197 "type": "A String", # The type of this run; can be either "AUTOMATED" or "ON_DEMAND".
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700198 "id": "A String", # The identifier for this backup run. Unique only for a specific Cloud SQL instance.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700199 "selfLink": "A String", # The URI of this resource.
200 }</pre>
201</div>
202
203<div class="method">
204 <code class="details" id="insert">insert(project, instance, body)</code>
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700205 <pre>Creates a new backup run on demand. This method is applicable only to Second Generation instances.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700206
207Args:
208 project: string, Project ID of the project that contains the instance. (required)
209 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
210 body: object, The request body. (required)
211 The object takes the form of:
212
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700213{ # A BackupRun resource.
Craig Citroe633be12015-03-02 13:40:36 -0800214 "status": "A String", # The status of this run.
215 "kind": "sql#backupRun", # This is always sql#backupRun.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700216 "description": "A String", # The description of this run, only applicable to on-demand backups.
Craig Citroe633be12015-03-02 13:40:36 -0800217 "windowStartTime": "A String", # The start time of the backup window during which this the backup was attempted in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
218 "enqueuedTime": "A String", # The time the run was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
219 "instance": "A String", # Name of the database instance.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700220 "location": "A String", # The location of the backup.
Craig Citroe633be12015-03-02 13:40:36 -0800221 "startTime": "A String", # The time the backup operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
222 "error": { # Database instance operation error. # Information about why the backup operation failed. This is only present if the run has the FAILED status.
223 "kind": "sql#operationError", # This is always sql#operationError.
224 "code": "A String", # Identifies the specific error that occurred.
225 "message": "A String", # Additional information about the error encountered.
226 },
227 "endTime": "A String", # The time the backup operation completed in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700228 "type": "A String", # The type of this run; can be either "AUTOMATED" or "ON_DEMAND".
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700229 "id": "A String", # The identifier for this backup run. Unique only for a specific Cloud SQL instance.
Craig Citroe633be12015-03-02 13:40:36 -0800230 "selfLink": "A String", # The URI of this resource.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700231 }
232
233
234Returns:
235 An object of the form:
236
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700237 { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700238 "status": "A String", # The status of an operation. Valid values are PENDING, RUNNING, DONE, UNKNOWN.
239 "importContext": { # Database instance import context. # The context for import operation, if applicable.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400240 "kind": "sql#importContext", # This is always sql#importContext.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700241 "database": "A String", # The target database for the import. If fileType is SQL, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If fileType is CSV, one database must be specified.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700242 "fileType": "A String", # The file type for the specified uri.
243 # SQL: The file contains SQL statements.
244 # CSV: The file contains CSV data.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700245 "uri": "A String", # Path to the import file in Cloud Storage, in the form gs://bucketName/fileName. Compressed gzip files (.gz) are supported when fileType is SQL. The instance must have write permissions to the bucket and read access to the file.
246 "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700247 "csvImportOptions": { # Options for importing data as CSV.
248 "table": "A String", # The table to which CSV data is imported.
249 "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
250 "A String",
251 ],
252 },
253 },
254 "kind": "sql#operation", # This is always sql#operation.
255 "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
256 "exportContext": { # Database instance export context. # The context for export operation, if applicable.
257 "kind": "sql#exportContext", # This is always sql#exportContext.
258 "fileType": "A String", # The file type for the specified uri.
259 # SQL: The file contains SQL statements.
260 # CSV: The file contains CSV data.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700261 "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the requests succeeds, but the operation fails. If fileType is SQL and the filename ends with .gz, the contents are compressed.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700262 "csvExportOptions": { # Options for exporting data as CSV.
263 "selectQuery": "A String", # The select query used to extract the data.
264 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700265 "databases": [ # Databases to be exported.
266 # MySQL instances: If fileType is SQL and no database is specified, all databases are exported, except for the mysql system database. If fileType is CSV, you can specify one database, either by using this property or by using the csvExportOptions.selectQuery property, which takes precedence over this property.
267 # PostgreSQL instances: Specify exactly one database to be exported. If fileType is CSV, this database must match the database used in the csvExportOptions.selectQuery property.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700268 "A String",
269 ],
270 "sqlExportOptions": { # Options for exporting data as SQL statements.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700271 "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700272 "A String",
273 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700274 "mysqlExportOptions": { # Options for exporting from MySQL.
275 "masterData": 42, # Option to include SQL statement required to set up replication. If set to 1, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates. If set to 2, the CHANGE MASTER TO statement is written as a SQL comment, and has no effect. All other values are ignored.
276 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700277 "schemaOnly": True or False, # Export only schemas.
278 },
279 },
280 "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
281 "targetProject": "A String", # The project ID of the target instance related to this operation.
282 "targetId": "A String", # Name of the database instance related to this operation.
283 "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400284 "targetLink": "A String",
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700285 "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
286 "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
287 "kind": "sql#operationErrors", # This is always sql#operationErrors.
288 "errors": [ # The list of errors encountered while processing this operation.
289 { # Database instance operation error.
290 "kind": "sql#operationError", # This is always sql#operationError.
291 "code": "A String", # Identifies the specific error that occurred.
292 "message": "A String", # Additional information about the error encountered.
293 },
294 ],
295 },
296 "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
297 "selfLink": "A String", # The URI of this resource.
298 "user": "A String", # The email address of the user who initiated this operation.
Craig Citroe633be12015-03-02 13:40:36 -0800299 }</pre>
300</div>
301
302<div class="method">
303 <code class="details" id="list">list(project, instance, maxResults=None, pageToken=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700304 <pre>Lists all backup runs associated with a given instance and configuration in the reverse chronological order of the backup initiation time.
Craig Citroe633be12015-03-02 13:40:36 -0800305
306Args:
307 project: string, Project ID of the project that contains the instance. (required)
308 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
309 maxResults: integer, Maximum number of backup runs per response.
310 pageToken: string, A previously-returned page token representing part of the larger set of results to view.
311
312Returns:
313 An object of the form:
314
315 { # Backup run list results.
316 "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
317 "items": [ # A list of backup runs in reverse chronological order of the enqueued time.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700318 { # A BackupRun resource.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700319 "status": "A String", # The status of this run.
320 "kind": "sql#backupRun", # This is always sql#backupRun.
321 "description": "A String", # The description of this run, only applicable to on-demand backups.
322 "windowStartTime": "A String", # The start time of the backup window during which this the backup was attempted in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
323 "enqueuedTime": "A String", # The time the run was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
324 "instance": "A String", # Name of the database instance.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700325 "location": "A String", # The location of the backup.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700326 "startTime": "A String", # The time the backup operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
327 "error": { # Database instance operation error. # Information about why the backup operation failed. This is only present if the run has the FAILED status.
328 "kind": "sql#operationError", # This is always sql#operationError.
329 "code": "A String", # Identifies the specific error that occurred.
330 "message": "A String", # Additional information about the error encountered.
331 },
332 "endTime": "A String", # The time the backup operation completed in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
333 "type": "A String", # The type of this run; can be either "AUTOMATED" or "ON_DEMAND".
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700334 "id": "A String", # The identifier for this backup run. Unique only for a specific Cloud SQL instance.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700335 "selfLink": "A String", # The URI of this resource.
Craig Citroe633be12015-03-02 13:40:36 -0800336 },
Craig Citroe633be12015-03-02 13:40:36 -0800337 ],
338 "kind": "sql#backupRunsList", # This is always sql#backupRunsList.
339 }</pre>
340</div>
341
342<div class="method">
343 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
344 <pre>Retrieves the next page of results.
345
346Args:
347 previous_request: The request for the previous page. (required)
348 previous_response: The response from the request for the previous page. (required)
349
350Returns:
351 A request object that you can call 'execute()' on to request the next
352 page. Returns None if there are no more items in the collection.
353 </pre>
354</div>
355
356</body></html>