Blame - docs/dyn/compute_beta.healthChecks.html - platform/external/python/google-api-python-client

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

[diff] [blame]

79

<p class="firstline">Retrieves the list of all HealthCheck resources, regional and global, available to the specified project.</p>

80

81

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

82

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

83

84

<code><a href="#delete">delete(project, healthCheck, requestId=None)</a></code></p>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

85

<p class="firstline">Deletes the specified HealthCheck resource.</p>

86

87

<code><a href="#get">get(project, healthCheck)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

88

<p class="firstline">Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request.</p>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

89

Dan O'Meara

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

[diff] [blame]

90

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

91

<p class="firstline">Creates a HealthCheck resource in the specified project using the data included in the request.</p>

92

Bu Sun Kim

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

[diff] [blame]

93

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

94

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

95

96

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

97

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

98

Dan O'Meara

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

[diff] [blame]

99

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

Bu Sun Kim

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

[diff] [blame]

100

<p class="firstline">Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.</p>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

101

Dan O'Meara

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

[diff] [blame]

102

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

103

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

104

Dan O'Meara

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

[diff] [blame]

105

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

106

<p class="firstline">Updates a HealthCheck resource in the specified project using the data included in the request.</p>

107

<h3>Method Details</h3>

108

Bu Sun Kim

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

[diff] [blame]

109

<code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None)</code>

Bu Sun Kim

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

[diff] [blame]

110

<pre>Retrieves the list of all HealthCheck resources, regional and global, available to the specified project.

111

112

Args:

113

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

Dan O'Meara

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

[diff] [blame]

114

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]

115

Dan O'Meara

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

[diff] [blame]

116

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]

117

Dan O'Meara

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

[diff] [blame]

118

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]

119

Bu Sun Kim

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

[diff] [blame]

120

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

Dan O'Meara

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

[diff] [blame]

121

includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

Bu Sun Kim

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

[diff] [blame]

122

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

123

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

124

125

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.

126

127

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

128

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.

Bu Sun Kim

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

[diff] [blame]

129

130

Returns:

131

An object of the form:

132

133

