Blame - docs/dyn/sqladmin_v1.sslCerts.html - platform/external/python/google-api-python-client

<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>

83

84

<code><a href="#delete">delete(project, instance, sha1Fingerprint, x__xgafv=None)</a></code></p>

85

<p class="firstline">Deletes the SSL certificate. For First Generation instances, the certificate remains valid until the instance is restarted.</p>

86

87

<code><a href="#get">get(project, instance, sha1Fingerprint, x__xgafv=None)</a></code></p>

88

<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>

89

90

<code><a href="#insert">insert(project, instance, body=None, x__xgafv=None)</a></code></p>

91

<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>

92

93

<code><a href="#list">list(project, instance, x__xgafv=None)</a></code></p>

94

<p class="firstline">Lists all of the current SSL certificates for the instance.</p>

95

<h3>Method Details</h3>

96

97

<code class="details" id="close">close()</code>

98

<pre>Close httplib2 connections.</pre>

</div>

<code class="details" id="createEphemeral">createEphemeral(project, instance, body=None, x__xgafv=None)</code>

103

<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.

104

105

Args:

106

project: string, Project ID of the Cloud SQL project. (required)

107

instance: string, Cloud SQL instance ID. This does not include the project ID. (required)

108

body: object, The request body.

109

The object takes the form of:

110

111

{ # SslCerts create ephemeral certificate request.

112

"access_token": "A String", # Access token to include in the signed certificate.

113

"public_key": "A String", # PEM encoded public key to include in the signed certificate.

114

}

115

116

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

123

124

{ # SslCerts Resource

125

"cert": "A String", # PEM representation.

126

"certSerialNumber": "A String", # Serial number, as extracted from the certificate.

127

"commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.

128

"createTime": "A String", # The time when the certificate was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**

129

"expirationTime": "A String", # The time when the certificate expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

130

"instance": "A String", # Name of the database instance.

131

"kind": "A String", # This is always sql#sslCert.

132

"selfLink": "A String", # The URI of this resource.

133

"sha1Fingerprint": "A String", # Sha1 Fingerprint.

}</pre>

</div>

<code class="details" id="delete">delete(project, instance, sha1Fingerprint, x__xgafv=None)</code>

139

<pre>Deletes the SSL certificate. For First Generation instances, the certificate remains valid until the instance is restarted.

140

141

Args:

142

project: string, Project ID of the project that contains the instance. (required)

143

instance: string, Cloud SQL instance ID. This does not include the project ID. (required)

144

sha1Fingerprint: string, Sha1 FingerPrint. (required)

145

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

152

153

{ # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.

154

"backupContext": { # Backup context. # The context for backup operation, if applicable.

155

"backupId": "A String", # The identifier of the backup.

156

"kind": "A String", # This is always **sql#backupContext**.

157

},

158

"endTime": "A String", # The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

159

"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.

160

"errors": [ # The list of errors encountered while processing this operation.

161

{ # Database instance operation error.

162

"code": "A String", # Identifies the specific error that occurred.

163

"kind": "A String", # This is always **sql#operationError**.

164

"message": "A String", # Additional information about the error encountered.

165

},

166

],

167

"kind": "A String", # This is always **sql#operationErrors**.

168

},

169

"exportContext": { # Database instance export context. # The context for export operation, if applicable.

170

"csvExportOptions": { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only.

171

"selectQuery": "A String", # The select query used to extract the data.

172

},

173

"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:** You must specify one database to be exported. If **fileType** is **CSV**, this database must match the one specified in the **csvExportOptions.selectQuery** property. **SQL Server instances:** You must specify one database to be exported, and the **fileType** must be **BAK**.

174

"A String",

175

],

176

"fileType": "A String", # The file type for the specified uri. **SQL**: The file contains SQL statements. **CSV**: The file contains CSV data. **BAK**: The file contains backup data for a SQL Server instance.

177

"kind": "A String", # This is always **sql#exportContext**.

178

"offload": True or False, # Option for export offload.

179

"sqlExportOptions": { # Options for exporting data as SQL statements.

180

"mysqlExportOptions": { # Options for exporting from MySQL.

181

"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, and --set-gtid-purged is set to ON. If set to **2**, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than **1**, --set-gtid-purged is set to OFF.

182

},

183

"schemaOnly": True or False, # Export only schemas.

184

"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",

],

},

