blob: d10972d9376ae99feb6cadfce9958d697336518e [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.sslCerts.html">sslCerts</a></h1>
Craig Citroe633be12015-03-02 13:40:36 -080076<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070078 <code><a href="#createEphemeral">createEphemeral(project, instance, body=None, x__xgafv=None)</a></code></p>
79<p class="firstline">Generates a short-lived X509 certificate containing the provided public key</p>
Takashi Matsuo06694102015-09-11 13:55:40 -070080<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070081 <code><a href="#delete">delete(project, instance, sha1Fingerprint, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes the SSL certificate. For First Generation instances, the</p>
Craig Citroe633be12015-03-02 13:40:36 -080083<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070084 <code><a href="#get">get(project, instance, sha1Fingerprint, x__xgafv=None)</a></code></p>
85<p class="firstline">Retrieves a particular SSL certificate. Does not include the private key</p>
Craig Citroe633be12015-03-02 13:40:36 -080086<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070087 <code><a href="#insert">insert(project, instance, body=None, x__xgafv=None)</a></code></p>
88<p class="firstline">Creates an SSL certificate and returns it along with the private key and</p>
Craig Citroe633be12015-03-02 13:40:36 -080089<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070090 <code><a href="#list">list(project, instance, x__xgafv=None)</a></code></p>
Craig Citroe633be12015-03-02 13:40:36 -080091<p class="firstline">Lists all of the current SSL certificates for the instance.</p>
92<h3>Method Details</h3>
93<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -070094 <code class="details" id="createEphemeral">createEphemeral(project, instance, body=None, x__xgafv=None)</code>
95 <pre>Generates a short-lived X509 certificate containing the provided public key
96and signed by a private key specific to the target instance. Users may use
97the certificate to authenticate as themselves when connecting to the
98database.
Takashi Matsuo06694102015-09-11 13:55:40 -070099
100Args:
101 project: string, Project ID of the Cloud SQL project. (required)
102 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700103 body: object, The request body.
Takashi Matsuo06694102015-09-11 13:55:40 -0700104 The object takes the form of:
105
106{ # SslCerts create ephemeral certificate request.
Bu Sun Kim65020912020-05-20 12:08:20 -0700107 &quot;public_key&quot;: &quot;A String&quot;, # PEM encoded public key to include in the signed certificate.
Takashi Matsuo06694102015-09-11 13:55:40 -0700108 }
109
Dan O'Mearadd494642020-05-01 07:42:23 -0700110 x__xgafv: string, V1 error format.
111 Allowed values
112 1 - v1 error format
113 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700114
115Returns:
116 An object of the form:
117
118 { # SslCerts Resource
Bu Sun Kim65020912020-05-20 12:08:20 -0700119 &quot;sha1Fingerprint&quot;: &quot;A String&quot;, # Sha1 Fingerprint.
120 &quot;certSerialNumber&quot;: &quot;A String&quot;, # Serial number, as extracted from the certificate.
121 &quot;cert&quot;: &quot;A String&quot;, # PEM representation.
122 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#sslCert&lt;/code&gt;.
123 &quot;commonName&quot;: &quot;A String&quot;, # User supplied name. Constrained to [a-zA-Z.-_ ]+.
124 &quot;createTime&quot;: &quot;A String&quot;, # The time when the certificate was created in &lt;a
125 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
Dan O'Mearadd494642020-05-01 07:42:23 -0700126 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;
Bu Sun Kim65020912020-05-20 12:08:20 -0700127 &quot;instance&quot;: &quot;A String&quot;, # Name of the database instance.
128 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
129 &quot;expirationTime&quot;: &quot;A String&quot;, # The time when the certificate expires in &lt;a
130 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
131 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
Takashi Matsuo06694102015-09-11 13:55:40 -0700132 }</pre>
133</div>
134
135<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700136 <code class="details" id="delete">delete(project, instance, sha1Fingerprint, x__xgafv=None)</code>
137 <pre>Deletes the SSL certificate. For First Generation instances, the
138certificate remains valid until the instance is restarted.
Craig Citroe633be12015-03-02 13:40:36 -0800139
140Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700141 project: string, Project ID of the project that contains the instance. (required)
Craig Citroe633be12015-03-02 13:40:36 -0800142 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
143 sha1Fingerprint: string, Sha1 FingerPrint. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700144 x__xgafv: string, V1 error format.
145 Allowed values
146 1 - v1 error format
147 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800148
149Returns:
150 An object of the form:
151
Dan O'Mearadd494642020-05-01 07:42:23 -0700152 { # An Operation resource.&amp;nbsp;For successful operations that return an
153 # Operation resource, only the fields relevant to the operation are populated
154 # in the resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700155 &quot;endTime&quot;: &quot;A String&quot;, # The time this operation finished in UTC timezone in &lt;a
156 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
157 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
158 &quot;startTime&quot;: &quot;A String&quot;, # The time this operation actually started in UTC timezone in &lt;a
159 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
160 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
161 &quot;insertTime&quot;: &quot;A String&quot;, # The time this operation was enqueued in UTC timezone in &lt;a
162 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
163 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
164 &quot;user&quot;: &quot;A String&quot;, # The email address of the user who initiated this operation.
165 &quot;targetProject&quot;: &quot;A String&quot;, # The project ID of the target instance related to this operation.
166 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
167 &quot;targetLink&quot;: &quot;A String&quot;,
168 &quot;operationType&quot;: &quot;A String&quot;, # The type of the operation. Valid values are &lt;code&gt;CREATE&lt;/code&gt;,
169 # &lt;code&gt;DELETE&lt;/code&gt;, &lt;code&gt;UPDATE&lt;/code&gt;, &lt;code&gt;RESTART&lt;/code&gt;,
170 # &lt;code&gt;IMPORT&lt;/code&gt;, &lt;code&gt;EXPORT&lt;/code&gt;, &lt;code&gt;BACKUP_VOLUME&lt;/code&gt;,
171 # &lt;code&gt;RESTORE_VOLUME&lt;/code&gt;, &lt;code&gt;CREATE_USER&lt;/code&gt;,
172 # &lt;code&gt;DELETE_USER&lt;/code&gt;, &lt;code&gt;CREATE_DATABASE&lt;/code&gt;,
173 # &lt;code&gt;DELETE_DATABASE&lt;/code&gt; .
174 &quot;error&quot;: { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be
175 # populated.
176 &quot;errors&quot;: [ # The list of errors encountered while processing this operation.
177 { # Database instance operation error.
178 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operationError&lt;/code&gt;.
179 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
180 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
Dan O'Mearadd494642020-05-01 07:42:23 -0700181 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700182 ],
183 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operationErrors&lt;/code&gt;.
184 },
185 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operation&lt;/code&gt;.
186 &quot;importContext&quot;: { # Database instance import context. # The context for import operation, if applicable.
187 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#importContext&lt;/code&gt;.
188 &quot;csvImportOptions&quot;: { # Options for importing data as CSV.
189 &quot;table&quot;: &quot;A String&quot;, # The table to which CSV data is imported.
190 &quot;columns&quot;: [ # The columns to which CSV data is imported. If not specified, all columns
191 # of the database table are loaded with CSV data.
192 &quot;A String&quot;,
193 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700194 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700195 &quot;database&quot;: &quot;A String&quot;, # The target database for the import. If &lt;code&gt;fileType&lt;/code&gt; is
Dan O'Mearadd494642020-05-01 07:42:23 -0700196 # &lt;code&gt;SQL&lt;/code&gt;, this field is required only if the import file does not
197 # specify a database, and is overridden by any database specification in the
198 # import file. If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;, one database
199 # must be specified.
Bu Sun Kim65020912020-05-20 12:08:20 -0700200 &quot;importUser&quot;: &quot;A String&quot;, # The PostgreSQL user for this import operation. PostgreSQL instances only.
201 &quot;bakImportOptions&quot;: { # Import parameters specific to SQL Server .BAK files
202 &quot;encryptionOptions&quot;: {
203 &quot;certPath&quot;: &quot;A String&quot;, # Path to the Certificate (.cer) in Cloud Storage, in the form
204 # &lt;code&gt;gs://bucketName/fileName&lt;/code&gt;. The instance must have
205 # write permissions to the bucket and read access to the file.
206 &quot;pvkPath&quot;: &quot;A String&quot;, # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the
207 # form &lt;code&gt;gs://bucketName/fileName&lt;/code&gt;. The instance must have
208 # write permissions to the bucket and read access to the file.
209 &quot;pvkPassword&quot;: &quot;A String&quot;, # Password that encrypts the private key
210 },
211 },
212 &quot;uri&quot;: &quot;A String&quot;, # Path to the import file in Cloud Storage, in the form
Dan O'Mearadd494642020-05-01 07:42:23 -0700213 # &lt;code&gt;gs:
214 # //bucketName/fileName&lt;/code&gt;. Compressed gzip files (.gz) are supported
215 # // when &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;SQL&lt;/code&gt;. The instance must have
216 # // write permissions to the bucket and read access to the file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700217 &quot;fileType&quot;: &quot;A String&quot;, # The file type for the specified uri. &lt;br&gt;&lt;code&gt;SQL&lt;/code&gt;: The file
218 # contains SQL statements. &lt;br&gt;&lt;code&gt;CSV&lt;/code&gt;: The file contains CSV data.
Craig Citroe633be12015-03-02 13:40:36 -0800219 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700220 &quot;status&quot;: &quot;A String&quot;, # The status of an operation. Valid values are &lt;code&gt;PENDING&lt;/code&gt;,
221 # &lt;code&gt;RUNNING&lt;/code&gt;, &lt;code&gt;DONE&lt;/code&gt;,
222 # &lt;code&gt;SQL_OPERATION_STATUS_UNSPECIFIED&lt;/code&gt;.
223 &quot;name&quot;: &quot;A String&quot;, # An identifier that uniquely identifies the operation. You can use this
Dan O'Mearadd494642020-05-01 07:42:23 -0700224 # identifier to retrieve the Operations resource that has information about
225 # the operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700226 &quot;exportContext&quot;: { # Database instance export context. # The context for export operation, if applicable.
227 &quot;databases&quot;: [ # Databases to be exported. &lt;br /&gt; &lt;b&gt;MySQL instances:&lt;/b&gt; If
Dan O'Mearadd494642020-05-01 07:42:23 -0700228 # &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;SQL&lt;/code&gt; and no database is specified, all
229 # databases are exported, except for the &lt;code&gt;mysql&lt;/code&gt; system database.
230 # If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;, you can specify one database,
231 # either by using this property or by using the
232 # &lt;code&gt;csvExportOptions.selectQuery&lt;/code&gt; property, which takes precedence
233 # over this property. &lt;br /&gt; &lt;b&gt;PostgreSQL instances:&lt;/b&gt; You must specify
234 # one database to be exported. If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;,
235 # this database must match the one specified in the
236 # &lt;code&gt;csvExportOptions.selectQuery&lt;/code&gt; property.
Bu Sun Kim65020912020-05-20 12:08:20 -0700237 &quot;A String&quot;,
Craig Citroe633be12015-03-02 13:40:36 -0800238 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700239 &quot;sqlExportOptions&quot;: { # Options for exporting data as SQL statements.
240 &quot;tables&quot;: [ # Tables to export, or that were exported, from the specified database. If
Dan O'Mearadd494642020-05-01 07:42:23 -0700241 # you specify tables, specify one and only one database. For PostgreSQL
242 # instances, you can specify only one table.
Bu Sun Kim65020912020-05-20 12:08:20 -0700243 &quot;A String&quot;,
Craig Citroe633be12015-03-02 13:40:36 -0800244 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700245 &quot;schemaOnly&quot;: True or False, # Export only schemas.
246 &quot;mysqlExportOptions&quot;: { # Options for exporting from MySQL.
247 &quot;masterData&quot;: 42, # Option to include SQL statement required to set up replication.
Dan O'Mearadd494642020-05-01 07:42:23 -0700248 # If set to &lt;code&gt;1&lt;/code&gt;, the dump file includes
249 # a CHANGE MASTER TO statement with the binary log coordinates.
250 # If set to &lt;code&gt;2&lt;/code&gt;, the CHANGE MASTER TO statement is written as
251 # a SQL comment, and has no effect.
252 # All other values are ignored.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700253 },
Craig Citroe633be12015-03-02 13:40:36 -0800254 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700255 &quot;fileType&quot;: &quot;A String&quot;, # The file type for the specified uri. &lt;br&gt;&lt;code&gt;SQL&lt;/code&gt;: The file
256 # contains SQL statements. &lt;br&gt;&lt;code&gt;CSV&lt;/code&gt;: The file contains CSV data.
257 &quot;uri&quot;: &quot;A String&quot;, # The path to the file in Google Cloud Storage where the export will be
258 # stored. The URI is in the form &lt;code&gt;gs:
259 # //bucketName/fileName&lt;/code&gt;. If the file already exists, the requests
260 # // succeeds, but the operation fails. If &lt;code&gt;fileType&lt;/code&gt; is
261 # // &lt;code&gt;SQL&lt;/code&gt; and the filename ends with .gz, the contents are
262 # // compressed.
263 &quot;csvExportOptions&quot;: { # Options for exporting data as CSV.
264 &quot;selectQuery&quot;: &quot;A String&quot;, # The select query used to extract the data.
265 },
266 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#exportContext&lt;/code&gt;.
Craig Citroe633be12015-03-02 13:40:36 -0800267 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700268 &quot;targetId&quot;: &quot;A String&quot;, # Name of the database instance related to this operation.
Craig Citroe633be12015-03-02 13:40:36 -0800269 }</pre>
270</div>
271
272<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700273 <code class="details" id="get">get(project, instance, sha1Fingerprint, x__xgafv=None)</code>
274 <pre>Retrieves a particular SSL certificate. Does not include the private key
275(required for usage). The private key must be saved from the response to
276initial creation.
Craig Citroe633be12015-03-02 13:40:36 -0800277
278Args:
279 project: string, Project ID of the project that contains the instance. (required)
280 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
281 sha1Fingerprint: string, Sha1 FingerPrint. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700282 x__xgafv: string, V1 error format.
283 Allowed values
284 1 - v1 error format
285 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800286
287Returns:
288 An object of the form:
289
290 { # SslCerts Resource
Bu Sun Kim65020912020-05-20 12:08:20 -0700291 &quot;sha1Fingerprint&quot;: &quot;A String&quot;, # Sha1 Fingerprint.
292 &quot;certSerialNumber&quot;: &quot;A String&quot;, # Serial number, as extracted from the certificate.
293 &quot;cert&quot;: &quot;A String&quot;, # PEM representation.
294 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#sslCert&lt;/code&gt;.
295 &quot;commonName&quot;: &quot;A String&quot;, # User supplied name. Constrained to [a-zA-Z.-_ ]+.
296 &quot;createTime&quot;: &quot;A String&quot;, # The time when the certificate was created in &lt;a
297 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
Dan O'Mearadd494642020-05-01 07:42:23 -0700298 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;
Bu Sun Kim65020912020-05-20 12:08:20 -0700299 &quot;instance&quot;: &quot;A String&quot;, # Name of the database instance.
300 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
301 &quot;expirationTime&quot;: &quot;A String&quot;, # The time when the certificate expires in &lt;a
302 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
303 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
Craig Citroe633be12015-03-02 13:40:36 -0800304 }</pre>
305</div>
306
307<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700308 <code class="details" id="insert">insert(project, instance, body=None, x__xgafv=None)</code>
309 <pre>Creates an SSL certificate and returns it along with the private key and
310server certificate authority. The new certificate will not be usable until
311the instance is restarted.
Craig Citroe633be12015-03-02 13:40:36 -0800312
313Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700314 project: string, Project ID of the project that contains the instance. (required)
Craig Citroe633be12015-03-02 13:40:36 -0800315 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700316 body: object, The request body.
Craig Citroe633be12015-03-02 13:40:36 -0800317 The object takes the form of:
318
319{ # SslCerts insert request.
Bu Sun Kim65020912020-05-20 12:08:20 -0700320 &quot;commonName&quot;: &quot;A String&quot;, # User supplied name. Must be a distinct name from the other certificates
Dan O'Mearadd494642020-05-01 07:42:23 -0700321 # for this instance.
Craig Citroe633be12015-03-02 13:40:36 -0800322 }
323
Dan O'Mearadd494642020-05-01 07:42:23 -0700324 x__xgafv: string, V1 error format.
325 Allowed values
326 1 - v1 error format
327 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800328
329Returns:
330 An object of the form:
331
332 { # SslCert insert response.
Bu Sun Kim65020912020-05-20 12:08:20 -0700333 &quot;serverCaCert&quot;: { # SslCerts Resource # The server Certificate Authority&#x27;s certificate. If this is missing you can
334 # force a new one to be generated by calling resetSslConfig method on
335 # instances resource.
336 &quot;sha1Fingerprint&quot;: &quot;A String&quot;, # Sha1 Fingerprint.
337 &quot;certSerialNumber&quot;: &quot;A String&quot;, # Serial number, as extracted from the certificate.
338 &quot;cert&quot;: &quot;A String&quot;, # PEM representation.
339 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#sslCert&lt;/code&gt;.
340 &quot;commonName&quot;: &quot;A String&quot;, # User supplied name. Constrained to [a-zA-Z.-_ ]+.
341 &quot;createTime&quot;: &quot;A String&quot;, # The time when the certificate was created in &lt;a
342 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
343 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;
344 &quot;instance&quot;: &quot;A String&quot;, # Name of the database instance.
345 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
346 &quot;expirationTime&quot;: &quot;A String&quot;, # The time when the certificate expires in &lt;a
347 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
348 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
349 },
350 &quot;clientCert&quot;: { # SslCertDetail. # The new client certificate and private key. For First Generation
Dan O'Mearadd494642020-05-01 07:42:23 -0700351 # instances, the new certificate does not take effect until the instance is
352 # restarted.
Bu Sun Kim65020912020-05-20 12:08:20 -0700353 &quot;certPrivateKey&quot;: &quot;A String&quot;, # The private key for the client cert, in pem format. Keep private in order
Dan O'Mearadd494642020-05-01 07:42:23 -0700354 # to protect your security.
Bu Sun Kim65020912020-05-20 12:08:20 -0700355 &quot;certInfo&quot;: { # SslCerts Resource # The public information about the cert.
356 &quot;sha1Fingerprint&quot;: &quot;A String&quot;, # Sha1 Fingerprint.
357 &quot;certSerialNumber&quot;: &quot;A String&quot;, # Serial number, as extracted from the certificate.
358 &quot;cert&quot;: &quot;A String&quot;, # PEM representation.
359 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#sslCert&lt;/code&gt;.
360 &quot;commonName&quot;: &quot;A String&quot;, # User supplied name. Constrained to [a-zA-Z.-_ ]+.
361 &quot;createTime&quot;: &quot;A String&quot;, # The time when the certificate was created in &lt;a
362 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
Dan O'Mearadd494642020-05-01 07:42:23 -0700363 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;
Bu Sun Kim65020912020-05-20 12:08:20 -0700364 &quot;instance&quot;: &quot;A String&quot;, # Name of the database instance.
365 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
366 &quot;expirationTime&quot;: &quot;A String&quot;, # The time when the certificate expires in &lt;a
367 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
368 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
Craig Citroe633be12015-03-02 13:40:36 -0800369 },
370 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700371 &quot;operation&quot;: { # An Operation resource.&amp;nbsp;For successful operations that return an # The operation to track the ssl certs insert request.
Dan O'Mearadd494642020-05-01 07:42:23 -0700372 # Operation resource, only the fields relevant to the operation are populated
373 # in the resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700374 &quot;endTime&quot;: &quot;A String&quot;, # The time this operation finished in UTC timezone in &lt;a
375 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
376 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
377 &quot;startTime&quot;: &quot;A String&quot;, # The time this operation actually started in UTC timezone in &lt;a
378 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
379 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
380 &quot;insertTime&quot;: &quot;A String&quot;, # The time this operation was enqueued in UTC timezone in &lt;a
381 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
382 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
383 &quot;user&quot;: &quot;A String&quot;, # The email address of the user who initiated this operation.
384 &quot;targetProject&quot;: &quot;A String&quot;, # The project ID of the target instance related to this operation.
385 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
386 &quot;targetLink&quot;: &quot;A String&quot;,
387 &quot;operationType&quot;: &quot;A String&quot;, # The type of the operation. Valid values are &lt;code&gt;CREATE&lt;/code&gt;,
388 # &lt;code&gt;DELETE&lt;/code&gt;, &lt;code&gt;UPDATE&lt;/code&gt;, &lt;code&gt;RESTART&lt;/code&gt;,
389 # &lt;code&gt;IMPORT&lt;/code&gt;, &lt;code&gt;EXPORT&lt;/code&gt;, &lt;code&gt;BACKUP_VOLUME&lt;/code&gt;,
390 # &lt;code&gt;RESTORE_VOLUME&lt;/code&gt;, &lt;code&gt;CREATE_USER&lt;/code&gt;,
391 # &lt;code&gt;DELETE_USER&lt;/code&gt;, &lt;code&gt;CREATE_DATABASE&lt;/code&gt;,
392 # &lt;code&gt;DELETE_DATABASE&lt;/code&gt; .
393 &quot;error&quot;: { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be
394 # populated.
395 &quot;errors&quot;: [ # The list of errors encountered while processing this operation.
396 { # Database instance operation error.
397 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operationError&lt;/code&gt;.
398 &quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
399 &quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
Dan O'Mearadd494642020-05-01 07:42:23 -0700400 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700401 ],
402 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operationErrors&lt;/code&gt;.
403 },
404 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#operation&lt;/code&gt;.
405 &quot;importContext&quot;: { # Database instance import context. # The context for import operation, if applicable.
406 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#importContext&lt;/code&gt;.
407 &quot;csvImportOptions&quot;: { # Options for importing data as CSV.
408 &quot;table&quot;: &quot;A String&quot;, # The table to which CSV data is imported.
409 &quot;columns&quot;: [ # The columns to which CSV data is imported. If not specified, all columns
410 # of the database table are loaded with CSV data.
411 &quot;A String&quot;,
412 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700413 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700414 &quot;database&quot;: &quot;A String&quot;, # The target database for the import. If &lt;code&gt;fileType&lt;/code&gt; is
Dan O'Mearadd494642020-05-01 07:42:23 -0700415 # &lt;code&gt;SQL&lt;/code&gt;, this field is required only if the import file does not
416 # specify a database, and is overridden by any database specification in the
417 # import file. If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;, one database
418 # must be specified.
Bu Sun Kim65020912020-05-20 12:08:20 -0700419 &quot;importUser&quot;: &quot;A String&quot;, # The PostgreSQL user for this import operation. PostgreSQL instances only.
420 &quot;bakImportOptions&quot;: { # Import parameters specific to SQL Server .BAK files
421 &quot;encryptionOptions&quot;: {
422 &quot;certPath&quot;: &quot;A String&quot;, # Path to the Certificate (.cer) in Cloud Storage, in the form
423 # &lt;code&gt;gs://bucketName/fileName&lt;/code&gt;. The instance must have
424 # write permissions to the bucket and read access to the file.
425 &quot;pvkPath&quot;: &quot;A String&quot;, # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the
426 # form &lt;code&gt;gs://bucketName/fileName&lt;/code&gt;. The instance must have
427 # write permissions to the bucket and read access to the file.
428 &quot;pvkPassword&quot;: &quot;A String&quot;, # Password that encrypts the private key
429 },
430 },
431 &quot;uri&quot;: &quot;A String&quot;, # Path to the import file in Cloud Storage, in the form
Dan O'Mearadd494642020-05-01 07:42:23 -0700432 # &lt;code&gt;gs:
433 # //bucketName/fileName&lt;/code&gt;. Compressed gzip files (.gz) are supported
434 # // when &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;SQL&lt;/code&gt;. The instance must have
435 # // write permissions to the bucket and read access to the file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700436 &quot;fileType&quot;: &quot;A String&quot;, # The file type for the specified uri. &lt;br&gt;&lt;code&gt;SQL&lt;/code&gt;: The file
437 # contains SQL statements. &lt;br&gt;&lt;code&gt;CSV&lt;/code&gt;: The file contains CSV data.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700438 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700439 &quot;status&quot;: &quot;A String&quot;, # The status of an operation. Valid values are &lt;code&gt;PENDING&lt;/code&gt;,
440 # &lt;code&gt;RUNNING&lt;/code&gt;, &lt;code&gt;DONE&lt;/code&gt;,
441 # &lt;code&gt;SQL_OPERATION_STATUS_UNSPECIFIED&lt;/code&gt;.
442 &quot;name&quot;: &quot;A String&quot;, # An identifier that uniquely identifies the operation. You can use this
Dan O'Mearadd494642020-05-01 07:42:23 -0700443 # identifier to retrieve the Operations resource that has information about
444 # the operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700445 &quot;exportContext&quot;: { # Database instance export context. # The context for export operation, if applicable.
446 &quot;databases&quot;: [ # Databases to be exported. &lt;br /&gt; &lt;b&gt;MySQL instances:&lt;/b&gt; If
Dan O'Mearadd494642020-05-01 07:42:23 -0700447 # &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;SQL&lt;/code&gt; and no database is specified, all
448 # databases are exported, except for the &lt;code&gt;mysql&lt;/code&gt; system database.
449 # If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;, you can specify one database,
450 # either by using this property or by using the
451 # &lt;code&gt;csvExportOptions.selectQuery&lt;/code&gt; property, which takes precedence
452 # over this property. &lt;br /&gt; &lt;b&gt;PostgreSQL instances:&lt;/b&gt; You must specify
453 # one database to be exported. If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;,
454 # this database must match the one specified in the
455 # &lt;code&gt;csvExportOptions.selectQuery&lt;/code&gt; property.
Bu Sun Kim65020912020-05-20 12:08:20 -0700456 &quot;A String&quot;,
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700457 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700458 &quot;sqlExportOptions&quot;: { # Options for exporting data as SQL statements.
459 &quot;tables&quot;: [ # Tables to export, or that were exported, from the specified database. If
Dan O'Mearadd494642020-05-01 07:42:23 -0700460 # you specify tables, specify one and only one database. For PostgreSQL
461 # instances, you can specify only one table.
Bu Sun Kim65020912020-05-20 12:08:20 -0700462 &quot;A String&quot;,
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700463 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700464 &quot;schemaOnly&quot;: True or False, # Export only schemas.
465 &quot;mysqlExportOptions&quot;: { # Options for exporting from MySQL.
466 &quot;masterData&quot;: 42, # Option to include SQL statement required to set up replication.
Dan O'Mearadd494642020-05-01 07:42:23 -0700467 # If set to &lt;code&gt;1&lt;/code&gt;, the dump file includes
468 # a CHANGE MASTER TO statement with the binary log coordinates.
469 # If set to &lt;code&gt;2&lt;/code&gt;, the CHANGE MASTER TO statement is written as
470 # a SQL comment, and has no effect.
471 # All other values are ignored.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700472 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700473 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700474 &quot;fileType&quot;: &quot;A String&quot;, # The file type for the specified uri. &lt;br&gt;&lt;code&gt;SQL&lt;/code&gt;: The file
475 # contains SQL statements. &lt;br&gt;&lt;code&gt;CSV&lt;/code&gt;: The file contains CSV data.
476 &quot;uri&quot;: &quot;A String&quot;, # The path to the file in Google Cloud Storage where the export will be
477 # stored. The URI is in the form &lt;code&gt;gs:
478 # //bucketName/fileName&lt;/code&gt;. If the file already exists, the requests
479 # // succeeds, but the operation fails. If &lt;code&gt;fileType&lt;/code&gt; is
480 # // &lt;code&gt;SQL&lt;/code&gt; and the filename ends with .gz, the contents are
481 # // compressed.
482 &quot;csvExportOptions&quot;: { # Options for exporting data as CSV.
483 &quot;selectQuery&quot;: &quot;A String&quot;, # The select query used to extract the data.
484 },
485 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#exportContext&lt;/code&gt;.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700486 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700487 &quot;targetId&quot;: &quot;A String&quot;, # Name of the database instance related to this operation.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700488 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700489 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#sslCertsInsert&lt;/code&gt;.
Craig Citroe633be12015-03-02 13:40:36 -0800490 }</pre>
491</div>
492
493<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700494 <code class="details" id="list">list(project, instance, x__xgafv=None)</code>
Craig Citroe633be12015-03-02 13:40:36 -0800495 <pre>Lists all of the current SSL certificates for the instance.
496
497Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700498 project: string, Project ID of the project that contains the instance. (required)
Craig Citroe633be12015-03-02 13:40:36 -0800499 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700500 x__xgafv: string, V1 error format.
501 Allowed values
502 1 - v1 error format
503 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800504
505Returns:
506 An object of the form:
507
508 { # SslCerts list response.
Bu Sun Kim65020912020-05-20 12:08:20 -0700509 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#sslCertsList&lt;/code&gt;.
510 &quot;items&quot;: [ # List of client certificates for the instance.
Craig Citroe633be12015-03-02 13:40:36 -0800511 { # SslCerts Resource
Bu Sun Kim65020912020-05-20 12:08:20 -0700512 &quot;sha1Fingerprint&quot;: &quot;A String&quot;, # Sha1 Fingerprint.
513 &quot;certSerialNumber&quot;: &quot;A String&quot;, # Serial number, as extracted from the certificate.
514 &quot;cert&quot;: &quot;A String&quot;, # PEM representation.
515 &quot;kind&quot;: &quot;A String&quot;, # This is always &lt;code&gt;sql#sslCert&lt;/code&gt;.
516 &quot;commonName&quot;: &quot;A String&quot;, # User supplied name. Constrained to [a-zA-Z.-_ ]+.
517 &quot;createTime&quot;: &quot;A String&quot;, # The time when the certificate was created in &lt;a
518 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
Dan O'Mearadd494642020-05-01 07:42:23 -0700519 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;
Bu Sun Kim65020912020-05-20 12:08:20 -0700520 &quot;instance&quot;: &quot;A String&quot;, # Name of the database instance.
521 &quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
522 &quot;expirationTime&quot;: &quot;A String&quot;, # The time when the certificate expires in &lt;a
523 # href=&quot;https://tools.ietf.org/html/rfc3339&quot;&gt;RFC 3339&lt;/a&gt; format, for example
524 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
Craig Citroe633be12015-03-02 13:40:36 -0800525 },
526 ],
Craig Citroe633be12015-03-02 13:40:36 -0800527 }</pre>
528</div>
529
530</body></html>