{

Bu Sun Kim

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

[diff] [blame]

134

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

135

"items": { # A list of HealthChecksScopedList resources.

136

"a_key": { # Name of the scope containing this set of HealthChecks.

137

"healthChecks": [ # A list of HealthChecks contained in this scope.

Dan O'Meara

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

[diff] [blame]

138

{ # Represents a Health Check resource.

Bu Sun Kim

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

[diff] [blame]

139

#

140

# Google Compute Engine has two Health Check resources:

141

#

142

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

143

#

144

# Internal HTTP(S) load balancers use regional health checks. All other types of GCP load balancers and managed instance group auto-healing use global health checks. For more information, read Health Check Concepts.

145

#

146

# To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.

147

"checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.

148

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

149

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

Bu Sun Kim

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

[diff] [blame]

150

"grpcHealthCheck": {

151

"grpcServiceName": "A String", # The gRPC service name for the health check. This field is optional. The value of grpc_service_name has the following meanings by convention:

152

# - Empty service_name means the overall status of all services at the backend.

153

# - Non-empty service_name means the health of that gRPC service, as defined by the owner of the service.

154

# The grpc_service_name can only be ASCII.

155

"port": 42, # The port number for the health check request. Must be specified if port_name and port_specification are not set or if port_specification is USE_FIXED_PORT. Valid values are 1 through 65535.

156

"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. The port_name should conform to RFC1035.

157

"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:

158

# USE_FIXED_PORT: The port number in port is used for health checking.

159

# USE_NAMED_PORT: The portName is used for health checking.

160

# USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.

161

#

162

#

163

# If not specified, gRPC health check follows behavior specified in port and portName fields.

164

},

Bu Sun Kim

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

[diff] [blame]

165

"healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.

166

"http2HealthCheck": {

167

"host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.

168

"port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.

169

"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

170

"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:

171

# USE_FIXED_PORT: The port number in port is used for health checking.

172

# USE_NAMED_PORT: The portName is used for health checking.

173

# USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.

174

#

175

#

176

# If not specified, HTTP2 health check follows behavior specified in port and portName fields.

177

"proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

178

"requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.

179

"response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.

Bu Sun Kim

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

[diff] [blame]

180

},

Bu Sun Kim

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

[diff] [blame]

181

"httpHealthCheck": {

182

"host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.

183

"port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.

184

"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

185

"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:

186

# USE_FIXED_PORT: The port number in port is used for health checking.

187

# USE_NAMED_PORT: The portName is used for health checking.

188

# USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.

189

#

190

#

191

# If not specified, HTTP health check follows behavior specified in port and portName fields.

192

"proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

193

"requestPath": "A String", # The request path of the HTTP health check request. The default value is /.

194

"response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.

195

},

196

"httpsHealthCheck": {

197

"host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.

198

"port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.

199

"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

200

"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:

201

# USE_FIXED_PORT: The port number in port is used for health checking.

202

# USE_NAMED_PORT: The portName is used for health checking.

203

# USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.

204

#

205

#

206

# If not specified, HTTPS health check follows behavior specified in port and portName fields.

207

"proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

208

"requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.

209

"response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.

210

},

211

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

212

"kind": "compute#healthCheck", # Type of the resource.

213

"logConfig": { # Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. # Configure logging on this health check.

214

"enable": True or False, # Indicates whether or not to export logs. This is false by default, which means no health check logging will be done.

215

},

216

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

217

"region": "A String", # [Output Only] Region where the health check resides. Not applicable to global health checks.

218

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

219

"sslHealthCheck": {

220

"port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.

221

"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

222

"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:

223

# USE_FIXED_PORT: The port number in port is used for health checking.

224

# USE_NAMED_PORT: The portName is used for health checking.

225

# USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.

226

#

227

#

228

# If not specified, SSL health check follows behavior specified in port and portName fields.

229

"proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

230

"request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.

231

"response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

232

},

233

"tcpHealthCheck": {

234

"port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.

235

"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

236

"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:

237

# USE_FIXED_PORT: The port number in port is used for health checking.

238

# USE_NAMED_PORT: The portName is used for health checking.

239

# USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.

240

#

241

#

242

# If not specified, TCP health check follows behavior specified in port and portName fields.

243

"proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

244

"request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.

245

"response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

246

},

247

"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.

248

"type": "A String", # Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.

249

"unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

250

},

Bu Sun Kim

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

[diff] [blame]

251

],

Bu Sun Kim

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

[diff] [blame]

252

"warning": { # Informational warning which replaces the list of backend services when the list is empty.

253

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

254

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

255

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

Bu Sun Kim

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

[diff] [blame]

256

{

Bu Sun Kim

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

[diff] [blame]

257

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

258

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

259

},

260

],

Bu Sun Kim

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

[diff] [blame]

261

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

Bu Sun Kim

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

[diff] [blame]

262

},

263

},

264

},

Bu Sun Kim

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

[diff] [blame]

265

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

266

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

267

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

268

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

269

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

270

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

271

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

Bu Sun Kim

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

[diff] [blame]

272

{

Bu Sun Kim

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

[diff] [blame]

273

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

274

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

275

},

276

],

Bu Sun Kim

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

[diff] [blame]

277

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

Bu Sun Kim

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

[diff] [blame]

278

},

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

<code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>

284

<pre>Retrieves the next page of results.

285

286

Args:

287

previous_request: The request for the previous page. (required)

288

previous_response: The response from the request for the previous page. (required)

289

290

Returns:

Bu Sun Kim

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

[diff] [blame]

291

A request object that you can call 'execute()' on to request the next

Bu Sun Kim

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

[diff] [blame]

292

page. Returns None if there are no more items in the collection.

</pre>

</div>

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

298

<pre>Deletes the specified HealthCheck resource.

299

300

Args:

301

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

302

healthCheck: string, Name of the HealthCheck resource to delete. (required)

Bu Sun Kim

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

[diff] [blame]

303

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.

304

305

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.

306

307

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

308

309

Returns:

310

An object of the form:

311

Bu Sun Kim

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

[diff] [blame]

312

{ # Represents an Operation resource.

313

#

Dan O'Meara

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

[diff] [blame]

314

# Google Compute Engine has three Operation resources:

315

#

316

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

317

#

Bu Sun Kim

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

[diff] [blame]

318

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

319

#

320

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

321

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

322

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

323

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

Bu Sun Kim

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

[diff] [blame]

324

#

Dan O'Meara

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

[diff] [blame]

325

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

326

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

327

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

328

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

329

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

330

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

331

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

332

{

Bu Sun Kim

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

[diff] [blame]

333

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

334

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

335

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

336

},

337

],

338

},

Bu Sun Kim

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

[diff] [blame]

339

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

340

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

341

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

342

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

343

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

344

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

345

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

346

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

347

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

348

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

349

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

350

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