"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 request succeeds, but the operation fails. If **fileType** is **SQL** and the filename ends with .gz, the contents are compressed.

189

},

190

"importContext": { # Database instance import context. # The context for import operation, if applicable.

191

"bakImportOptions": { # Import parameters specific to SQL Server .BAK files

192

"encryptionOptions": {

193

"certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file.

194

"pvkPassword": "A String", # Password that encrypts the private key

195

"pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file.

196

},

197

},

198

"csvImportOptions": { # Options for importing data as CSV.

199

"columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.

200

"A String",

201

],

202

"table": "A String", # The table to which CSV data is imported.

203

},

204

"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.

205

"fileType": "A String", # The file type for the specified uri. **SQL**: The file contains SQL statements. **CSV**: The file contains CSV data.

206

"importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.

207

"kind": "A String", # This is always **sql#importContext**.

208

"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.

209

},

210

"insertTime": "A String", # The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

211

"kind": "A String", # This is always **sql#operation**.

212

"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.

213

"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**

214

"selfLink": "A String", # The URI of this resource.

215

"startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

216

"status": "A String", # The status of an operation. Valid values are: **PENDING** **RUNNING** **DONE** **SQL_OPERATION_STATUS_UNSPECIFIED**

217

"targetId": "A String", # Name of the database instance related to this operation.

218

"targetLink": "A String",

219

"targetProject": "A String", # The project ID of the target instance related to this operation.

220

"user": "A String", # The email address of the user who initiated this operation.

}</pre>

</div>

<code class="details" id="get">get(project, instance, sha1Fingerprint, x__xgafv=None)</code>

226

<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.

227

228

Args:

229

project: string, Project ID of the project that contains the instance. (required)

230

instance: string, Cloud SQL instance ID. This does not include the project ID. (required)

231

sha1Fingerprint: string, Sha1 FingerPrint. (required)

232

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

239

240

{ # SslCerts Resource

241

"cert": "A String", # PEM representation.

242

"certSerialNumber": "A String", # Serial number, as extracted from the certificate.

243

"commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.

244

"createTime": "A String", # The time when the certificate was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**

245

"expirationTime": "A String", # The time when the certificate expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

246

"instance": "A String", # Name of the database instance.

247

"kind": "A String", # This is always sql#sslCert.

248

"selfLink": "A String", # The URI of this resource.

249

"sha1Fingerprint": "A String", # Sha1 Fingerprint.

}</pre>

</div>

<code class="details" id="insert">insert(project, instance, body=None, x__xgafv=None)</code>

255

<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.

256

257

Args:

258

project: string, Project ID of the project that contains the instance. (required)

259

instance: string, Cloud SQL instance ID. This does not include the project ID. (required)

260

body: object, The request body.

261

The object takes the form of:

262

263

{ # SslCerts insert request.

264

"commonName": "A String", # User supplied name. Must be a distinct name from the other certificates for this instance.

265

}

266

267

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

274

275

{ # SslCert insert response.

276

"clientCert": { # SslCertDetail. # The new client certificate and private key.

277

"certInfo": { # SslCerts Resource # The public information about the cert.

278

"cert": "A String", # PEM representation.

279

"certSerialNumber": "A String", # Serial number, as extracted from the certificate.

280

"commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.

281

"createTime": "A String", # The time when the certificate was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**

282

"expirationTime": "A String", # The time when the certificate expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

283

"instance": "A String", # Name of the database instance.

284

"kind": "A String", # This is always sql#sslCert.

285

"selfLink": "A String", # The URI of this resource.

286

"sha1Fingerprint": "A String", # Sha1 Fingerprint.

287

},

288

"certPrivateKey": "A String", # The private key for the client cert, in pem format. Keep private in order to protect your security.

289

},

290

"kind": "A String", # This is always *sql#sslCertsInsert*.

291

"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.

292

"backupContext": { # Backup context. # The context for backup operation, if applicable.

293

"backupId": "A String", # The identifier of the backup.

294

"kind": "A String", # This is always **sql#backupContext**.

295

},

296

"endTime": "A String", # The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

297

"error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.

298

"errors": [ # The list of errors encountered while processing this operation.

299

{ # Database instance operation error.

300

"code": "A String", # Identifies the specific error that occurred.

301

"kind": "A String", # This is always **sql#operationError**.

302

"message": "A String", # Additional information about the error encountered.

303

},

304

],

305

"kind": "A String", # This is always **sql#operationErrors**.

306

},

