Blame - docs/dyn/compute_alpha.regionSslCertificates.html - platform/external/python/google-api-python-client

2020-05-01 07:42:23 -0700

[diff] [blame]

87

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

88

<p class="firstline">Creates a SslCertificate resource in the specified project and region using the data included in the request</p>

89

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

90

<code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

91

<p class="firstline">Retrieves the list of SslCertificate resources available to the specified project in the specified region.</p>

92

93

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

94

<p class="firstline">Retrieves the next page of results.</p>

95

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

96

<code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

97

<p class="firstline">Returns permissions that a caller has on the specified resource and region.</p>

98

<h3>Method Details</h3>

99

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

100

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

101

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

105

<code class="details" id="delete">delete(project, region, sslCertificate, requestId=None)</code>

106

<pre>Deletes the specified SslCertificate resource in the region.

107

108

Args:

109

project: string, Project ID for this request. (required)

110

region: string, Name of the region scoping this request. (required)

111

sslCertificate: string, Name of the SslCertificate resource to delete. (required)

112

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

113

114

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

115

116

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

117

118

Returns:

119

An object of the form:

120

121

{ # Represents an Operation resource.

122

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

123

# Google Compute Engine has three Operation resources:

124

#

125

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

126

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

127

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

128

#

129

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

130

# - For global operations, use the `globalOperations` resource.

131

# - For regional operations, use the `regionOperations` resource.

132

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

133

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

134

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

135

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

136

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

137

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

138

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

139

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

140

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

141

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

142

"code": "A String", # [Output Only] The error type identifier for this error.

143

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

144

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

145

},

146

],

147

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

148

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

149

"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.

150

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

151

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

152

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

153

"name": "A String", # [Output Only] Name of the operation.

154

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

155

"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.

156

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

157

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

158

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

159

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

160

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

161

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

162

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

163

"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.

164

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

165

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

166

{

167

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

168

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

169

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

170

{

171

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

172

"value": "A String", # [Output Only] A warning data value corresponding to the key.

173

},

174

],

175

"message": "A String", # [Output Only] A human-readable description of the warning code.

176

},

177

],

178

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="get">get(project, region, sslCertificate)</code>

184

<pre>Returns the specified SslCertificate resource in the specified region. Get a list of available SSL certificates by making a list() request.

185

186

Args:

187

project: string, Project ID for this request. (required)

188

region: string, Name of the region scoping this request. (required)

189

sslCertificate: string, Name of the SslCertificate resource to return. (required)

190

191

Returns:

192

An object of the form:

193

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

194