351

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

352

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

353

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

354

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

355

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

356

{

357

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

358

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

359

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

360

{

361

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

362

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

363

},

364

],

365

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

366

},

367

],

368

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

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

Bu Sun Kim

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

[diff] [blame]

374

<pre>Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

375

376

Args:

377

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

378

healthCheck: string, Name of the HealthCheck resource to return. (required)

379

380

Returns:

381

An object of the form:

382

Dan O'Meara

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

[diff] [blame]

383

{ # Represents a Health Check resource.

Bu Sun Kim

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

[diff] [blame]

384

#

385

# Google Compute Engine has two Health Check resources:

386

#

387

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

388

#

389

# Internal HTTP(S) load balancers use regional health checks. All other types of GCP load balancers and managed instance group auto-healing use global health checks. For more information, read Health Check Concepts.

390

#

391

# To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.

392

"checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.

393

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

394

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

Bu Sun Kim

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

[diff] [blame]

395

"grpcHealthCheck": {

396

"grpcServiceName": "A String", # The gRPC service name for the health check. This field is optional. The value of grpc_service_name has the following meanings by convention:

397

# - Empty service_name means the overall status of all services at the backend.

398

# - Non-empty service_name means the health of that gRPC service, as defined by the owner of the service.

399

# The grpc_service_name can only be ASCII.

400

"port": 42, # The port number for the health check request. Must be specified if port_name and port_specification are not set or if port_specification is USE_FIXED_PORT. Valid values are 1 through 65535.

401

"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. The port_name should conform to RFC1035.

402

"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:

403

# USE_FIXED_PORT: The port number in port is used for health checking.

404

# USE_NAMED_PORT: The portName is used for health checking.

405

# USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.

406

#

407

#

408

# If not specified, gRPC health check follows behavior specified in port and portName fields.

409

},

Bu Sun Kim

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

[diff] [blame]

410

"healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.

411

"http2HealthCheck": {

412

"host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.

413

"port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.

414

"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

415

"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:

416

# USE_FIXED_PORT: The port number in port is used for health checking.

417

# USE_NAMED_PORT: The portName is used for health checking.

418

# USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.

419

#

420

#

421

# If not specified, HTTP2 health check follows behavior specified in port and portName fields.

422

"proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

423

"requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.

424

"response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.

425

},

426

"httpHealthCheck": {

427

"host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.

428

"port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.

429

"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

430

"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:

431

# USE_FIXED_PORT: The port number in port is used for health checking.

432

# USE_NAMED_PORT: The portName is used for health checking.

433

# USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.

434

#

435

#

436

# If not specified, HTTP health check follows behavior specified in port and portName fields.

437

"proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

438

"requestPath": "A String", # The request path of the HTTP health check request. The default value is /.

439

"response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.

440

},

441

"httpsHealthCheck": {

442

"host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.

443

"port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.

444

"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

445

"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:

446

# USE_FIXED_PORT: The port number in port is used for health checking.

447

# USE_NAMED_PORT: The portName is used for health checking.

448

# USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.

449

#

450

#

451

# If not specified, HTTPS health check follows behavior specified in port and portName fields.

452

"proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

453

"requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.

454

"response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.

455

},

456

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

457

"kind": "compute#healthCheck", # Type of the resource.

458

"logConfig": { # Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. # Configure logging on this health check.

459

"enable": True or False, # Indicates whether or not to export logs. This is false by default, which means no health check logging will be done.

460

},

461

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

462

"region": "A String", # [Output Only] Region where the health check resides. Not applicable to global health checks.

463

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

464

"sslHealthCheck": {

465

"port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.

466

"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

467

"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:

468

# USE_FIXED_PORT: The port number in port is used for health checking.

469

# USE_NAMED_PORT: The portName is used for health checking.

470

# USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.

471

#

472

#

473

# If not specified, SSL health check follows behavior specified in port and portName fields.

474

"proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

475

"request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.

476

"response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

477

},

478

"tcpHealthCheck": {

479

"port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.

480

"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

481

"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:

482

# USE_FIXED_PORT: The port number in port is used for health checking.

483

# USE_NAMED_PORT: The portName is used for health checking.

484

# USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.

485

#

486

#

487

# If not specified, TCP health check follows behavior specified in port and portName fields.

488

"proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

489

"request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.

490

"response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

491

},

492

"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.

493

"type": "A String", # Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.

494

"unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

495

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

499

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

500

<pre>Creates a HealthCheck resource in the specified project using the data included in the request.

501

502

Args:

503

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

Dan O'Meara

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

[diff] [blame]

504

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

505

The object takes the form of:

506

Dan O'Meara

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

[diff] [blame]

507

{ # Represents a Health Check resource.

Bu Sun Kim

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

[diff] [blame]

508

#

509

# Google Compute Engine has two Health Check resources:

510

#

511

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

512

#

513

# Internal HTTP(S) load balancers use regional health checks. All other types of GCP load balancers and managed instance group auto-healing use global health checks. For more information, read Health Check Concepts.

514

#

515

# To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.

516

"checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.

517

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

518

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

Bu Sun Kim

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

[diff] [blame]

519

"grpcHealthCheck": {

520

"grpcServiceName": "A String", # The gRPC service name for the health check. This field is optional. The value of grpc_service_name has the following meanings by convention:

521

# - Empty service_name means the overall status of all services at the backend.

522

# - Non-empty service_name means the health of that gRPC service, as defined by the owner of the service.

523

# The grpc_service_name can only be ASCII.

524

"port": 42, # The port number for the health check request. Must be specified if port_name and port_specification are not set or if port_specification is USE_FIXED_PORT. Valid values are 1 through 65535.

525

"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. The port_name should conform to RFC1035.

526

"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:

527

# USE_FIXED_PORT: The port number in port is used for health checking.

528

# USE_NAMED_PORT: The portName is used for health checking.

529

# USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.

530

#

531

#

532

# If not specified, gRPC health check follows behavior specified in port and portName fields.

533

},

Bu Sun Kim

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

[diff] [blame]

534

"healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.

535

"http2HealthCheck": {

536

"host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.

537

"port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.

538

"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

539

"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:

540

# USE_FIXED_PORT: The port number in port is used for health checking.

541

# USE_NAMED_PORT: The portName is used for health checking.

542

# USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.

543

#

544

#

545

# If not specified, HTTP2 health check follows behavior specified in port and portName fields.

546

"proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

547

"requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.

548

"response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.

549

},

550

"httpHealthCheck": {

551

"host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.

552

"port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.

553

"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

554

"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:

555

# USE_FIXED_PORT: The port number in port is used for health checking.

556

# USE_NAMED_PORT: The portName is used for health checking.

557

# USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.

558

#

559

#

560

# If not specified, HTTP health check follows behavior specified in port and portName fields.

561

"proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

562

"requestPath": "A String", # The request path of the HTTP health check request. The default value is /.

563

"response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.

564

},

565

"httpsHealthCheck": {

566

"host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.

567

"port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.

568

"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

569

"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:

570

# USE_FIXED_PORT: The port number in port is used for health checking.

571

# USE_NAMED_PORT: The portName is used for health checking.

572

# USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.

573

#

574

#

575

# If not specified, HTTPS health check follows behavior specified in port and portName fields.

576

"proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

577

"requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.

578

"response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.

579

},

580

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

581

"kind": "compute#healthCheck", # Type of the resource.

582

"logConfig": { # Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. # Configure logging on this health check.

583

"enable": True or False, # Indicates whether or not to export logs. This is false by default, which means no health check logging will be done.

584

},

585

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

586

"region": "A String", # [Output Only] Region where the health check resides. Not applicable to global health checks.

587

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

588

"sslHealthCheck": {

589

"port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.

590

"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

591

"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:

592

# USE_FIXED_PORT: The port number in port is used for health checking.

593

# USE_NAMED_PORT: The portName is used for health checking.

594

# USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.

595

#

596

#

597

# If not specified, SSL health check follows behavior specified in port and portName fields.

598

"proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

599

"request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.

600

"response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

601

},

602

"tcpHealthCheck": {

603

"port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.

604

"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

605

"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:

606

# USE_FIXED_PORT: The port number in port is used for health checking.

607

# USE_NAMED_PORT: The portName is used for health checking.

608

# USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.

609

#

610

#

611

# If not specified, TCP health check follows behavior specified in port and portName fields.

612

"proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

613

"request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.

614

"response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

615

},

616

"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.

617

"type": "A String", # Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.

618

"unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

619

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

620

Bu Sun Kim

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

[diff] [blame]

621

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.

622

623

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.

624

625

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

626

627

Returns:

628

An object of the form:

629

Bu Sun Kim

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

[diff] [blame]

630

{ # Represents an Operation resource.

631

#

Dan O'Meara

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

[diff] [blame]

632

# Google Compute Engine has three Operation resources:

633

#

634

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

635

#

Bu Sun Kim

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

[diff] [blame]

636

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

637

#

638

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

639

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

640

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

641

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

Bu Sun Kim

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

[diff] [blame]

642

#

Dan O'Meara

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

[diff] [blame]

643

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

644

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

645

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

646

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

647

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

648

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

649

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

650

{

Bu Sun Kim

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

[diff] [blame]

651

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

652

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

653

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

654

},

655

],

656

},

Bu Sun Kim

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

[diff] [blame]

657

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

658

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

659

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

660

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

661

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

662

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

663

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

664

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

665

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

666

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

667

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

668

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

669

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

670

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

671

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

672

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

673

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

674

{

675

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

676

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

677

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

678

{

679

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

680

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

681

},

682

],

683

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

684

},

