Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / sqladmin_v1beta4.sslCerts.html
blob: d7c5ea3782e38fa3083e7fac33227d0a8b64e23c [file] [log] [blame]
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1<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 -0700[diff] [blame]75<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 -0800[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]78 <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 -0700[diff] [blame]80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]81 <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 -0800[diff] [blame]83<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]84 <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 -0800[diff] [blame]86<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]87 <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 -0800[diff] [blame]89<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]90 <code><a href="#list">list(project, instance, x__xgafv=None)</a></code></p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]91<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 -0700[diff] [blame^]94 <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 -0700[diff] [blame]99
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 -0700[diff] [blame^]103 body: object, The request body.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]104 The object takes the form of:
105
106{ # SslCerts create ephemeral certificate request.
107 "public_key": "A String", # PEM encoded public key to include in the signed certificate.
108 }
109
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]110 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 -0700[diff] [blame]114
115Returns:
116 An object of the form:
117
118 { # SslCerts Resource
119 "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]120 "kind": "A String", # This is always &lt;code&gt;sql#sslCert&lt;/code&gt;.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]121 "sha1Fingerprint": "A String", # Sha1 Fingerprint.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]122 "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]123 "instance": "A String", # Name of the database instance.
124 "cert": "A String", # PEM representation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]125 "expirationTime": "A String", # The time when the certificate expires in &lt;a
126 # href="https://tools.ietf.org/html/rfc3339"&gt;RFC 3339&lt;/a&gt; format, for example
127 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
128 "createTime": "A String", # The time when the certificate was created in &lt;a
129 # href="https://tools.ietf.org/html/rfc3339"&gt;RFC 3339&lt;/a&gt; format, for example
130 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]131 "selfLink": "A String", # The URI of this resource.
132 }</pre>
133</div>
134
135<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]136 <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 -0800[diff] [blame]139
140Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]141 project: string, Project ID of the project that contains the instance. (required)
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]142 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 -0700[diff] [blame^]144 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 -0800[diff] [blame]148
149Returns:
150 An object of the form:
151
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]152 { # 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.
155 "status": "A String", # The status of an operation. Valid values are &lt;code&gt;PENDING&lt;/code&gt;,
156 # &lt;code&gt;RUNNING&lt;/code&gt;, &lt;code&gt;DONE&lt;/code&gt;,
157 # &lt;code&gt;SQL_OPERATION_STATUS_UNSPECIFIED&lt;/code&gt;.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]158 "importContext": { # Database instance import context. # The context for import operation, if applicable.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]159 "bakImportOptions": { # Import parameters specific to SQL Server .BAK files
160 "encryptionOptions": {
161 "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the
162 # form &lt;code&gt;gs://bucketName/fileName&lt;/code&gt;. The instance must have
163 # write permissions to the bucket and read access to the file.
164 "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form
165 # &lt;code&gt;gs://bucketName/fileName&lt;/code&gt;. The instance must have
166 # write permissions to the bucket and read access to the file.
167 "pvkPassword": "A String", # Password that encrypts the private key
168 },
169 },
170 "kind": "A String", # This is always &lt;code&gt;sql#importContext&lt;/code&gt;.
171 "database": "A String", # The target database for the import. If &lt;code&gt;fileType&lt;/code&gt; is
172 # &lt;code&gt;SQL&lt;/code&gt;, this field is required only if the import file does not
173 # specify a database, and is overridden by any database specification in the
174 # import file. If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;, one database
175 # must be specified.
176 "fileType": "A String", # The file type for the specified uri. &lt;br&gt;&lt;code&gt;SQL&lt;/code&gt;: The file
177 # contains SQL statements. &lt;br&gt;&lt;code&gt;CSV&lt;/code&gt;: The file contains CSV data.
178 "uri": "A String", # Path to the import file in Cloud Storage, in the form
179 # &lt;code&gt;gs:
180 # //bucketName/fileName&lt;/code&gt;. Compressed gzip files (.gz) are supported
181 # // when &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;SQL&lt;/code&gt;. The instance must have
182 # // write permissions to the bucket and read access to the file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]183 "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]184 "csvImportOptions": { # Options for importing data as CSV.
185 "table": "A String", # The table to which CSV data is imported.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]186 "columns": [ # The columns to which CSV data is imported. If not specified, all columns
187 # of the database table are loaded with CSV data.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]188 "A String",
189 ],
190 },
191 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]192 "kind": "A String", # This is always &lt;code&gt;sql#operation&lt;/code&gt;.
193 "targetProject": "A String", # The project ID of the target instance related to this operation.
194 "name": "A String", # An identifier that uniquely identifies the operation. You can use this
195 # identifier to retrieve the Operations resource that has information about
196 # the operation.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]197 "exportContext": { # Database instance export context. # The context for export operation, if applicable.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]198 "kind": "A String", # This is always &lt;code&gt;sql#exportContext&lt;/code&gt;.
199 "fileType": "A String", # The file type for the specified uri. &lt;br&gt;&lt;code&gt;SQL&lt;/code&gt;: The file
200 # contains SQL statements. &lt;br&gt;&lt;code&gt;CSV&lt;/code&gt;: The file contains CSV data.
201 "uri": "A String", # The path to the file in Google Cloud Storage where the export will be
202 # stored. The URI is in the form &lt;code&gt;gs:
203 # //bucketName/fileName&lt;/code&gt;. If the file already exists, the requests
204 # // succeeds, but the operation fails. If &lt;code&gt;fileType&lt;/code&gt; is
205 # // &lt;code&gt;SQL&lt;/code&gt; and the filename ends with .gz, the contents are
206 # // compressed.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]207 "csvExportOptions": { # Options for exporting data as CSV.
208 "selectQuery": "A String", # The select query used to extract the data.
209 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]210 "databases": [ # Databases to be exported. &lt;br /&gt; &lt;b&gt;MySQL instances:&lt;/b&gt; If
211 # &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;SQL&lt;/code&gt; and no database is specified, all
212 # databases are exported, except for the &lt;code&gt;mysql&lt;/code&gt; system database.
213 # If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;, you can specify one database,
214 # either by using this property or by using the
215 # &lt;code&gt;csvExportOptions.selectQuery&lt;/code&gt; property, which takes precedence
216 # over this property. &lt;br /&gt; &lt;b&gt;PostgreSQL instances:&lt;/b&gt; You must specify
217 # one database to be exported. If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;,
218 # this database must match the one specified in the
219 # &lt;code&gt;csvExportOptions.selectQuery&lt;/code&gt; property.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]220 "A String",
221 ],
222 "sqlExportOptions": { # Options for exporting data as SQL statements.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]223 "tables": [ # Tables to export, or that were exported, from the specified database. If
224 # you specify tables, specify one and only one database. For PostgreSQL
225 # instances, you can specify only one table.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]226 "A String",
227 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]228 "mysqlExportOptions": { # Options for exporting from MySQL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]229 "masterData": 42, # Option to include SQL statement required to set up replication.
230 # If set to &lt;code&gt;1&lt;/code&gt;, the dump file includes
231 # a CHANGE MASTER TO statement with the binary log coordinates.
232 # If set to &lt;code&gt;2&lt;/code&gt;, the CHANGE MASTER TO statement is written as
233 # a SQL comment, and has no effect.
234 # All other values are ignored.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]235 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]236 "schemaOnly": True or False, # Export only schemas.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]237 },
238 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]239 "insertTime": "A String", # The time this operation was enqueued in UTC timezone in &lt;a
240 # href="https://tools.ietf.org/html/rfc3339"&gt;RFC 3339&lt;/a&gt; format, for example
241 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]242 "targetId": "A String", # Name of the database instance related to this operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]243 "operationType": "A String", # The type of the operation. Valid values are &lt;code&gt;CREATE&lt;/code&gt;,
244 # &lt;code&gt;DELETE&lt;/code&gt;, &lt;code&gt;UPDATE&lt;/code&gt;, &lt;code&gt;RESTART&lt;/code&gt;,
245 # &lt;code&gt;IMPORT&lt;/code&gt;, &lt;code&gt;EXPORT&lt;/code&gt;, &lt;code&gt;BACKUP_VOLUME&lt;/code&gt;,
246 # &lt;code&gt;RESTORE_VOLUME&lt;/code&gt;, &lt;code&gt;CREATE_USER&lt;/code&gt;,
247 # &lt;code&gt;DELETE_USER&lt;/code&gt;, &lt;code&gt;CREATE_DATABASE&lt;/code&gt;,
248 # &lt;code&gt;DELETE_DATABASE&lt;/code&gt; .
249 "user": "A String", # The email address of the user who initiated this operation.
250 "startTime": "A String", # The time this operation actually started in UTC timezone in &lt;a
251 # href="https://tools.ietf.org/html/rfc3339"&gt;RFC 3339&lt;/a&gt; format, for example
252 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
253 "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be
254 # populated.
255 "kind": "A String", # This is always &lt;code&gt;sql#operationErrors&lt;/code&gt;.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]256 "errors": [ # The list of errors encountered while processing this operation.
257 { # Database instance operation error.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]258 "kind": "A String", # This is always &lt;code&gt;sql#operationError&lt;/code&gt;.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]259 "code": "A String", # Identifies the specific error that occurred.
260 "message": "A String", # Additional information about the error encountered.
261 },
262 ],
263 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]264 "endTime": "A String", # The time this operation finished in UTC timezone in &lt;a
265 # href="https://tools.ietf.org/html/rfc3339"&gt;RFC 3339&lt;/a&gt; format, for example
266 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]267 "selfLink": "A String", # The URI of this resource.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]268 "targetLink": "A String",
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]269 }</pre>
270</div>
271
272<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]273 <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 -0800[diff] [blame]277
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 -0700[diff] [blame^]282 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 -0800[diff] [blame]286
287Returns:
288 An object of the form:
289
290 { # SslCerts Resource
291 "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]292 "kind": "A String", # This is always &lt;code&gt;sql#sslCert&lt;/code&gt;.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]293 "sha1Fingerprint": "A String", # Sha1 Fingerprint.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]294 "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]295 "instance": "A String", # Name of the database instance.
296 "cert": "A String", # PEM representation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]297 "expirationTime": "A String", # The time when the certificate expires in &lt;a
298 # href="https://tools.ietf.org/html/rfc3339"&gt;RFC 3339&lt;/a&gt; format, for example
299 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
300 "createTime": "A String", # The time when the certificate was created in &lt;a
301 # href="https://tools.ietf.org/html/rfc3339"&gt;RFC 3339&lt;/a&gt; format, for example
302 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]303 "selfLink": "A String", # The URI of this resource.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]304 }</pre>
305</div>
306
307<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]308 <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 -0800[diff] [blame]312
313Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]314 project: string, Project ID of the project that contains the instance. (required)
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]315 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]316 body: object, The request body.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]317 The object takes the form of:
318
319{ # SslCerts insert request.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]320 "commonName": "A String", # User supplied name. Must be a distinct name from the other certificates
321 # for this instance.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]322 }
323
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]324 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 -0800[diff] [blame]328
329Returns:
330 An object of the form:
331
332 { # SslCert insert response.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]333 "clientCert": { # SslCertDetail. # The new client certificate and private key. For First Generation
334 # instances, the new certificate does not take effect until the instance is
335 # restarted.
336 "certPrivateKey": "A String", # The private key for the client cert, in pem format. Keep private in order
337 # to protect your security.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]338 "certInfo": { # SslCerts Resource # The public information about the cert.
339 "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]340 "kind": "A String", # This is always &lt;code&gt;sql#sslCert&lt;/code&gt;.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]341 "sha1Fingerprint": "A String", # Sha1 Fingerprint.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]342 "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]343 "instance": "A String", # Name of the database instance.
344 "cert": "A String", # PEM representation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]345 "expirationTime": "A String", # The time when the certificate expires in &lt;a
346 # href="https://tools.ietf.org/html/rfc3339"&gt;RFC 3339&lt;/a&gt; format, for example
347 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
348 "createTime": "A String", # The time when the certificate was created in &lt;a
349 # href="https://tools.ietf.org/html/rfc3339"&gt;RFC 3339&lt;/a&gt; format, for example
350 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]351 "selfLink": "A String", # The URI of this resource.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]352 },
353 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]354 "operation": { # An Operation resource.&amp;nbsp;For successful operations that return an # The operation to track the ssl certs insert request.
355 # Operation resource, only the fields relevant to the operation are populated
356 # in the resource.
357 "status": "A String", # The status of an operation. Valid values are &lt;code&gt;PENDING&lt;/code&gt;,
358 # &lt;code&gt;RUNNING&lt;/code&gt;, &lt;code&gt;DONE&lt;/code&gt;,
359 # &lt;code&gt;SQL_OPERATION_STATUS_UNSPECIFIED&lt;/code&gt;.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]360 "importContext": { # Database instance import context. # The context for import operation, if applicable.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]361 "bakImportOptions": { # Import parameters specific to SQL Server .BAK files
362 "encryptionOptions": {
363 "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the
364 # form &lt;code&gt;gs://bucketName/fileName&lt;/code&gt;. The instance must have
365 # write permissions to the bucket and read access to the file.
366 "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form
367 # &lt;code&gt;gs://bucketName/fileName&lt;/code&gt;. The instance must have
368 # write permissions to the bucket and read access to the file.
369 "pvkPassword": "A String", # Password that encrypts the private key
370 },
371 },
372 "kind": "A String", # This is always &lt;code&gt;sql#importContext&lt;/code&gt;.
373 "database": "A String", # The target database for the import. If &lt;code&gt;fileType&lt;/code&gt; is
374 # &lt;code&gt;SQL&lt;/code&gt;, this field is required only if the import file does not
375 # specify a database, and is overridden by any database specification in the
376 # import file. If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;, one database
377 # must be specified.
378 "fileType": "A String", # The file type for the specified uri. &lt;br&gt;&lt;code&gt;SQL&lt;/code&gt;: The file
379 # contains SQL statements. &lt;br&gt;&lt;code&gt;CSV&lt;/code&gt;: The file contains CSV data.
380 "uri": "A String", # Path to the import file in Cloud Storage, in the form
381 # &lt;code&gt;gs:
382 # //bucketName/fileName&lt;/code&gt;. Compressed gzip files (.gz) are supported
383 # // when &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;SQL&lt;/code&gt;. The instance must have
384 # // write permissions to the bucket and read access to the file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]385 "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]386 "csvImportOptions": { # Options for importing data as CSV.
387 "table": "A String", # The table to which CSV data is imported.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]388 "columns": [ # The columns to which CSV data is imported. If not specified, all columns
389 # of the database table are loaded with CSV data.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]390 "A String",
391 ],
392 },
393 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]394 "kind": "A String", # This is always &lt;code&gt;sql#operation&lt;/code&gt;.
395 "targetProject": "A String", # The project ID of the target instance related to this operation.
396 "name": "A String", # An identifier that uniquely identifies the operation. You can use this
397 # identifier to retrieve the Operations resource that has information about
398 # the operation.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]399 "exportContext": { # Database instance export context. # The context for export operation, if applicable.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]400 "kind": "A String", # This is always &lt;code&gt;sql#exportContext&lt;/code&gt;.
401 "fileType": "A String", # The file type for the specified uri. &lt;br&gt;&lt;code&gt;SQL&lt;/code&gt;: The file
402 # contains SQL statements. &lt;br&gt;&lt;code&gt;CSV&lt;/code&gt;: The file contains CSV data.
403 "uri": "A String", # The path to the file in Google Cloud Storage where the export will be
404 # stored. The URI is in the form &lt;code&gt;gs:
405 # //bucketName/fileName&lt;/code&gt;. If the file already exists, the requests
406 # // succeeds, but the operation fails. If &lt;code&gt;fileType&lt;/code&gt; is
407 # // &lt;code&gt;SQL&lt;/code&gt; and the filename ends with .gz, the contents are
408 # // compressed.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]409 "csvExportOptions": { # Options for exporting data as CSV.
410 "selectQuery": "A String", # The select query used to extract the data.
411 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]412 "databases": [ # Databases to be exported. &lt;br /&gt; &lt;b&gt;MySQL instances:&lt;/b&gt; If
413 # &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;SQL&lt;/code&gt; and no database is specified, all
414 # databases are exported, except for the &lt;code&gt;mysql&lt;/code&gt; system database.
415 # If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;, you can specify one database,
416 # either by using this property or by using the
417 # &lt;code&gt;csvExportOptions.selectQuery&lt;/code&gt; property, which takes precedence
418 # over this property. &lt;br /&gt; &lt;b&gt;PostgreSQL instances:&lt;/b&gt; You must specify
419 # one database to be exported. If &lt;code&gt;fileType&lt;/code&gt; is &lt;code&gt;CSV&lt;/code&gt;,
420 # this database must match the one specified in the
421 # &lt;code&gt;csvExportOptions.selectQuery&lt;/code&gt; property.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]422 "A String",
423 ],
424 "sqlExportOptions": { # Options for exporting data as SQL statements.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]425 "tables": [ # Tables to export, or that were exported, from the specified database. If
426 # you specify tables, specify one and only one database. For PostgreSQL
427 # instances, you can specify only one table.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]428 "A String",
429 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]430 "mysqlExportOptions": { # Options for exporting from MySQL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]431 "masterData": 42, # Option to include SQL statement required to set up replication.
432 # If set to &lt;code&gt;1&lt;/code&gt;, the dump file includes
433 # a CHANGE MASTER TO statement with the binary log coordinates.
434 # If set to &lt;code&gt;2&lt;/code&gt;, the CHANGE MASTER TO statement is written as
435 # a SQL comment, and has no effect.
436 # All other values are ignored.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]437 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]438 "schemaOnly": True or False, # Export only schemas.
439 },
440 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]441 "insertTime": "A String", # The time this operation was enqueued in UTC timezone in &lt;a
442 # href="https://tools.ietf.org/html/rfc3339"&gt;RFC 3339&lt;/a&gt; format, for example
443 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]444 "targetId": "A String", # Name of the database instance related to this operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]445 "operationType": "A String", # The type of the operation. Valid values are &lt;code&gt;CREATE&lt;/code&gt;,
446 # &lt;code&gt;DELETE&lt;/code&gt;, &lt;code&gt;UPDATE&lt;/code&gt;, &lt;code&gt;RESTART&lt;/code&gt;,
447 # &lt;code&gt;IMPORT&lt;/code&gt;, &lt;code&gt;EXPORT&lt;/code&gt;, &lt;code&gt;BACKUP_VOLUME&lt;/code&gt;,
448 # &lt;code&gt;RESTORE_VOLUME&lt;/code&gt;, &lt;code&gt;CREATE_USER&lt;/code&gt;,
449 # &lt;code&gt;DELETE_USER&lt;/code&gt;, &lt;code&gt;CREATE_DATABASE&lt;/code&gt;,
450 # &lt;code&gt;DELETE_DATABASE&lt;/code&gt; .
451 "user": "A String", # The email address of the user who initiated this operation.
452 "startTime": "A String", # The time this operation actually started in UTC timezone in &lt;a
453 # href="https://tools.ietf.org/html/rfc3339"&gt;RFC 3339&lt;/a&gt; format, for example
454 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
455 "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be
456 # populated.
457 "kind": "A String", # This is always &lt;code&gt;sql#operationErrors&lt;/code&gt;.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]458 "errors": [ # The list of errors encountered while processing this operation.
459 { # Database instance operation error.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]460 "kind": "A String", # This is always &lt;code&gt;sql#operationError&lt;/code&gt;.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]461 "code": "A String", # Identifies the specific error that occurred.
462 "message": "A String", # Additional information about the error encountered.
463 },
464 ],
465 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]466 "endTime": "A String", # The time this operation finished in UTC timezone in &lt;a
467 # href="https://tools.ietf.org/html/rfc3339"&gt;RFC 3339&lt;/a&gt; format, for example
468 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]469 "selfLink": "A String", # The URI of this resource.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]470 "targetLink": "A String",
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]471 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]472 "kind": "A String", # This is always &lt;code&gt;sql#sslCertsInsert&lt;/code&gt;.
473 "serverCaCert": { # SslCerts Resource # The server Certificate Authority's certificate. If this is missing you can
474 # force a new one to be generated by calling resetSslConfig method on
475 # instances resource.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]476 "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]477 "kind": "A String", # This is always &lt;code&gt;sql#sslCert&lt;/code&gt;.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]478 "sha1Fingerprint": "A String", # Sha1 Fingerprint.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]479 "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]480 "instance": "A String", # Name of the database instance.
481 "cert": "A String", # PEM representation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]482 "expirationTime": "A String", # The time when the certificate expires in &lt;a
483 # href="https://tools.ietf.org/html/rfc3339"&gt;RFC 3339&lt;/a&gt; format, for example
484 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
485 "createTime": "A String", # The time when the certificate was created in &lt;a
486 # href="https://tools.ietf.org/html/rfc3339"&gt;RFC 3339&lt;/a&gt; format, for example
487 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]488 "selfLink": "A String", # The URI of this resource.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]489 },
490 }</pre>
491</div>
492
493<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]494 <code class="details" id="list">list(project, instance, x__xgafv=None)</code>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]495 <pre>Lists all of the current SSL certificates for the instance.
496
497Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]498 project: string, Project ID of the project that contains the instance. (required)
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]499 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]500 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 -0800[diff] [blame]504
505Returns:
506 An object of the form:
507
508 { # SslCerts list response.
509 "items": [ # List of client certificates for the instance.
510 { # SslCerts Resource
511 "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]512 "kind": "A String", # This is always &lt;code&gt;sql#sslCert&lt;/code&gt;.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]513 "sha1Fingerprint": "A String", # Sha1 Fingerprint.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]514 "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]515 "instance": "A String", # Name of the database instance.
516 "cert": "A String", # PEM representation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]517 "expirationTime": "A String", # The time when the certificate expires in &lt;a
518 # href="https://tools.ietf.org/html/rfc3339"&gt;RFC 3339&lt;/a&gt; format, for example
519 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;.
520 "createTime": "A String", # The time when the certificate was created in &lt;a
521 # href="https://tools.ietf.org/html/rfc3339"&gt;RFC 3339&lt;/a&gt; format, for example
522 # &lt;code&gt;2012-11-15T16:19:00.094Z&lt;/code&gt;
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]523 "selfLink": "A String", # The URI of this resource.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]524 },
525 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]526 "kind": "A String", # This is always &lt;code&gt;sql#sslCertsList&lt;/code&gt;.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]527 }</pre>
528</div>
529
530</body></html>