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
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="sqladmin_v1beta4.html">Cloud SQL Admin API</a> . <a href="sqladmin_v1beta4.sslCerts.html">sslCerts</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#createEphemeral">createEphemeral(project, instance, body)</a></code></p>
<p class="firstline">Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance. Users may use the certificate to authenticate as themselves when connecting to the database.</p>
<p class="toc_element">
<code><a href="#delete">delete(project, instance, sha1Fingerprint)</a></code></p>
<p class="firstline">Deletes the SSL certificate. For First Generation instances, the certificate remains valid until the instance is restarted.</p>
<p class="toc_element">
<code><a href="#get">get(project, instance, sha1Fingerprint)</a></code></p>
<p class="firstline">Retrieves a particular SSL certificate. Does not include the private key (required for usage). The private key must be saved from the response to initial creation.</p>
<p class="toc_element">
<code><a href="#insert">insert(project, instance, body)</a></code></p>
<p class="firstline">Creates an SSL certificate and returns it along with the private key and server certificate authority. The new certificate will not be usable until the instance is restarted.</p>
<p class="toc_element">
<code><a href="#list">list(project, instance)</a></code></p>
<p class="firstline">Lists all of the current SSL certificates for the instance.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="createEphemeral">createEphemeral(project, instance, body)</code>
<pre>Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance. Users may use the certificate to authenticate as themselves when connecting to the database.
Args:
project: string, Project ID of the Cloud SQL project. (required)
instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
body: object, The request body. (required)
The object takes the form of:
{ # SslCerts create ephemeral certificate request.
"public_key": "A String", # PEM encoded public key to include in the signed certificate.
}
Returns:
An object of the form:
{ # SslCerts Resource
"certSerialNumber": "A String", # Serial number, as extracted from the certificate.
"kind": "sql#sslCert", # This is always sql#sslCert.
"sha1Fingerprint": "A String", # Sha1 Fingerprint.
"commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
"instance": "A String", # Name of the database instance.
"cert": "A String", # PEM representation.
"expirationTime": "A String", # The time when the certificate expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
"createTime": "A String", # The time when the certificate was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z
"selfLink": "A String", # The URI of this resource.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(project, instance, sha1Fingerprint)</code>
<pre>Deletes the SSL certificate. For First Generation instances, the certificate remains valid until the instance is restarted.
Args:
project: string, Project ID of the project that contains the instance. (required)
instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
sha1Fingerprint: string, Sha1 FingerPrint. (required)
Returns:
An object of the form:
{ # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.
"status": "A String", # The status of an operation. Valid values are PENDING, RUNNING, DONE, UNKNOWN.
"importContext": { # Database instance import context. # The context for import operation, if applicable.
"kind": "sql#importContext", # This is always sql#importContext.
"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.
"fileType": "A String", # The file type for the specified uri.
# SQL: The file contains SQL statements.
# CSV: The file contains CSV data.
"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.
"importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
"csvImportOptions": { # Options for importing data as CSV.
"table": "A String", # The table to which CSV data is imported.
"columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
"A String",
],
},
},
"kind": "sql#operation", # This is always sql#operation.
"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.
"exportContext": { # Database instance export context. # The context for export operation, if applicable.
"kind": "sql#exportContext", # This is always sql#exportContext.
"fileType": "A String", # The file type for the specified uri.
# SQL: The file contains SQL statements.
# CSV: The file contains CSV data.
"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.
"csvExportOptions": { # Options for exporting data as CSV.
"selectQuery": "A String", # The select query used to extract the data.
},
"databases": [ # Databases to be exported.
# 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.
# 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.
"A String",
],
"sqlExportOptions": { # Options for exporting data as SQL statements.
"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.
"A String",
],
"mysqlExportOptions": { # Options for exporting from MySQL.
"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.
},
"schemaOnly": True or False, # Export only schemas.
},
},
"startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
"targetProject": "A String", # The project ID of the target instance related to this operation.
"targetId": "A String", # Name of the database instance related to this operation.
"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 .
"targetLink": "A String",
"insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
"kind": "sql#operationErrors", # This is always sql#operationErrors.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
"kind": "sql#operationError", # This is always sql#operationError.
"code": "A String", # Identifies the specific error that occurred.
"message": "A String", # Additional information about the error encountered.
},
],
},
"endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
"selfLink": "A String", # The URI of this resource.
"user": "A String", # The email address of the user who initiated this operation.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(project, instance, sha1Fingerprint)</code>
<pre>Retrieves a particular SSL certificate. Does not include the private key (required for usage). The private key must be saved from the response to initial creation.
Args:
project: string, Project ID of the project that contains the instance. (required)
instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
sha1Fingerprint: string, Sha1 FingerPrint. (required)
Returns:
An object of the form:
{ # SslCerts Resource
"certSerialNumber": "A String", # Serial number, as extracted from the certificate.
"kind": "sql#sslCert", # This is always sql#sslCert.
"sha1Fingerprint": "A String", # Sha1 Fingerprint.
"commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
"instance": "A String", # Name of the database instance.
"cert": "A String", # PEM representation.
"expirationTime": "A String", # The time when the certificate expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
"createTime": "A String", # The time when the certificate was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z
"selfLink": "A String", # The URI of this resource.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(project, instance, body)</code>
<pre>Creates an SSL certificate and returns it along with the private key and server certificate authority. The new certificate will not be usable until the instance is restarted.
Args:
project: string, Project ID of the project that contains the instance. (required)
instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
body: object, The request body. (required)
The object takes the form of:
{ # SslCerts insert request.
"commonName": "A String", # User supplied name. Must be a distinct name from the other certificates for this instance.
}
Returns:
An object of the form:
{ # SslCert insert response.
"kind": "sql#sslCertsInsert", # This is always sql#sslCertsInsert.
"clientCert": { # SslCertDetail. # The new client certificate and private key. For First Generation instances, the new certificate does not take effect until the instance is restarted.
"certPrivateKey": "A String", # The private key for the client cert, in pem format. Keep private in order to protect your security.
"certInfo": { # SslCerts Resource # The public information about the cert.
"certSerialNumber": "A String", # Serial number, as extracted from the certificate.
"kind": "sql#sslCert", # This is always sql#sslCert.
"sha1Fingerprint": "A String", # Sha1 Fingerprint.
"commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
"instance": "A String", # Name of the database instance.
"cert": "A String", # PEM representation.
"expirationTime": "A String", # The time when the certificate expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
"createTime": "A String", # The time when the certificate was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z
"selfLink": "A String", # The URI of this resource.
},
},
"operation": { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. # The operation to track the ssl certs insert request.
"status": "A String", # The status of an operation. Valid values are PENDING, RUNNING, DONE, UNKNOWN.
"importContext": { # Database instance import context. # The context for import operation, if applicable.
"kind": "sql#importContext", # This is always sql#importContext.
"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.
"fileType": "A String", # The file type for the specified uri.
# SQL: The file contains SQL statements.
# CSV: The file contains CSV data.
"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.
"importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
"csvImportOptions": { # Options for importing data as CSV.
"table": "A String", # The table to which CSV data is imported.
"columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
"A String",
],
},
},
"kind": "sql#operation", # This is always sql#operation.
"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.
"exportContext": { # Database instance export context. # The context for export operation, if applicable.
"kind": "sql#exportContext", # This is always sql#exportContext.
"fileType": "A String", # The file type for the specified uri.
# SQL: The file contains SQL statements.
# CSV: The file contains CSV data.
"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.
"csvExportOptions": { # Options for exporting data as CSV.
"selectQuery": "A String", # The select query used to extract the data.
},
"databases": [ # Databases to be exported.
# 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.
# 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.
"A String",
],
"sqlExportOptions": { # Options for exporting data as SQL statements.
"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.
"A String",
],
"mysqlExportOptions": { # Options for exporting from MySQL.
"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.
},
"schemaOnly": True or False, # Export only schemas.
},
},
"startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
"targetProject": "A String", # The project ID of the target instance related to this operation.
"targetId": "A String", # Name of the database instance related to this operation.
"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 .
"targetLink": "A String",
"insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
"kind": "sql#operationErrors", # This is always sql#operationErrors.
"errors": [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
"kind": "sql#operationError", # This is always sql#operationError.
"code": "A String", # Identifies the specific error that occurred.
"message": "A String", # Additional information about the error encountered.
},
],
},
"endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
"selfLink": "A String", # The URI of this resource.
"user": "A String", # The email address of the user who initiated this operation.
},
"serverCaCert": { # SslCerts Resource # The server Certificate Authority's certificate. If this is missing you can force a new one to be generated by calling resetSslConfig method on instances resource.
"certSerialNumber": "A String", # Serial number, as extracted from the certificate.
"kind": "sql#sslCert", # This is always sql#sslCert.
"sha1Fingerprint": "A String", # Sha1 Fingerprint.
"commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
"instance": "A String", # Name of the database instance.
"cert": "A String", # PEM representation.
"expirationTime": "A String", # The time when the certificate expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
"createTime": "A String", # The time when the certificate was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z
"selfLink": "A String", # The URI of this resource.
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(project, instance)</code>
<pre>Lists all of the current SSL certificates for the instance.
Args:
project: string, Project ID of the project that contains the instance. (required)
instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
Returns:
An object of the form:
{ # SslCerts list response.
"items": [ # List of client certificates for the instance.
{ # SslCerts Resource
"certSerialNumber": "A String", # Serial number, as extracted from the certificate.
"kind": "sql#sslCert", # This is always sql#sslCert.
"sha1Fingerprint": "A String", # Sha1 Fingerprint.
"commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
"instance": "A String", # Name of the database instance.
"cert": "A String", # PEM representation.
"expirationTime": "A String", # The time when the certificate expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
"createTime": "A String", # The time when the certificate was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z
"selfLink": "A String", # The URI of this resource.
},
],
"kind": "sql#sslCertsList", # This is always sql#sslCertsList.
}</pre>
</div>
</body></html>
|