685

],

686

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

691

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

692

<pre>Retrieves the list of HealthCheck resources available to the specified project.

693

694

Args:

695

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

Dan O'Meara

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

[diff] [blame]

696

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

697

Dan O'Meara

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

[diff] [blame]

698

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

699

Dan O'Meara

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

[diff] [blame]

700

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.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

701

Bu Sun Kim

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

[diff] [blame]

702

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

703

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

704

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

705

706

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.

707

708

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

709

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.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

710

711

Returns:

712

An object of the form:

713

714

{ # Contains a list of HealthCheck resources.

Bu Sun Kim

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

[diff] [blame]

715

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

716

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

Dan O'Meara

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

[diff] [blame]

717

{ # Represents a Health Check resource.

Bu Sun Kim

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

[diff] [blame]

718

#

719

# Google Compute Engine has two Health Check resources:

720

#

721

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

722

#

723

# Internal HTTP(S) load balancers use regional health checks. All other types of GCP load balancers and managed instance group auto-healing use global health checks. For more information, read Health Check Concepts.

724

#

725

# To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.

726

"checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.

727

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

728

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

Bu Sun Kim

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

[diff] [blame]

729

"grpcHealthCheck": {

730

"grpcServiceName": "A String", # The gRPC service name for the health check. This field is optional. The value of grpc_service_name has the following meanings by convention:

731

# - Empty service_name means the overall status of all services at the backend.

732

# - Non-empty service_name means the health of that gRPC service, as defined by the owner of the service.

733

# The grpc_service_name can only be ASCII.

734

"port": 42, # The port number for the health check request. Must be specified if port_name and port_specification are not set or if port_specification is USE_FIXED_PORT. Valid values are 1 through 65535.

735

"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. The port_name should conform to RFC1035.

736

"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:

737

# USE_FIXED_PORT: The port number in port is used for health checking.

738

# USE_NAMED_PORT: The portName is used for health checking.

739

# USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.

740

#

741

#

742

# If not specified, gRPC health check follows behavior specified in port and portName fields.

743

},

Bu Sun Kim

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

[diff] [blame]

744

"healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.

745

"http2HealthCheck": {

746

"host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.

747

"port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.

748

"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

749

"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:

750

# USE_FIXED_PORT: The port number in port is used for health checking.

751

# USE_NAMED_PORT: The portName is used for health checking.

752

# USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.

753

#

754

#

755

# If not specified, HTTP2 health check follows behavior specified in port and portName fields.

756

"proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

757

"requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.

758

"response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

759

},

Bu Sun Kim

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

[diff] [blame]

760

"httpHealthCheck": {

761

"host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.

762

"port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.

763

"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

764

"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:

765

# USE_FIXED_PORT: The port number in port is used for health checking.

766

# USE_NAMED_PORT: The portName is used for health checking.

767

# USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.

768

#

769

#

770

# If not specified, HTTP health check follows behavior specified in port and portName fields.

771

"proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

772

"requestPath": "A String", # The request path of the HTTP health check request. The default value is /.

773

"response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.

774

},

775

"httpsHealthCheck": {

776

"host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.

777

"port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.

778

"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

779

"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:

780

# USE_FIXED_PORT: The port number in port is used for health checking.

781

# USE_NAMED_PORT: The portName is used for health checking.

782

# USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.

783

#

784

#

785

# If not specified, HTTPS health check follows behavior specified in port and portName fields.

786

"proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

787

"requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.

788

"response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.

789

},

790

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

791

"kind": "compute#healthCheck", # Type of the resource.

792

"logConfig": { # Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. # Configure logging on this health check.

793

"enable": True or False, # Indicates whether or not to export logs. This is false by default, which means no health check logging will be done.

794

},

795

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

796

"region": "A String", # [Output Only] Region where the health check resides. Not applicable to global health checks.

797

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

798

"sslHealthCheck": {

799

"port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.

800

"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

801

"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:

802

# USE_FIXED_PORT: The port number in port is used for health checking.

803

# USE_NAMED_PORT: The portName is used for health checking.

804

# USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.

805

#

806

#

807

# If not specified, SSL health check follows behavior specified in port and portName fields.

808

"proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

809

"request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.

810

"response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

811

},

812

"tcpHealthCheck": {

813

"port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.

814

"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

815

"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:

816

# USE_FIXED_PORT: The port number in port is used for health checking.

817

# USE_NAMED_PORT: The portName is used for health checking.

818

# USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.

819

#

820

#

821

# If not specified, TCP health check follows behavior specified in port and portName fields.

822

"proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

823

"request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.

824

"response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

825

},

826

"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.

827

"type": "A String", # Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.

828

"unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

829

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

830

],

Bu Sun Kim

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

[diff] [blame]

831

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

832

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

833

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

834

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

835

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

836

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

837

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

Bu Sun Kim

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

[diff] [blame]

838

{

Bu Sun Kim

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

[diff] [blame]

839

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

840

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

841

},

842

],