307

"exportContext": { # Database instance export context. # The context for export operation, if applicable.

308

"csvExportOptions": { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only.

309

"selectQuery": "A String", # The select query used to extract the data.

310

},

311

"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:** You must specify one database to be exported. If **fileType** is **CSV**, this database must match the one specified in the **csvExportOptions.selectQuery** property. **SQL Server instances:** You must specify one database to be exported, and the **fileType** must be **BAK**.

312

"A String",

313

],

314

"fileType": "A String", # The file type for the specified uri. **SQL**: The file contains SQL statements. **CSV**: The file contains CSV data. **BAK**: The file contains backup data for a SQL Server instance.

315

"kind": "A String", # This is always **sql#exportContext**.

316

"offload": True or False, # Option for export offload.

317

"sqlExportOptions": { # Options for exporting data as SQL statements.

318

"mysqlExportOptions": { # Options for exporting from MySQL.

319

"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, and --set-gtid-purged is set to ON. If set to **2**, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than **1**, --set-gtid-purged is set to OFF.

320

},

321

"schemaOnly": True or False, # Export only schemas.

322

"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",

],

},

"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 request succeeds, but the operation fails. If **fileType** is **SQL** and the filename ends with .gz, the contents are compressed.

327

},

328

"importContext": { # Database instance import context. # The context for import operation, if applicable.

329

"bakImportOptions": { # Import parameters specific to SQL Server .BAK files

330

"encryptionOptions": {

331

"certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file.

332

"pvkPassword": "A String", # Password that encrypts the private key

333

"pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file.

334

},

335

},

336

"csvImportOptions": { # Options for importing data as CSV.

337

"columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.

338

"A String",

339

],

340

"table": "A String", # The table to which CSV data is imported.

341

},

342

"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.

343

"fileType": "A String", # The file type for the specified uri. **SQL**: The file contains SQL statements. **CSV**: The file contains CSV data.

344

"importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.

345

"kind": "A String", # This is always **sql#importContext**.

346

"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.

347

},

348

"insertTime": "A String", # The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

349

"kind": "A String", # This is always **sql#operation**.

350

"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.

351

"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**

352

"selfLink": "A String", # The URI of this resource.

353

"startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

354

"status": "A String", # The status of an operation. Valid values are: **PENDING** **RUNNING** **DONE** **SQL_OPERATION_STATUS_UNSPECIFIED**

355

"targetId": "A String", # Name of the database instance related to this operation.

356

"targetLink": "A String",

357

"targetProject": "A String", # The project ID of the target instance related to this operation.

358

"user": "A String", # The email address of the user who initiated this operation.

359

},

360

"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.

361

"cert": "A String", # PEM representation.

362

"certSerialNumber": "A String", # Serial number, as extracted from the certificate.

363

"commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.

364

"createTime": "A String", # The time when the certificate was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**

365

"expirationTime": "A String", # The time when the certificate expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

366

"instance": "A String", # Name of the database instance.

367

"kind": "A String", # This is always sql#sslCert.

368

"selfLink": "A String", # The URI of this resource.

369

"sha1Fingerprint": "A String", # Sha1 Fingerprint.

},

}</pre>

</div>

<code class="details" id="list">list(project, instance, x__xgafv=None)</code>

376

<pre>Lists all of the current SSL certificates for the instance.

377

378

Args:

379

project: string, Project ID of the project that contains the instance. (required)

380

instance: string, Cloud SQL instance ID. This does not include the project ID. (required)

381

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

388

389

{ # SslCerts list response.

390

"items": [ # List of client certificates for the instance.

391

{ # SslCerts Resource

392

"cert": "A String", # PEM representation.

393

"certSerialNumber": "A String", # Serial number, as extracted from the certificate.

394

"commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.

395

"createTime": "A String", # The time when the certificate was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**

396

"expirationTime": "A String", # The time when the certificate expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.

397

"instance": "A String", # Name of the database instance.

398

"kind": "A String", # This is always sql#sslCert.

399

"selfLink": "A String", # The URI of this resource.

400

"sha1Fingerprint": "A String", # Sha1 Fingerprint.

401

},

402

],