| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.regionHealthChecks.html">regionHealthChecks</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 78 | <code><a href="#close">close()</a></code></p> |
| 79 | <p class="firstline">Close httplib2 connections.</p> |
| 80 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 81 | <code><a href="#delete">delete(project, region, healthCheck, requestId=None)</a></code></p> |
| 82 | <p class="firstline">Deletes the specified HealthCheck resource.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#get">get(project, region, healthCheck)</a></code></p> |
| 85 | <p class="firstline">Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#insert">insert(project, region, body=None, requestId=None)</a></code></p> |
| 88 | <p class="firstline">Creates a HealthCheck resource in the specified project using the data included in the request.</p> |
| 89 | <p class="toc_element"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 90 | <code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 91 | <p class="firstline">Retrieves the list of HealthCheck resources available to the specified project.</p> |
| 92 | <p class="toc_element"> |
| 93 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 94 | <p class="firstline">Retrieves the next page of results.</p> |
| 95 | <p class="toc_element"> |
| 96 | <code><a href="#patch">patch(project, region, healthCheck, body=None, requestId=None)</a></code></p> |
| 97 | <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> |
| 98 | <p class="toc_element"> |
| 99 | <code><a href="#update">update(project, region, healthCheck, body=None, requestId=None)</a></code></p> |
| 100 | <p class="firstline">Updates a HealthCheck resource in the specified project using the data included in the request.</p> |
| 101 | <h3>Method Details</h3> |
| 102 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 103 | <code class="details" id="close">close()</code> |
| 104 | <pre>Close httplib2 connections.</pre> |
| 105 | </div> |
| 106 | |
| 107 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 108 | <code class="details" id="delete">delete(project, region, healthCheck, requestId=None)</code> |
| 109 | <pre>Deletes the specified HealthCheck resource. |
| 110 | |
| 111 | Args: |
| 112 | project: string, Project ID for this request. (required) |
| 113 | region: string, Name of the region scoping this request. (required) |
| 114 | healthCheck: string, Name of the HealthCheck resource to delete. (required) |
| 115 | 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. |
| 116 | |
| 117 | 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. |
| 118 | |
| 119 | The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
| 120 | |
| 121 | Returns: |
| 122 | An object of the form: |
| 123 | |
| 124 | { # Represents an Operation resource. |
| 125 | # |
| 126 | # Google Compute Engine has three Operation resources: |
| 127 | # |
| 128 | # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) |
| 129 | # |
| 130 | # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. |
| 131 | # |
| 132 | # Operations can be global, regional or zonal. |
| 133 | # - For global operations, use the `globalOperations` resource. |
| 134 | # - For regional operations, use the `regionOperations` resource. |
| 135 | # - For zonal operations, use the `zonalOperations` resource. |
| 136 | # |
| 137 | # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==) |
| 138 | "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. |
| 139 | "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| 140 | "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| 141 | "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| 142 | "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| 143 | "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| 144 | { |
| 145 | "code": "A String", # [Output Only] The error type identifier for this error. |
| 146 | "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| 147 | "message": "A String", # [Output Only] An optional, human-readable error message. |
| 148 | }, |
| 149 | ], |
| 150 | }, |
| 151 | "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. |
| 152 | "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. |
| 153 | "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. |
| 154 | "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| 155 | "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. |
| 156 | "name": "A String", # [Output Only] Name of the operation. |
| 157 | "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. |
| 158 | "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. |
| 159 | "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
| 160 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 161 | "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| 162 | "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. |
| 163 | "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| 164 | "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| 165 | "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. |
| 166 | "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. |
| 167 | "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| 168 | { |
| 169 | "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. |
| 170 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| 171 | # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| 172 | { |
| 173 | "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). |
| 174 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 175 | }, |
| 176 | ], |
| 177 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 178 | }, |
| 179 | ], |
| 180 | "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
| 181 | }</pre> |
| 182 | </div> |
| 183 | |
| 184 | <div class="method"> |
| 185 | <code class="details" id="get">get(project, region, healthCheck)</code> |
| 186 | <pre>Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request. |
| 187 | |
| 188 | Args: |
| 189 | project: string, Project ID for this request. (required) |
| 190 | region: string, Name of the region scoping this request. (required) |
| 191 | healthCheck: string, Name of the HealthCheck resource to return. (required) |
| 192 | |
| 193 | Returns: |
| 194 | An object of the form: |
| 195 | |
| 196 | { # Represents a Health Check resource. |
| 197 | # |
| 198 | # Google Compute Engine has two Health Check resources: |
| 199 | # |
| 200 | # * [Global](/compute/docs/reference/rest/{$api_version}/healthChecks) * [Regional](/compute/docs/reference/rest/{$api_version}/regionHealthChecks) |
| 201 | # |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 202 | # Internal HTTP(S) load balancers must use regional health checks (`compute.v1.regionHealthChecks`). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 203 | # |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 204 | # Traffic Director must use global health checks (`compute.v1.HealthChecks`). |
| 205 | # |
| 206 | # Internal TCP/UDP load balancers can use either regional or global health checks (`compute.v1.regionHealthChecks` or `compute.v1.HealthChecks`). |
| 207 | # |
| 208 | # External HTTP(S), TCP proxy, and SSL proxy load balancers as well as managed instance group auto-healing must use global health checks (`compute.v1.HealthChecks`). |
| 209 | # |
| 210 | # Network load balancers must use legacy HTTP health checks (httpHealthChecks). |
| 211 | # |
| 212 | # For more information, see Health checks overview. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 213 | "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds. |
| 214 | "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format. |
| 215 | "description": "A String", # An optional description of this resource. Provide this property when you create the resource. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 216 | "grpcHealthCheck": { |
| 217 | "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: |
| 218 | # - Empty service_name means the overall status of all services at the backend. |
| 219 | # - Non-empty service_name means the health of that gRPC service, as defined by the owner of the service. |
| 220 | # The grpc_service_name can only be ASCII. |
| 221 | "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. |
| 222 | "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. |
| 223 | "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: |
| 224 | # USE_FIXED_PORT: The port number in port is used for health checking. |
| 225 | # USE_NAMED_PORT: The portName is used for health checking. |
| 226 | # 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. |
| 227 | # |
| 228 | # |
| 229 | # If not specified, gRPC health check follows behavior specified in port and portName fields. |
| 230 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 231 | "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. |
| 232 | "http2HealthCheck": { |
| 233 | "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. |
| 234 | "port": 42, # The TCP port number for the health check request. The default value is 443. 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, HTTP2 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 | "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /. |
| 245 | "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. |
| 246 | }, |
| 247 | "httpHealthCheck": { |
| 248 | "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. |
| 249 | "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. |
| 250 | "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. |
| 251 | "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: |
| 252 | # USE_FIXED_PORT: The port number in port is used for health checking. |
| 253 | # USE_NAMED_PORT: The portName is used for health checking. |
| 254 | # 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. |
| 255 | # |
| 256 | # |
| 257 | # If not specified, HTTP health check follows behavior specified in port and portName fields. |
| 258 | "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. |
| 259 | "requestPath": "A String", # The request path of the HTTP health check request. The default value is /. |
| 260 | "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. |
| 261 | }, |
| 262 | "httpsHealthCheck": { |
| 263 | "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. |
| 264 | "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. |
| 265 | "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. |
| 266 | "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: |
| 267 | # USE_FIXED_PORT: The port number in port is used for health checking. |
| 268 | # USE_NAMED_PORT: The portName is used for health checking. |
| 269 | # 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. |
| 270 | # |
| 271 | # |
| 272 | # If not specified, HTTPS health check follows behavior specified in port and portName fields. |
| 273 | "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. |
| 274 | "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /. |
| 275 | "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. |
| 276 | }, |
| 277 | "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| 278 | "kind": "compute#healthCheck", # Type of the resource. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 279 | "logConfig": { # Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. # Configure logging on this health check. |
| 280 | "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. |
| 281 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 282 | "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. |
| 283 | "region": "A String", # [Output Only] Region where the health check resides. Not applicable to global health checks. |
| 284 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 285 | "sslHealthCheck": { |
| 286 | "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. |
| 287 | "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. |
| 288 | "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: |
| 289 | # USE_FIXED_PORT: The port number in port is used for health checking. |
| 290 | # USE_NAMED_PORT: The portName is used for health checking. |
| 291 | # 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. |
| 292 | # |
| 293 | # |
| 294 | # If not specified, SSL health check follows behavior specified in port and portName fields. |
| 295 | "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. |
| 296 | "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. |
| 297 | "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. |
| 298 | }, |
| 299 | "tcpHealthCheck": { |
| 300 | "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. |
| 301 | "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. |
| 302 | "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: |
| 303 | # USE_FIXED_PORT: The port number in port is used for health checking. |
| 304 | # USE_NAMED_PORT: The portName is used for health checking. |
| 305 | # 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. |
| 306 | # |
| 307 | # |
| 308 | # If not specified, TCP health check follows behavior specified in port and portName fields. |
| 309 | "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. |
| 310 | "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. |
| 311 | "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. |
| 312 | }, |
| 313 | "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. |
| 314 | "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. |
| 315 | "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. |
| 316 | }</pre> |
| 317 | </div> |
| 318 | |
| 319 | <div class="method"> |
| 320 | <code class="details" id="insert">insert(project, region, body=None, requestId=None)</code> |
| 321 | <pre>Creates a HealthCheck resource in the specified project using the data included in the request. |
| 322 | |
| 323 | Args: |
| 324 | project: string, Project ID for this request. (required) |
| 325 | region: string, Name of the region scoping this request. (required) |
| 326 | body: object, The request body. |
| 327 | The object takes the form of: |
| 328 | |
| 329 | { # Represents a Health Check resource. |
| 330 | # |
| 331 | # Google Compute Engine has two Health Check resources: |
| 332 | # |
| 333 | # * [Global](/compute/docs/reference/rest/{$api_version}/healthChecks) * [Regional](/compute/docs/reference/rest/{$api_version}/regionHealthChecks) |
| 334 | # |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 335 | # Internal HTTP(S) load balancers must use regional health checks (`compute.v1.regionHealthChecks`). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 336 | # |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 337 | # Traffic Director must use global health checks (`compute.v1.HealthChecks`). |
| 338 | # |
| 339 | # Internal TCP/UDP load balancers can use either regional or global health checks (`compute.v1.regionHealthChecks` or `compute.v1.HealthChecks`). |
| 340 | # |
| 341 | # External HTTP(S), TCP proxy, and SSL proxy load balancers as well as managed instance group auto-healing must use global health checks (`compute.v1.HealthChecks`). |
| 342 | # |
| 343 | # Network load balancers must use legacy HTTP health checks (httpHealthChecks). |
| 344 | # |
| 345 | # For more information, see Health checks overview. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 346 | "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds. |
| 347 | "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format. |
| 348 | "description": "A String", # An optional description of this resource. Provide this property when you create the resource. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 349 | "grpcHealthCheck": { |
| 350 | "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: |
| 351 | # - Empty service_name means the overall status of all services at the backend. |
| 352 | # - Non-empty service_name means the health of that gRPC service, as defined by the owner of the service. |
| 353 | # The grpc_service_name can only be ASCII. |
| 354 | "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. |
| 355 | "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. |
| 356 | "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: |
| 357 | # USE_FIXED_PORT: The port number in port is used for health checking. |
| 358 | # USE_NAMED_PORT: The portName is used for health checking. |
| 359 | # 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. |
| 360 | # |
| 361 | # |
| 362 | # If not specified, gRPC health check follows behavior specified in port and portName fields. |
| 363 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 364 | "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. |
| 365 | "http2HealthCheck": { |
| 366 | "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. |
| 367 | "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. |
| 368 | "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. |
| 369 | "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: |
| 370 | # USE_FIXED_PORT: The port number in port is used for health checking. |
| 371 | # USE_NAMED_PORT: The portName is used for health checking. |
| 372 | # 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. |
| 373 | # |
| 374 | # |
| 375 | # If not specified, HTTP2 health check follows behavior specified in port and portName fields. |
| 376 | "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. |
| 377 | "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /. |
| 378 | "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. |
| 379 | }, |
| 380 | "httpHealthCheck": { |
| 381 | "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. |
| 382 | "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. |
| 383 | "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. |
| 384 | "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: |
| 385 | # USE_FIXED_PORT: The port number in port is used for health checking. |
| 386 | # USE_NAMED_PORT: The portName is used for health checking. |
| 387 | # 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. |
| 388 | # |
| 389 | # |
| 390 | # If not specified, HTTP health check follows behavior specified in port and portName fields. |
| 391 | "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. |
| 392 | "requestPath": "A String", # The request path of the HTTP health check request. The default value is /. |
| 393 | "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. |
| 394 | }, |
| 395 | "httpsHealthCheck": { |
| 396 | "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. |
| 397 | "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. |
| 398 | "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. |
| 399 | "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: |
| 400 | # USE_FIXED_PORT: The port number in port is used for health checking. |
| 401 | # USE_NAMED_PORT: The portName is used for health checking. |
| 402 | # 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. |
| 403 | # |
| 404 | # |
| 405 | # If not specified, HTTPS health check follows behavior specified in port and portName fields. |
| 406 | "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. |
| 407 | "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /. |
| 408 | "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. |
| 409 | }, |
| 410 | "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| 411 | "kind": "compute#healthCheck", # Type of the resource. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 412 | "logConfig": { # Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. # Configure logging on this health check. |
| 413 | "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. |
| 414 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 415 | "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. |
| 416 | "region": "A String", # [Output Only] Region where the health check resides. Not applicable to global health checks. |
| 417 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 418 | "sslHealthCheck": { |
| 419 | "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. |
| 420 | "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. |
| 421 | "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: |
| 422 | # USE_FIXED_PORT: The port number in port is used for health checking. |
| 423 | # USE_NAMED_PORT: The portName is used for health checking. |
| 424 | # 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. |
| 425 | # |
| 426 | # |
| 427 | # If not specified, SSL health check follows behavior specified in port and portName fields. |
| 428 | "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. |
| 429 | "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. |
| 430 | "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. |
| 431 | }, |
| 432 | "tcpHealthCheck": { |
| 433 | "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. |
| 434 | "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. |
| 435 | "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: |
| 436 | # USE_FIXED_PORT: The port number in port is used for health checking. |
| 437 | # USE_NAMED_PORT: The portName is used for health checking. |
| 438 | # 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. |
| 439 | # |
| 440 | # |
| 441 | # If not specified, TCP health check follows behavior specified in port and portName fields. |
| 442 | "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. |
| 443 | "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. |
| 444 | "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. |
| 445 | }, |
| 446 | "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. |
| 447 | "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. |
| 448 | "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. |
| 449 | } |
| 450 | |
| 451 | 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. |
| 452 | |
| 453 | 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. |
| 454 | |
| 455 | The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
| 456 | |
| 457 | Returns: |
| 458 | An object of the form: |
| 459 | |
| 460 | { # Represents an Operation resource. |
| 461 | # |
| 462 | # Google Compute Engine has three Operation resources: |
| 463 | # |
| 464 | # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) |
| 465 | # |
| 466 | # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. |
| 467 | # |
| 468 | # Operations can be global, regional or zonal. |
| 469 | # - For global operations, use the `globalOperations` resource. |
| 470 | # - For regional operations, use the `regionOperations` resource. |
| 471 | # - For zonal operations, use the `zonalOperations` resource. |
| 472 | # |
| 473 | # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==) |
| 474 | "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. |
| 475 | "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| 476 | "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| 477 | "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| 478 | "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| 479 | "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| 480 | { |
| 481 | "code": "A String", # [Output Only] The error type identifier for this error. |
| 482 | "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| 483 | "message": "A String", # [Output Only] An optional, human-readable error message. |
| 484 | }, |
| 485 | ], |
| 486 | }, |
| 487 | "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. |
| 488 | "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. |
| 489 | "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. |
| 490 | "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| 491 | "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. |
| 492 | "name": "A String", # [Output Only] Name of the operation. |
| 493 | "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. |
| 494 | "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. |
| 495 | "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
| 496 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 497 | "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| 498 | "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. |
| 499 | "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| 500 | "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| 501 | "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. |
| 502 | "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. |
| 503 | "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| 504 | { |
| 505 | "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. |
| 506 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| 507 | # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| 508 | { |
| 509 | "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). |
| 510 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 511 | }, |
| 512 | ], |
| 513 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 514 | }, |
| 515 | ], |
| 516 | "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
| 517 | }</pre> |
| 518 | </div> |
| 519 | |
| 520 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 521 | <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 522 | <pre>Retrieves the list of HealthCheck resources available to the specified project. |
| 523 | |
| 524 | Args: |
| 525 | project: string, Project ID for this request. (required) |
| 526 | region: string, Name of the region scoping this request. (required) |
| 527 | 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 `<`. |
| 528 | |
| 529 | For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. |
| 530 | |
| 531 | 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. |
| 532 | |
| 533 | 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) ``` |
| 534 | 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`) |
| 535 | orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. |
| 536 | |
| 537 | 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. |
| 538 | |
| 539 | Currently, only sorting by `name` or `creationTimestamp desc` is supported. |
| 540 | 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. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 541 | returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 542 | |
| 543 | Returns: |
| 544 | An object of the form: |
| 545 | |
| 546 | { # Contains a list of HealthCheck resources. |
| 547 | "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. |
| 548 | "items": [ # A list of HealthCheck resources. |
| 549 | { # Represents a Health Check resource. |
| 550 | # |
| 551 | # Google Compute Engine has two Health Check resources: |
| 552 | # |
| 553 | # * [Global](/compute/docs/reference/rest/{$api_version}/healthChecks) * [Regional](/compute/docs/reference/rest/{$api_version}/regionHealthChecks) |
| 554 | # |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 555 | # Internal HTTP(S) load balancers must use regional health checks (`compute.v1.regionHealthChecks`). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 556 | # |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 557 | # Traffic Director must use global health checks (`compute.v1.HealthChecks`). |
| 558 | # |
| 559 | # Internal TCP/UDP load balancers can use either regional or global health checks (`compute.v1.regionHealthChecks` or `compute.v1.HealthChecks`). |
| 560 | # |
| 561 | # External HTTP(S), TCP proxy, and SSL proxy load balancers as well as managed instance group auto-healing must use global health checks (`compute.v1.HealthChecks`). |
| 562 | # |
| 563 | # Network load balancers must use legacy HTTP health checks (httpHealthChecks). |
| 564 | # |
| 565 | # For more information, see Health checks overview. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 566 | "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds. |
| 567 | "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format. |
| 568 | "description": "A String", # An optional description of this resource. Provide this property when you create the resource. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 569 | "grpcHealthCheck": { |
| 570 | "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: |
| 571 | # - Empty service_name means the overall status of all services at the backend. |
| 572 | # - Non-empty service_name means the health of that gRPC service, as defined by the owner of the service. |
| 573 | # The grpc_service_name can only be ASCII. |
| 574 | "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. |
| 575 | "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. |
| 576 | "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: |
| 577 | # USE_FIXED_PORT: The port number in port is used for health checking. |
| 578 | # USE_NAMED_PORT: The portName is used for health checking. |
| 579 | # 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. |
| 580 | # |
| 581 | # |
| 582 | # If not specified, gRPC health check follows behavior specified in port and portName fields. |
| 583 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 584 | "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. |
| 585 | "http2HealthCheck": { |
| 586 | "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. |
| 587 | "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. |
| 588 | "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. |
| 589 | "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: |
| 590 | # USE_FIXED_PORT: The port number in port is used for health checking. |
| 591 | # USE_NAMED_PORT: The portName is used for health checking. |
| 592 | # 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. |
| 593 | # |
| 594 | # |
| 595 | # If not specified, HTTP2 health check follows behavior specified in port and portName fields. |
| 596 | "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. |
| 597 | "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /. |
| 598 | "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. |
| 599 | }, |
| 600 | "httpHealthCheck": { |
| 601 | "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. |
| 602 | "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. |
| 603 | "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. |
| 604 | "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: |
| 605 | # USE_FIXED_PORT: The port number in port is used for health checking. |
| 606 | # USE_NAMED_PORT: The portName is used for health checking. |
| 607 | # 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. |
| 608 | # |
| 609 | # |
| 610 | # If not specified, HTTP health check follows behavior specified in port and portName fields. |
| 611 | "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. |
| 612 | "requestPath": "A String", # The request path of the HTTP health check request. The default value is /. |
| 613 | "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. |
| 614 | }, |
| 615 | "httpsHealthCheck": { |
| 616 | "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. |
| 617 | "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. |
| 618 | "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. |
| 619 | "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: |
| 620 | # USE_FIXED_PORT: The port number in port is used for health checking. |
| 621 | # USE_NAMED_PORT: The portName is used for health checking. |
| 622 | # 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. |
| 623 | # |
| 624 | # |
| 625 | # If not specified, HTTPS health check follows behavior specified in port and portName fields. |
| 626 | "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. |
| 627 | "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /. |
| 628 | "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. |
| 629 | }, |
| 630 | "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| 631 | "kind": "compute#healthCheck", # Type of the resource. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 632 | "logConfig": { # Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. # Configure logging on this health check. |
| 633 | "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. |
| 634 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 635 | "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. |
| 636 | "region": "A String", # [Output Only] Region where the health check resides. Not applicable to global health checks. |
| 637 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 638 | "sslHealthCheck": { |
| 639 | "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. |
| 640 | "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. |
| 641 | "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: |
| 642 | # USE_FIXED_PORT: The port number in port is used for health checking. |
| 643 | # USE_NAMED_PORT: The portName is used for health checking. |
| 644 | # 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. |
| 645 | # |
| 646 | # |
| 647 | # If not specified, SSL health check follows behavior specified in port and portName fields. |
| 648 | "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. |
| 649 | "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. |
| 650 | "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. |
| 651 | }, |
| 652 | "tcpHealthCheck": { |
| 653 | "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. |
| 654 | "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. |
| 655 | "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: |
| 656 | # USE_FIXED_PORT: The port number in port is used for health checking. |
| 657 | # USE_NAMED_PORT: The portName is used for health checking. |
| 658 | # 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. |
| 659 | # |
| 660 | # |
| 661 | # If not specified, TCP health check follows behavior specified in port and portName fields. |
| 662 | "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. |
| 663 | "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. |
| 664 | "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. |
| 665 | }, |
| 666 | "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. |
| 667 | "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. |
| 668 | "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. |
| 669 | }, |
| 670 | ], |
| 671 | "kind": "compute#healthCheckList", # Type of resource. |
| 672 | "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. |
| 673 | "selfLink": "A String", # [Output Only] Server-defined URL for this resource. |
| 674 | "warning": { # [Output Only] Informational warning message. |
| 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 | }</pre> |
| 686 | </div> |
| 687 | |
| 688 | <div class="method"> |
| 689 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 690 | <pre>Retrieves the next page of results. |
| 691 | |
| 692 | Args: |
| 693 | previous_request: The request for the previous page. (required) |
| 694 | previous_response: The response from the request for the previous page. (required) |
| 695 | |
| 696 | Returns: |
| 697 | A request object that you can call 'execute()' on to request the next |
| 698 | page. Returns None if there are no more items in the collection. |
| 699 | </pre> |
| 700 | </div> |
| 701 | |
| 702 | <div class="method"> |
| 703 | <code class="details" id="patch">patch(project, region, healthCheck, body=None, requestId=None)</code> |
| 704 | <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. |
| 705 | |
| 706 | Args: |
| 707 | project: string, Project ID for this request. (required) |
| 708 | region: string, Name of the region scoping this request. (required) |
| 709 | healthCheck: string, Name of the HealthCheck resource to patch. (required) |
| 710 | body: object, The request body. |
| 711 | The object takes the form of: |
| 712 | |
| 713 | { # Represents a Health Check resource. |
| 714 | # |
| 715 | # Google Compute Engine has two Health Check resources: |
| 716 | # |
| 717 | # * [Global](/compute/docs/reference/rest/{$api_version}/healthChecks) * [Regional](/compute/docs/reference/rest/{$api_version}/regionHealthChecks) |
| 718 | # |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 719 | # Internal HTTP(S) load balancers must use regional health checks (`compute.v1.regionHealthChecks`). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 720 | # |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 721 | # Traffic Director must use global health checks (`compute.v1.HealthChecks`). |
| 722 | # |
| 723 | # Internal TCP/UDP load balancers can use either regional or global health checks (`compute.v1.regionHealthChecks` or `compute.v1.HealthChecks`). |
| 724 | # |
| 725 | # External HTTP(S), TCP proxy, and SSL proxy load balancers as well as managed instance group auto-healing must use global health checks (`compute.v1.HealthChecks`). |
| 726 | # |
| 727 | # Network load balancers must use legacy HTTP health checks (httpHealthChecks). |
| 728 | # |
| 729 | # For more information, see Health checks overview. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 730 | "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds. |
| 731 | "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format. |
| 732 | "description": "A String", # An optional description of this resource. Provide this property when you create the resource. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 733 | "grpcHealthCheck": { |
| 734 | "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: |
| 735 | # - Empty service_name means the overall status of all services at the backend. |
| 736 | # - Non-empty service_name means the health of that gRPC service, as defined by the owner of the service. |
| 737 | # The grpc_service_name can only be ASCII. |
| 738 | "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. |
| 739 | "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. |
| 740 | "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: |
| 741 | # USE_FIXED_PORT: The port number in port is used for health checking. |
| 742 | # USE_NAMED_PORT: The portName is used for health checking. |
| 743 | # 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. |
| 744 | # |
| 745 | # |
| 746 | # If not specified, gRPC health check follows behavior specified in port and portName fields. |
| 747 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 748 | "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. |
| 749 | "http2HealthCheck": { |
| 750 | "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. |
| 751 | "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. |
| 752 | "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. |
| 753 | "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: |
| 754 | # USE_FIXED_PORT: The port number in port is used for health checking. |
| 755 | # USE_NAMED_PORT: The portName is used for health checking. |
| 756 | # 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. |
| 757 | # |
| 758 | # |
| 759 | # If not specified, HTTP2 health check follows behavior specified in port and portName fields. |
| 760 | "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. |
| 761 | "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /. |
| 762 | "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. |
| 763 | }, |
| 764 | "httpHealthCheck": { |
| 765 | "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. |
| 766 | "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. |
| 767 | "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. |
| 768 | "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: |
| 769 | # USE_FIXED_PORT: The port number in port is used for health checking. |
| 770 | # USE_NAMED_PORT: The portName is used for health checking. |
| 771 | # 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. |
| 772 | # |
| 773 | # |
| 774 | # If not specified, HTTP health check follows behavior specified in port and portName fields. |
| 775 | "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. |
| 776 | "requestPath": "A String", # The request path of the HTTP health check request. The default value is /. |
| 777 | "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. |
| 778 | }, |
| 779 | "httpsHealthCheck": { |
| 780 | "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. |
| 781 | "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. |
| 782 | "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. |
| 783 | "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: |
| 784 | # USE_FIXED_PORT: The port number in port is used for health checking. |
| 785 | # USE_NAMED_PORT: The portName is used for health checking. |
| 786 | # 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. |
| 787 | # |
| 788 | # |
| 789 | # If not specified, HTTPS health check follows behavior specified in port and portName fields. |
| 790 | "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. |
| 791 | "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /. |
| 792 | "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. |
| 793 | }, |
| 794 | "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| 795 | "kind": "compute#healthCheck", # Type of the resource. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 796 | "logConfig": { # Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. # Configure logging on this health check. |
| 797 | "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. |
| 798 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 799 | "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. |
| 800 | "region": "A String", # [Output Only] Region where the health check resides. Not applicable to global health checks. |
| 801 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 802 | "sslHealthCheck": { |
| 803 | "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. |
| 804 | "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. |
| 805 | "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: |
| 806 | # USE_FIXED_PORT: The port number in port is used for health checking. |
| 807 | # USE_NAMED_PORT: The portName is used for health checking. |
| 808 | # 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. |
| 809 | # |
| 810 | # |
| 811 | # If not specified, SSL health check follows behavior specified in port and portName fields. |
| 812 | "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. |
| 813 | "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. |
| 814 | "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. |
| 815 | }, |
| 816 | "tcpHealthCheck": { |
| 817 | "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. |
| 818 | "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. |
| 819 | "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: |
| 820 | # USE_FIXED_PORT: The port number in port is used for health checking. |
| 821 | # USE_NAMED_PORT: The portName is used for health checking. |
| 822 | # 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. |
| 823 | # |
| 824 | # |
| 825 | # If not specified, TCP health check follows behavior specified in port and portName fields. |
| 826 | "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. |
| 827 | "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. |
| 828 | "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. |
| 829 | }, |
| 830 | "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. |
| 831 | "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. |
| 832 | "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. |
| 833 | } |
| 834 | |
| 835 | 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. |
| 836 | |
| 837 | 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. |
| 838 | |
| 839 | The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
| 840 | |
| 841 | Returns: |
| 842 | An object of the form: |
| 843 | |
| 844 | { # Represents an Operation resource. |
| 845 | # |
| 846 | # Google Compute Engine has three Operation resources: |
| 847 | # |
| 848 | # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) |
| 849 | # |
| 850 | # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. |
| 851 | # |
| 852 | # Operations can be global, regional or zonal. |
| 853 | # - For global operations, use the `globalOperations` resource. |
| 854 | # - For regional operations, use the `regionOperations` resource. |
| 855 | # - For zonal operations, use the `zonalOperations` resource. |
| 856 | # |
| 857 | # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==) |
| 858 | "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. |
| 859 | "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| 860 | "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| 861 | "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| 862 | "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| 863 | "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| 864 | { |
| 865 | "code": "A String", # [Output Only] The error type identifier for this error. |
| 866 | "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| 867 | "message": "A String", # [Output Only] An optional, human-readable error message. |
| 868 | }, |
| 869 | ], |
| 870 | }, |
| 871 | "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. |
| 872 | "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. |
| 873 | "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. |
| 874 | "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| 875 | "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. |
| 876 | "name": "A String", # [Output Only] Name of the operation. |
| 877 | "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. |
| 878 | "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. |
| 879 | "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
| 880 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 881 | "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| 882 | "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. |
| 883 | "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| 884 | "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| 885 | "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. |
| 886 | "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. |
| 887 | "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| 888 | { |
| 889 | "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. |
| 890 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| 891 | # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| 892 | { |
| 893 | "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). |
| 894 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 895 | }, |
| 896 | ], |
| 897 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 898 | }, |
| 899 | ], |
| 900 | "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
| 901 | }</pre> |
| 902 | </div> |
| 903 | |
| 904 | <div class="method"> |
| 905 | <code class="details" id="update">update(project, region, healthCheck, body=None, requestId=None)</code> |
| 906 | <pre>Updates a HealthCheck resource in the specified project using the data included in the request. |
| 907 | |
| 908 | Args: |
| 909 | project: string, Project ID for this request. (required) |
| 910 | region: string, Name of the region scoping this request. (required) |
| 911 | healthCheck: string, Name of the HealthCheck resource to update. (required) |
| 912 | body: object, The request body. |
| 913 | The object takes the form of: |
| 914 | |
| 915 | { # Represents a Health Check resource. |
| 916 | # |
| 917 | # Google Compute Engine has two Health Check resources: |
| 918 | # |
| 919 | # * [Global](/compute/docs/reference/rest/{$api_version}/healthChecks) * [Regional](/compute/docs/reference/rest/{$api_version}/regionHealthChecks) |
| 920 | # |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 921 | # Internal HTTP(S) load balancers must use regional health checks (`compute.v1.regionHealthChecks`). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 922 | # |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 923 | # Traffic Director must use global health checks (`compute.v1.HealthChecks`). |
| 924 | # |
| 925 | # Internal TCP/UDP load balancers can use either regional or global health checks (`compute.v1.regionHealthChecks` or `compute.v1.HealthChecks`). |
| 926 | # |
| 927 | # External HTTP(S), TCP proxy, and SSL proxy load balancers as well as managed instance group auto-healing must use global health checks (`compute.v1.HealthChecks`). |
| 928 | # |
| 929 | # Network load balancers must use legacy HTTP health checks (httpHealthChecks). |
| 930 | # |
| 931 | # For more information, see Health checks overview. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 932 | "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds. |
| 933 | "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format. |
| 934 | "description": "A String", # An optional description of this resource. Provide this property when you create the resource. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 935 | "grpcHealthCheck": { |
| 936 | "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: |
| 937 | # - Empty service_name means the overall status of all services at the backend. |
| 938 | # - Non-empty service_name means the health of that gRPC service, as defined by the owner of the service. |
| 939 | # The grpc_service_name can only be ASCII. |
| 940 | "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. |
| 941 | "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. |
| 942 | "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: |
| 943 | # USE_FIXED_PORT: The port number in port is used for health checking. |
| 944 | # USE_NAMED_PORT: The portName is used for health checking. |
| 945 | # 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. |
| 946 | # |
| 947 | # |
| 948 | # If not specified, gRPC health check follows behavior specified in port and portName fields. |
| 949 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 950 | "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. |
| 951 | "http2HealthCheck": { |
| 952 | "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. |
| 953 | "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. |
| 954 | "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. |
| 955 | "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: |
| 956 | # USE_FIXED_PORT: The port number in port is used for health checking. |
| 957 | # USE_NAMED_PORT: The portName is used for health checking. |
| 958 | # 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. |
| 959 | # |
| 960 | # |
| 961 | # If not specified, HTTP2 health check follows behavior specified in port and portName fields. |
| 962 | "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. |
| 963 | "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /. |
| 964 | "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. |
| 965 | }, |
| 966 | "httpHealthCheck": { |
| 967 | "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. |
| 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, HTTP 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 | "requestPath": "A String", # The request path of the HTTP health check request. The default value is /. |
| 979 | "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. |
| 980 | }, |
| 981 | "httpsHealthCheck": { |
| 982 | "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. |
| 983 | "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. |
| 984 | "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. |
| 985 | "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: |
| 986 | # USE_FIXED_PORT: The port number in port is used for health checking. |
| 987 | # USE_NAMED_PORT: The portName is used for health checking. |
| 988 | # 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. |
| 989 | # |
| 990 | # |
| 991 | # If not specified, HTTPS health check follows behavior specified in port and portName fields. |
| 992 | "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. |
| 993 | "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /. |
| 994 | "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. |
| 995 | }, |
| 996 | "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| 997 | "kind": "compute#healthCheck", # Type of the resource. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 998 | "logConfig": { # Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. # Configure logging on this health check. |
| 999 | "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. |
| 1000 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1001 | "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. |
| 1002 | "region": "A String", # [Output Only] Region where the health check resides. Not applicable to global health checks. |
| 1003 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 1004 | "sslHealthCheck": { |
| 1005 | "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. |
| 1006 | "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. |
| 1007 | "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: |
| 1008 | # USE_FIXED_PORT: The port number in port is used for health checking. |
| 1009 | # USE_NAMED_PORT: The portName is used for health checking. |
| 1010 | # 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. |
| 1011 | # |
| 1012 | # |
| 1013 | # If not specified, SSL health check follows behavior specified in port and portName fields. |
| 1014 | "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. |
| 1015 | "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. |
| 1016 | "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. |
| 1017 | }, |
| 1018 | "tcpHealthCheck": { |
| 1019 | "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. |
| 1020 | "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. |
| 1021 | "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: |
| 1022 | # USE_FIXED_PORT: The port number in port is used for health checking. |
| 1023 | # USE_NAMED_PORT: The portName is used for health checking. |
| 1024 | # 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. |
| 1025 | # |
| 1026 | # |
| 1027 | # If not specified, TCP health check follows behavior specified in port and portName fields. |
| 1028 | "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. |
| 1029 | "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. |
| 1030 | "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. |
| 1031 | }, |
| 1032 | "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. |
| 1033 | "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. |
| 1034 | "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. |
| 1035 | } |
| 1036 | |
| 1037 | 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. |
| 1038 | |
| 1039 | 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. |
| 1040 | |
| 1041 | The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
| 1042 | |
| 1043 | Returns: |
| 1044 | An object of the form: |
| 1045 | |
| 1046 | { # Represents an Operation resource. |
| 1047 | # |
| 1048 | # Google Compute Engine has three Operation resources: |
| 1049 | # |
| 1050 | # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) |
| 1051 | # |
| 1052 | # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. |
| 1053 | # |
| 1054 | # Operations can be global, regional or zonal. |
| 1055 | # - For global operations, use the `globalOperations` resource. |
| 1056 | # - For regional operations, use the `regionOperations` resource. |
| 1057 | # - For zonal operations, use the `zonalOperations` resource. |
| 1058 | # |
| 1059 | # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==) |
| 1060 | "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. |
| 1061 | "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| 1062 | "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| 1063 | "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| 1064 | "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| 1065 | "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| 1066 | { |
| 1067 | "code": "A String", # [Output Only] The error type identifier for this error. |
| 1068 | "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| 1069 | "message": "A String", # [Output Only] An optional, human-readable error message. |
| 1070 | }, |
| 1071 | ], |
| 1072 | }, |
| 1073 | "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. |
| 1074 | "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. |
| 1075 | "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. |
| 1076 | "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| 1077 | "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. |
| 1078 | "name": "A String", # [Output Only] Name of the operation. |
| 1079 | "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. |
| 1080 | "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. |
| 1081 | "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
| 1082 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 1083 | "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| 1084 | "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. |
| 1085 | "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| 1086 | "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| 1087 | "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. |
| 1088 | "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. |
| 1089 | "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| 1090 | { |
| 1091 | "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. |
| 1092 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| 1093 | # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| 1094 | { |
| 1095 | "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). |
| 1096 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 1097 | }, |
| 1098 | ], |
| 1099 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 1100 | }, |
| 1101 | ], |
| 1102 | "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
| 1103 | }</pre> |
| 1104 | </div> |
| 1105 | |
| 1106 | </body></html> |