Bu Sun Kim

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

[diff] [blame]

843

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

Bu Sun Kim

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

[diff] [blame]

844

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

850

<pre>Retrieves the next page of results.

851

852

Args:

853

previous_request: The request for the previous page. (required)

854

previous_response: The response from the request for the previous page. (required)

855

856

Returns:

Bu Sun Kim

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

[diff] [blame]

857

A request object that you can call 'execute()' on to request the next

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

858

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

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

[diff] [blame]

863

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

Bu Sun Kim

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

[diff] [blame]

864

<pre>Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

865

866

Args:

867

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

Sai Cheemalapati

4ba8c23

2017-06-06 18:46:08 -0400

[diff] [blame]

868

healthCheck: string, Name of the HealthCheck resource to patch. (required)

Dan O'Meara

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

[diff] [blame]

869

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

870

The object takes the form of:

871

Dan O'Meara

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

[diff] [blame]

872

{ # Represents a Health Check resource.

Bu Sun Kim

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

[diff] [blame]

873

#

874

# Google Compute Engine has two Health Check resources:

875

#

876

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

877

#

878

# Internal HTTP(S) load balancers use regional health checks. All other types of GCP load balancers and managed instance group auto-healing use global health checks. For more information, read Health Check Concepts.

879

#

880

# To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.

881

"checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.

882

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

883

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

Bu Sun Kim

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

[diff] [blame]

884

"grpcHealthCheck": {

885

"grpcServiceName": "A String", # The gRPC service name for the health check. This field is optional. The value of grpc_service_name has the following meanings by convention:

886

# - Empty service_name means the overall status of all services at the backend.

887

# - Non-empty service_name means the health of that gRPC service, as defined by the owner of the service.

888

# The grpc_service_name can only be ASCII.

889

"port": 42, # The port number for the health check request. Must be specified if port_name and port_specification are not set or if port_specification is USE_FIXED_PORT. Valid values are 1 through 65535.

890

"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. The port_name should conform to RFC1035.

891

"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:

892

# USE_FIXED_PORT: The port number in port is used for health checking.

893

# USE_NAMED_PORT: The portName is used for health checking.

894

# USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.

895

#

896

#

897

# If not specified, gRPC health check follows behavior specified in port and portName fields.

898

},

Bu Sun Kim

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

[diff] [blame]

899

"healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.

900

"http2HealthCheck": {

901

"host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.

902

"port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.

903

"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

904

"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:

905

# USE_FIXED_PORT: The port number in port is used for health checking.

906

# USE_NAMED_PORT: The portName is used for health checking.

907

# USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.

908

#

909

#

910

# If not specified, HTTP2 health check follows behavior specified in port and portName fields.

911

"proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

912

"requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.

913

"response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.

914

},

915

"httpHealthCheck": {

916

"host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.

917

"port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.

918

"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

919

"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:

920

# USE_FIXED_PORT: The port number in port is used for health checking.

921

# USE_NAMED_PORT: The portName is used for health checking.

922

# USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.

923

#

924

#

925

# If not specified, HTTP health check follows behavior specified in port and portName fields.

926

"proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

927

"requestPath": "A String", # The request path of the HTTP health check request. The default value is /.

928

"response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.

929

},

930

"httpsHealthCheck": {

931

"host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.

932

"port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.

933

"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

934

"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:

935

# USE_FIXED_PORT: The port number in port is used for health checking.

936

# USE_NAMED_PORT: The portName is used for health checking.

937

# USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.

938

#

939

#

940

# If not specified, HTTPS health check follows behavior specified in port and portName fields.

941

"proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

942

"requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.

943

"response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.

944

},

945

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

946

"kind": "compute#healthCheck", # Type of the resource.

947

"logConfig": { # Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. # Configure logging on this health check.

948

"enable": True or False, # Indicates whether or not to export logs. This is false by default, which means no health check logging will be done.

949

},

950

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

951

"region": "A String", # [Output Only] Region where the health check resides. Not applicable to global health checks.

952

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

953

"sslHealthCheck": {

954

"port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.

955

"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

956

"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:

957

# USE_FIXED_PORT: The port number in port is used for health checking.

958

# USE_NAMED_PORT: The portName is used for health checking.

959

# USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.

960

#

961

#

962

# If not specified, SSL health check follows behavior specified in port and portName fields.

963

"proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

964

"request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.

965

"response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

966

},

967

"tcpHealthCheck": {

968

"port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.

969

"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

970

"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:

971

# USE_FIXED_PORT: The port number in port is used for health checking.

972

# USE_NAMED_PORT: The portName is used for health checking.

973

# USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.

974

#

975

#

976

# If not specified, TCP health check follows behavior specified in port and portName fields.

977

"proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

978

"request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.

979

"response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

980

},

981

"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.

982

"type": "A String", # Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.

983

"unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

984

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

985

Bu Sun Kim

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

[diff] [blame]

986

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.

987

988

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.

989

990

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

991

992

Returns:

993

An object of the form:

994

Bu Sun Kim

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

[diff] [blame]

995

{ # Represents an Operation resource.

996

#

Dan O'Meara

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

[diff] [blame]

997

# Google Compute Engine has three Operation resources:

998

#

999

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

1000

#

Bu Sun Kim

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

[diff] [blame]

1001

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

1002

#

1003

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

1004

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

1005

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

1006

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

Bu Sun Kim

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

[diff] [blame]

1007

#

Dan O'Meara

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

[diff] [blame]

1008

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

1009

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

1010

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

1011

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

1012

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

1013

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

1014

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1015

{

Bu Sun Kim

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

[diff] [blame]

1016

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

1017

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

1018

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1019

},

1020

],

1021

},

