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