{ # Represents an SSL Certificate resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

195

#

196

# Google Compute Engine has two SSL Certificate resources:

197

#

198

# * [Global](/compute/docs/reference/rest/{$api_version}/sslCertificates) * [Regional](/compute/docs/reference/rest/{$api_version}/regionSslCertificates)

#

#

#

# The sslCertificates are used by:

203

# - external HTTPS load balancers

204

# - SSL proxy load balancers

205

#

206

# The regionSslCertificates are used by internal HTTPS load balancers.

207

#

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

208

# Optionally, certificate file contents that you upload can contain a set of up to five PEM-encoded certificates. The API call creates an object (sslCertificate) that holds this data. You can use SSL keys and certificates to secure connections to a load balancer. For more information, read Creating and using SSL certificates, SSL certificates quotas and limits, and Troubleshooting SSL certificates. (== resource_for {$api_version}.sslCertificates ==) (== resource_for {$api_version}.regionSslCertificates ==)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

209

"certificate": "A String", # A value read into memory from a certificate file. The certificate file must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

210

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

211

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

212

"expireTime": "A String", # [Output Only] Expire time of the certificate. RFC3339

213

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

214

"kind": "compute#sslCertificate", # [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.

215

"managed": { # Configuration and status of a managed SSL certificate. # Configuration and status of a managed SSL certificate.

216

"domainStatus": { # [Output only] Detailed statuses of the domains specified for managed certificate resource.

217

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

218

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

219

"domains": [ # The domains for which a managed SSL certificate will be generated. Currently only single-domain certs are supported.

220

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

221

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

222

"status": "A String", # [Output only] Status of the managed certificate resource.

223

},

224

"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

225

"privateKey": "A String", # A value read into memory from a write-only private key file. The private key file must be in PEM format. For security, only insert requests include this field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

226

"region": "A String", # [Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate.

227

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

228

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

229

"selfManaged": { # Configuration and status of a self-managed SSL certificate. # Configuration and status of a self-managed SSL certificate.

230

"certificate": "A String", # A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.

231

"privateKey": "A String", # A write-only private key in PEM format. Only insert requests will include this field.

232

},

233

"subjectAlternativeNames": [ # [Output Only] Domains associated with the certificate via Subject Alternative Name.

234

"A String",

235

],

236

"type": "A String", # (Optional) Specifies the type of SSL certificate, either "SELF_MANAGED" or "MANAGED". If not specified, the certificate is self-managed and the fields certificate and private_key are used.

237

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

241

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

242

<pre>Creates a SslCertificate resource in the specified project and region using the data included in the request

243

244

Args:

245

project: string, Project ID for this request. (required)

246

region: string, Name of the region scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

247

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

248

The object takes the form of:

249

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

250

{ # Represents an SSL Certificate resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

251

#

252

# Google Compute Engine has two SSL Certificate resources:

253

#

254

# * [Global](/compute/docs/reference/rest/{$api_version}/sslCertificates) * [Regional](/compute/docs/reference/rest/{$api_version}/regionSslCertificates)

#

#

#

# The sslCertificates are used by:

259

# - external HTTPS load balancers

260

# - SSL proxy load balancers

261

#

262

# The regionSslCertificates are used by internal HTTPS load balancers.

263

#

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

264

# Optionally, certificate file contents that you upload can contain a set of up to five PEM-encoded certificates. The API call creates an object (sslCertificate) that holds this data. You can use SSL keys and certificates to secure connections to a load balancer. For more information, read Creating and using SSL certificates, SSL certificates quotas and limits, and Troubleshooting SSL certificates. (== resource_for {$api_version}.sslCertificates ==) (== resource_for {$api_version}.regionSslCertificates ==)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

265

"certificate": "A String", # A value read into memory from a certificate file. The certificate file must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

266

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

267

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

268

"expireTime": "A String", # [Output Only] Expire time of the certificate. RFC3339

269

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

270

"kind": "compute#sslCertificate", # [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.

271

"managed": { # Configuration and status of a managed SSL certificate. # Configuration and status of a managed SSL certificate.

272

"domainStatus": { # [Output only] Detailed statuses of the domains specified for managed certificate resource.

273

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

274

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

275

"domains": [ # The domains for which a managed SSL certificate will be generated. Currently only single-domain certs are supported.

276

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

277

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

278

"status": "A String", # [Output only] Status of the managed certificate resource.

279

},

280

"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

281

"privateKey": "A String", # A value read into memory from a write-only private key file. The private key file must be in PEM format. For security, only insert requests include this field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

282

"region": "A String", # [Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate.

283

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

284

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

285

"selfManaged": { # Configuration and status of a self-managed SSL certificate. # Configuration and status of a self-managed SSL certificate.

286

"certificate": "A String", # A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.

287

"privateKey": "A String", # A write-only private key in PEM format. Only insert requests will include this field.

288

},

289

"subjectAlternativeNames": [ # [Output Only] Domains associated with the certificate via Subject Alternative Name.

290

"A String",

291

],

292

"type": "A String", # (Optional) Specifies the type of SSL certificate, either "SELF_MANAGED" or "MANAGED". If not specified, the certificate is self-managed and the fields certificate and private_key are used.

293

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

294

295

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

296

297

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

298

299

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

300

301

Returns:

302

An object of the form:

303

304

{ # Represents an Operation resource.

305

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

306

# Google Compute Engine has three Operation resources:

307

#

308

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

309

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

310

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

311

#

312

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

313

# - For global operations, use the `globalOperations` resource.

314

# - For regional operations, use the `regionOperations` resource.

315

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

316

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

317

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

318

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

319

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

320

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

321

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

322

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

323

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

324

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

325

"code": "A String", # [Output Only] The error type identifier for this error.

326

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

327

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

328

},

329

],

330

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

331

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

332

"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.

333

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

334

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

335

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

336

"name": "A String", # [Output Only] Name of the operation.

337

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

338

"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.

339

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

340

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

341

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

342

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

343

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

344

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

345

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

346

"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.

347

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

348

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

349

{

350

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

351

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

352

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

353

{

354

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

355

"value": "A String", # [Output Only] A warning data value corresponding to the key.

356

},

357

],

358

"message": "A String", # [Output Only] A human-readable description of the warning code.

359

},

360

],

361

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

366

<code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

367

<pre>Retrieves the list of SslCertificate resources available to the specified project in the specified region.

368

369

Args:

370

project: string, Project ID for this request. (required)

371

region: string, Name of the region scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

372

filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

373

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

374

For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

375

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

376

You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

377

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

378

To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```

379

maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)

380

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

381

382

You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

383

384

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

385

pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.

386

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

387

388

Returns:

389

An object of the form:

390

391

{ # Contains a list of SslCertificate resources.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

392

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

393

"items": [ # A list of SslCertificate resources.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

394

{ # Represents an SSL Certificate resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

395

#

396

# Google Compute Engine has two SSL Certificate resources:

397

#

398

# * [Global](/compute/docs/reference/rest/{$api_version}/sslCertificates) * [Regional](/compute/docs/reference/rest/{$api_version}/regionSslCertificates)

#

#

#

# The sslCertificates are used by:

403

# - external HTTPS load balancers

404

# - SSL proxy load balancers

405

#

406

# The regionSslCertificates are used by internal HTTPS load balancers.

407

#

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

408

# Optionally, certificate file contents that you upload can contain a set of up to five PEM-encoded certificates. The API call creates an object (sslCertificate) that holds this data. You can use SSL keys and certificates to secure connections to a load balancer. For more information, read Creating and using SSL certificates, SSL certificates quotas and limits, and Troubleshooting SSL certificates. (== resource_for {$api_version}.sslCertificates ==) (== resource_for {$api_version}.regionSslCertificates ==)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

409

"certificate": "A String", # A value read into memory from a certificate file. The certificate file must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

410

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

411

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

412

"expireTime": "A String", # [Output Only] Expire time of the certificate. RFC3339

413

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

414

"kind": "compute#sslCertificate", # [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.

415

"managed": { # Configuration and status of a managed SSL certificate. # Configuration and status of a managed SSL certificate.

416

"domainStatus": { # [Output only] Detailed statuses of the domains specified for managed certificate resource.

417

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

418

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

419

"domains": [ # The domains for which a managed SSL certificate will be generated. Currently only single-domain certs are supported.

420

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

421

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

422

"status": "A String", # [Output only] Status of the managed certificate resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

423

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

424

"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

425

"privateKey": "A String", # A value read into memory from a write-only private key file. The private key file must be in PEM format. For security, only insert requests include this field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

426

"region": "A String", # [Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate.

427

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

428

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

429

"selfManaged": { # Configuration and status of a self-managed SSL certificate. # Configuration and status of a self-managed SSL certificate.

430

"certificate": "A String", # A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.

431

"privateKey": "A String", # A write-only private key in PEM format. Only insert requests will include this field.

432

},

433

"subjectAlternativeNames": [ # [Output Only] Domains associated with the certificate via Subject Alternative Name.

434

"A String",

435

],

436

"type": "A String", # (Optional) Specifies the type of SSL certificate, either "SELF_MANAGED" or "MANAGED". If not specified, the certificate is self-managed and the fields certificate and private_key are used.

437

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

438

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

439

"kind": "compute#sslCertificateList", # Type of resource.

440

"nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

441

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

442

"warning": { # [Output Only] Informational warning message.

443

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

444

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

445

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

446

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

447

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

448

"value": "A String", # [Output Only] A warning data value corresponding to the key.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

449

},

450

],

Bu Sun Kim