Bu Sun Kim

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

[diff] [blame]

1022

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

1023

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

1024

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

1025

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

1026

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

1027

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

1028

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

1029

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

1030

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

1031

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

1032

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

1033

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

1034

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

1035

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

1036

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

1037

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

1038

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

1039

{

1040

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

1041

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

1042

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

1043

{

1044

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

1045

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

1046

},

1047

],

1048

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

1049

},

1050

],

1051

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

1056

<code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1057

<pre>Returns permissions that a caller has on the specified resource.

1058

1059

Args:

1060

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

Bu Sun Kim

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

[diff] [blame]

1061

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

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

[diff] [blame]

1062

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1063

The object takes the form of:

1064

1065

{

Bu Sun Kim

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

[diff] [blame]

1066

"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.

1067

"A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

],

}

Returns:

An object of the form:

1074

1075

{

Bu Sun Kim

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

[diff] [blame]

1076

"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.

1077

"A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

],

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

1083

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1084

<pre>Updates a HealthCheck resource in the specified project using the data included in the request.

1085

1086

Args:

1087

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

1088

healthCheck: string, Name of the HealthCheck resource to update. (required)

Dan O'Meara

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

[diff] [blame]

1089

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1090

The object takes the form of:

1091

Dan O'Meara

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

[diff] [blame]

1092

{ # Represents a Health Check resource.

Bu Sun Kim

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

[diff] [blame]

1093

#

1094

# Google Compute Engine has two Health Check resources:

1095

#

1096

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

1097

#

1098

# Internal HTTP(S) load balancers use regional health checks. All other types of GCP load balancers and managed instance group auto-healing use global health checks. For more information, read Health Check Concepts.

1099

#

1100

# To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.

1101

"checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.

1102

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

1103

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

Bu Sun Kim

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

[diff] [blame]

1104

"grpcHealthCheck": {

1105

"grpcServiceName": "A String", # The gRPC service name for the health check. This field is optional. The value of grpc_service_name has the following meanings by convention:

1106

# - Empty service_name means the overall status of all services at the backend.

1107

# - Non-empty service_name means the health of that gRPC service, as defined by the owner of the service.

1108

# The grpc_service_name can only be ASCII.

1109

"port": 42, # The port number for the health check request. Must be specified if port_name and port_specification are not set or if port_specification is USE_FIXED_PORT. Valid values are 1 through 65535.

1110

"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. The port_name should conform to RFC1035.

1111

"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:

1112

# USE_FIXED_PORT: The port number in port is used for health checking.

1113

# USE_NAMED_PORT: The portName is used for health checking.

1114

# USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.

1115

#

1116

#

1117

# If not specified, gRPC health check follows behavior specified in port and portName fields.

1118

},

Bu Sun Kim

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

[diff] [blame]

1119

"healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.

1120

"http2HealthCheck": {

1121

"host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.

1122

"port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.

1123

"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

1124

"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:

1125

# USE_FIXED_PORT: The port number in port is used for health checking.

1126

# USE_NAMED_PORT: The portName is used for health checking.

1127

# USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.

1128

#

1129

#

1130

# If not specified, HTTP2 health check follows behavior specified in port and portName fields.

1131

"proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

1132

"requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.

1133

"response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.

1134

},

1135

"httpHealthCheck": {

1136

"host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.

1137

"port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.

1138

"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

1139

"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:

1140

# USE_FIXED_PORT: The port number in port is used for health checking.

1141

# USE_NAMED_PORT: The portName is used for health checking.

1142

# USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.

1143

#

1144

#

1145

# If not specified, HTTP health check follows behavior specified in port and portName fields.

1146

"proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

1147

"requestPath": "A String", # The request path of the HTTP health check request. The default value is /.

1148

"response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.

1149

},

1150

"httpsHealthCheck": {

1151

"host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.

1152

"port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.

1153

"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

1154

"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:

1155

# USE_FIXED_PORT: The port number in port is used for health checking.

1156

# USE_NAMED_PORT: The portName is used for health checking.

1157

# USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.

1158

#

1159

#

1160

# If not specified, HTTPS health check follows behavior specified in port and portName fields.

1161

"proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

1162

"requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.

1163

"response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.

1164

},

1165

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

1166

"kind": "compute#healthCheck", # Type of the resource.

1167

"logConfig": { # Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. # Configure logging on this health check.

1168

"enable": True or False, # Indicates whether or not to export logs. This is false by default, which means no health check logging will be done.

1169

},

1170

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

1171

"region": "A String", # [Output Only] Region where the health check resides. Not applicable to global health checks.

1172

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

1173

"sslHealthCheck": {

1174

"port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.

1175

"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

1176

"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:

1177

# USE_FIXED_PORT: The port number in port is used for health checking.

1178

# USE_NAMED_PORT: The portName is used for health checking.

1179

# USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.

1180

#

1181

#

1182

# If not specified, SSL health check follows behavior specified in port and portName fields.

1183

"proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

1184

"request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.

1185

"response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

1186

},

1187

"tcpHealthCheck": {

1188

"port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.

1189

"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

1190

"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:

1191

# USE_FIXED_PORT: The port number in port is used for health checking.

1192

# USE_NAMED_PORT: The portName is used for health checking.

1193

# USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.

1194

#

1195

#

1196

# If not specified, TCP health check follows behavior specified in port and portName fields.

1197

"proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

1198

"request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.

1199

"response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

1200

},

1201

"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.

1202

"type": "A String", # Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.

1203

"unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

1204

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1205

Bu Sun Kim

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

[diff] [blame]

1206

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.

1207

1208

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.

1209

1210

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1211

1212

Returns:

1213

An object of the form:

1214

Bu Sun Kim

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

[diff] [blame]

1215

{ # Represents an Operation resource.

1216

#

Dan O'Meara

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

[diff] [blame]

1217

# Google Compute Engine has three Operation resources:

1218

#

1219

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

1220

#

Bu Sun Kim

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

[diff] [blame]

1221

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

1222

#

1223

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

1224

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

1225

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

1226

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

Bu Sun Kim

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

[diff] [blame]

1227

#

Dan O'Meara

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

[diff] [blame]

1228

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

1229

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

1230

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

1231

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

1232

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

1233

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

1234

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1235

{

Bu Sun Kim

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

[diff] [blame]

1236

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

1237

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

1238

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1239

},

1240

],

1241

},

Bu Sun Kim