| <html><body> | |
| <style> | |
| body, h1, h2, h3, div, span, p, pre, a { | |
| margin: 0; | |
| padding: 0; | |
| border: 0; | |
| font-weight: inherit; | |
| font-style: inherit; | |
| font-size: 100%; | |
| font-family: inherit; | |
| vertical-align: baseline; | |
| } | |
| body { | |
| font-size: 13px; | |
| padding: 1em; | |
| } | |
| h1 { | |
| font-size: 26px; | |
| margin-bottom: 1em; | |
| } | |
| h2 { | |
| font-size: 24px; | |
| margin-bottom: 1em; | |
| } | |
| h3 { | |
| font-size: 20px; | |
| margin-bottom: 1em; | |
| margin-top: 1em; | |
| } | |
| pre, code { | |
| line-height: 1.5; | |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; | |
| } | |
| pre { | |
| margin-top: 0.5em; | |
| } | |
| h1, h2, h3, p { | |
| font-family: Arial, sans serif; | |
| } | |
| h1, h2, h3 { | |
| border-bottom: solid #CCC 1px; | |
| } | |
| .toc_element { | |
| margin-top: 0.5em; | |
| } | |
| .firstline { | |
| margin-left: 2 em; | |
| } | |
| .method { | |
| margin-top: 1em; | |
| border: solid 1px #CCC; | |
| padding: 1em; | |
| background: #EEE; | |
| } | |
| .details { | |
| font-weight: bold; | |
| font-size: 14px; | |
| } | |
| </style> | |
| <h1><a href="compute_preview.html">Compute Engine API</a> . <a href="compute_preview.regionHealthChecks.html">regionHealthChecks</a></h1> | |
| <h2>Instance Methods</h2> | |
| <p class="toc_element"> | |
| <code><a href="#close">close()</a></code></p> | |
| <p class="firstline">Close httplib2 connections.</p> | |
| <p class="toc_element"> | |
| <code><a href="#delete">delete(project, region, healthCheck, requestId=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Deletes the specified HealthCheck resource.</p> | |
| <p class="toc_element"> | |
| <code><a href="#get">get(project, region, healthCheck, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Returns the specified HealthCheck resource.</p> | |
| <p class="toc_element"> | |
| <code><a href="#insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Creates a HealthCheck resource in the specified project using the data</p> | |
| <p class="toc_element"> | |
| <code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Retrieves the list of HealthCheck resources available to the specified</p> | |
| <p class="toc_element"> | |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> | |
| <p class="firstline">Retrieves the next page of results.</p> | |
| <p class="toc_element"> | |
| <code><a href="#patch">patch(project, region, healthCheck, body=None, requestId=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Updates a HealthCheck resource in the specified project using the data</p> | |
| <p class="toc_element"> | |
| <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Returns permissions that a caller has on the specified resource.</p> | |
| <p class="toc_element"> | |
| <code><a href="#update">update(project, region, healthCheck, body=None, requestId=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Updates a HealthCheck resource in the specified project using the data</p> | |
| <h3>Method Details</h3> | |
| <div class="method"> | |
| <code class="details" id="close">close()</code> | |
| <pre>Close httplib2 connections.</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="delete">delete(project, region, healthCheck, requestId=None, x__xgafv=None)</code> | |
| <pre>Deletes the specified HealthCheck resource. | |
| Args: | |
| project: string, Project ID for this request. (required) | |
| region: string, Name of the region scoping this request. (required) | |
| healthCheck: string, Name of the HealthCheck resource to delete. (required) | |
| 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. | |
| 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. | |
| The request ID must be | |
| a valid UUID with the exception that zero UUID is not supported | |
| (00000000-0000-0000-0000-000000000000). | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Represents an Operation resource. | |
| # | |
| # Google Compute Engine has three Operation resources: | |
| # | |
| # * [Global](/compute/docs/reference/rest/v1/globalOperations) | |
| # * [Regional](/compute/docs/reference/rest/v1/regionOperations) | |
| # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) | |
| # | |
| # You can use an operation resource to manage asynchronous API requests. | |
| # For more information, readHandling | |
| # API responses. | |
| # | |
| # Operations can be global, regional or zonal. | |
| # | |
| # - For global operations, use the `globalOperations` | |
| # resource. | |
| # - For regional operations, use the | |
| # `regionOperations` resource. | |
| # - For zonal operations, use | |
| # the `zoneOperations` resource. | |
| # | |
| # | |
| # | |
| # For more information, read | |
| # Global, Regional, and Zonal Resources. | |
| # | |
| # Note that completed Operation resources have a limited | |
| # retention period. | |
| "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. | |
| # Not present otherwise. | |
| "creationTimestamp": "A String", # [Deprecated] This field is deprecated. | |
| "description": "A String", # [Output Only] A textual description of the operation, which is | |
| # set when the operation is created. | |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 | |
| # text format. | |
| "error": { # [Output Only] If errors are generated during processing of the operation, | |
| # this field will be populated. | |
| "errors": [ # [Output Only] The array of errors encountered while processing this | |
| # operation. | |
| { # Represents a single error encountered during the processing of an | |
| # operation. | |
| "code": "A String", # [Output Only] The error type identifier for this error. | |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error | |
| # details. There is a set of defined message types to use for providing | |
| # details.The syntax depends on the error code. For example, | |
| # QuotaExceededInfo will have details when the error code is | |
| # QUOTA_EXCEEDED. | |
| { # Container for structured error details providing additional context | |
| # specific to the encountered error code. | |
| "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. | |
| # | |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it | |
| # is not enabled: | |
| # | |
| # { "reason": "API_DISABLED" | |
| # "domain": "googleapis.com" | |
| # "metadata": { | |
| # "resource": "projects/123", | |
| # "service": "pubsub.googleapis.com" | |
| # } | |
| # } | |
| # | |
| # This response indicates that the pubsub.googleapis.com API is not enabled. | |
| # | |
| # Example of an error that is returned when attempting to create a Spanner | |
| # instance in a region that is out of stock: | |
| # | |
| # { "reason": "STOCKOUT" | |
| # "domain": "spanner.googleapis.com", | |
| # "metadata": { | |
| # "availableRegions": "us-central1,us-east2" | |
| # } | |
| # } | |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain | |
| # is typically the registered service name of the tool or product that | |
| # generates the error. Example: "pubsub.googleapis.com". If the error is | |
| # generated by some common infrastructure, the error domain must be a | |
| # globally unique value that identifies the infrastructure. For Google API | |
| # infrastructure, the error domain is "googleapis.com". | |
| "metadatas": { # Additional structured details about this error. | |
| # | |
| # Keys must match a regular expression of `a-z+` but should | |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in | |
| # length. When identifying the current value of an exceeded limit, the units | |
| # should be contained in the key, not the value. For example, rather than | |
| # `{"instanceLimit": "100/request"}`, should be returned as, | |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of | |
| # instances that can be created in a single (batch) request. | |
| "a_key": "A String", | |
| }, | |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the | |
| # proximate cause of the error. Error reasons are unique within a particular | |
| # domain of errors. This should be at most 63 characters and match a | |
| # regular expression of `A-Z+[A-Z0-9]`, which represents | |
| # UPPER_SNAKE_CASE. | |
| }, | |
| "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. | |
| # | |
| # For example, if a quota check failed with an error indicating the calling | |
| # project hasn't enabled the accessed service, this can contain a URL pointing | |
| # directly to the right place in the developer console to flip the bit. | |
| "links": [ # URL(s) pointing to additional information on handling the current error. | |
| { # Describes a URL link. | |
| "description": "A String", # Describes what the link offers. | |
| "url": "A String", # The URL of the link. | |
| }, | |
| ], | |
| }, | |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. | |
| # which can be attached to an RPC error. | |
| "locale": "A String", # The locale used following the specification defined at | |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. | |
| # Examples are: "en-US", "fr-CH", "es-MX" | |
| "message": "A String", # The localized error message in the above locale. | |
| }, | |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. | |
| "dimensions": { # The map holding related quota dimensions. | |
| "a_key": "A String", | |
| }, | |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota | |
| # type or metric. | |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type | |
| # or metric. | |
| "limitName": "A String", # The name of the quota limit. | |
| "metricName": "A String", # The Compute Engine quota metric name. | |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. | |
| }, | |
| }, | |
| ], | |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. | |
| # This property is optional. | |
| "message": "A String", # [Output Only] An optional, human-readable error message. | |
| }, | |
| ], | |
| }, | |
| "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. | |
| "healthInfo": { # Health information. # Output only. The health information. | |
| "availabilitySloStatus": "A String", # Output only. The availability SLO status. | |
| "healthStatus": "A String", # Output only. The health status. | |
| "repairCategory": "A String", # Output only. The repair category. | |
| "unhealthyReason": "A String", # Output only. The reason for unhealthy status. | |
| "updateTime": "A String", # Output only. The time when health info was updated. | |
| }, | |
| }, | |
| "getVersionOperationMetadata": { | |
| "inlineSbomInfo": { | |
| "currentComponentVersions": { # A mapping of components to their currently-applied versions or other | |
| # appropriate identifiers. | |
| "a_key": "A String", | |
| }, | |
| "targetComponentVersions": { # A mapping of components to their target versions or other appropriate | |
| # identifiers. | |
| "a_key": "A String", | |
| }, | |
| }, | |
| }, | |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error | |
| # message that was returned, such as `NOT FOUND`. | |
| "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. | |
| "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is | |
| # defined by the server. | |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. | |
| # This value is inRFC3339 | |
| # text format. | |
| "instancesBulkInsertOperationMetadata": { | |
| "perLocationStatus": { # Status information per location (location name is key). | |
| # Example key: zones/us-central1-a | |
| "a_key": { | |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. | |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. | |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an | |
| # error. | |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information | |
| # if the flow is rolling forward or rolling back. | |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. | |
| }, | |
| }, | |
| }, | |
| "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. | |
| "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. | |
| }, | |
| "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for | |
| # Operation resources. | |
| "name": "A String", # [Output Only] Name of the operation. | |
| "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a | |
| # group of operations results from a `bulkInsert` API request. | |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, | |
| # `update`, or `delete`, and so on. | |
| "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. | |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only | |
| # applicable when performing regional operations. | |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. | |
| "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata, | |
| # this field will contain information on all underlying zonal actions and | |
| # their state. | |
| "clientOperationId": "A String", # [Output Only] The client operation id. | |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). | |
| # Example key: zones/us-central1-a | |
| "a_key": { | |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is | |
| # populated. | |
| # different programming environments, including REST APIs and RPC APIs. It is | |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains | |
| # three pieces of data: error code, error message, and error details. | |
| # | |
| # You can find out more about this error model and how to work with it in the | |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). | |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. | |
| "details": [ # A list of messages that carry the error details. There is a common set of | |
| # message types for APIs to use. | |
| { | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| ], | |
| "message": "A String", # A developer-facing error message, which should be in English. Any | |
| # user-facing error message should be localized and sent in the | |
| # google.rpc.Status.details field, or localized by the client. | |
| }, | |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: | |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. | |
| }, | |
| }, | |
| }, | |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. | |
| # This value is inRFC3339 | |
| # text format. | |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the | |
| # following: | |
| # `PENDING`, `RUNNING`, or `DONE`. | |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the | |
| # operation. | |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation | |
| # of the target resource. | |
| "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 disk | |
| # that the snapshot was created from. | |
| "user": "A String", # [Output Only] User who requested the operation, for example: | |
| # `user@example.com` or | |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. | |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the | |
| # operation, this field will be populated. | |
| { | |
| "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. | |
| "data": [ # [Output Only] Metadata about this warning in key: | |
| # value format. For example: | |
| # | |
| # "data": [ | |
| # { | |
| # "key": "scope", | |
| # "value": "zones/us-east1-d" | |
| # }] | |
| { | |
| "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). | |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. | |
| }, | |
| ], | |
| "message": "A String", # [Output Only] A human-readable description of the warning code. | |
| }, | |
| ], | |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only | |
| # applicable when performing per-zone operations. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="get">get(project, region, healthCheck, x__xgafv=None)</code> | |
| <pre>Returns the specified HealthCheck resource. | |
| Args: | |
| project: string, Project ID for this request. (required) | |
| region: string, Name of the region scoping this request. (required) | |
| healthCheck: string, Name of the HealthCheck resource to return. (required) | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Represents a health check resource. | |
| # | |
| # Google Compute Engine has two health check resources: | |
| # | |
| # * [Regional](/compute/docs/reference/rest/v1/regionHealthChecks) | |
| # * [Global](/compute/docs/reference/rest/v1/healthChecks) | |
| # | |
| # These health check resources can be used for load balancing and for | |
| # autohealing VMs in a managed instance group (MIG). | |
| # | |
| # **Load balancing** | |
| # | |
| # Health check requirements vary depending on the type of load balancer. For | |
| # details about the type of health check supported for | |
| # each load balancer and corresponding backend type, | |
| # see Health | |
| # checks overview: Load balancer guide. | |
| # | |
| # **Autohealing in MIGs** | |
| # | |
| # The health checks that you use for autohealing VMs in a MIG can be either | |
| # regional or global. For more information, see Set up an | |
| # application health check and autohealing. | |
| # | |
| # For more information, seeHealth checks | |
| # overview. | |
| "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 | |
| # seconds. | |
| "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp in3339 | |
| # text format. | |
| "description": "A String", # An optional description of this resource. Provide this property when you | |
| # create the resource. | |
| "grpcHealthCheck": { | |
| "grpcServiceName": "A String", # The gRPC service name for the health check. This field is optional. The | |
| # value of grpc_service_name has the following meanings by convention: | |
| # | |
| # - Empty service_name means the overall status of all services at the | |
| # backend. | |
| # | |
| # - Non-empty service_name means the health of that gRPC service, as defined | |
| # by the owner of the service. | |
| # | |
| # The grpc_service_name can only be ASCII. | |
| "port": 42, # The TCP port number to which the health check prober sends packets. Valid | |
| # values are 1 through 65535. | |
| "portName": "A String", # Not supported. | |
| "portSpecification": "A String", # Specifies how a port is selected for health checking. Can be one of the | |
| # following values: | |
| # USE_FIXED_PORT: Specifies a port number explicitly using theport field in the health check. Supported by backend services | |
| # for passthrough load balancers and backend services for proxy load | |
| # balancers. Not supported by target pools. The health check supports all | |
| # backends supported by the backend service provided the backend can be | |
| # health checked. For example, GCE_VM_IP network endpoint | |
| # groups, GCE_VM_IP_PORT network endpoint groups, and instance | |
| # group backends. | |
| # USE_NAMED_PORT: Not supported. | |
| # USE_SERVING_PORT: Provides an indirect method of specifying | |
| # the health check port by referring to the backend service. Only supported | |
| # by backend services for proxy load balancers. Not supported by target | |
| # pools. Not supported by backend services for passthrough load balancers. | |
| # Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group | |
| # backends. | |
| # | |
| # For GCE_VM_IP_PORT network endpoint group backends, the health | |
| # check uses the port number specified for each endpoint in the network | |
| # endpoint group. For instance group backends, the health check uses the | |
| # port number determined by looking up the backend service's named port in | |
| # the instance group's list of named ports. | |
| }, | |
| "grpcTlsHealthCheck": { | |
| "grpcServiceName": "A String", # The gRPC service name for the health check. This field is optional. The | |
| # value of grpc_service_name has the following meanings by convention: | |
| # | |
| # - Empty service_name means the overall status of all services at the | |
| # backend. | |
| # | |
| # - Non-empty service_name means the health of that gRPC service, as defined | |
| # by the owner of the service. | |
| # | |
| # The grpc_service_name can only be ASCII. | |
| "port": 42, # The TCP port number to which the health check prober sends packets. Valid | |
| # values are 1 through 65535. | |
| "portSpecification": "A String", # Specifies how a port is selected for health checking. Can be one of the | |
| # following values: | |
| # USE_FIXED_PORT: Specifies a port number explicitly using theport field in the health check. Supported by backend services | |
| # for passthrough load balancers and backend services for proxy load | |
| # balancers. Not supported by target pools. The health check supports all | |
| # backends supported by the backend service provided the backend can be | |
| # health checked. For example, GCE_VM_IP network endpoint | |
| # groups, GCE_VM_IP_PORT network endpoint groups, and instance | |
| # group backends. | |
| # USE_NAMED_PORT: Not supported. | |
| # USE_SERVING_PORT: Provides an indirect method of specifying | |
| # the health check port by referring to the backend service. Only supported | |
| # by backend services for proxy load balancers. Not supported by target | |
| # pools. Not supported by backend services for passthrough load balancers. | |
| # Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group | |
| # backends. | |
| # | |
| # For GCE_VM_IP_PORT network endpoint group backends, the health | |
| # check uses the port number specified for each endpoint in the network | |
| # endpoint group. For instance group backends, the health check uses the | |
| # port number determined by looking up the backend service's named port in | |
| # the instance group's list of named ports. | |
| }, | |
| "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this | |
| # many consecutive successes. The default value is 2. | |
| "http2HealthCheck": { | |
| "host": "A String", # The value of the host header in the HTTP/2 health check request. If left | |
| # empty (default value), the host header is set to the destination IP address | |
| # to which health check packets are sent. The destination IP address depends | |
| # on the type of load balancer. For details, see: | |
| # https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest | |
| "port": 42, # The TCP port number to which the health check prober sends packets. The | |
| # default value is 443. Valid values are 1 through65535. | |
| "portName": "A String", # Not supported. | |
| "portSpecification": "A String", # Specifies how a port is selected for health checking. Can be one of the | |
| # following values: | |
| # USE_FIXED_PORT: Specifies a port number explicitly using theport field in the health check. Supported by backend services | |
| # for passthrough load balancers and backend services for proxy load | |
| # balancers. Not supported by target pools. The health check supports all | |
| # backends supported by the backend service provided the backend can be | |
| # health checked. For example, GCE_VM_IP network endpoint | |
| # groups, GCE_VM_IP_PORT network endpoint groups, and instance | |
| # group backends. | |
| # USE_NAMED_PORT: Not supported. | |
| # USE_SERVING_PORT: Provides an indirect method of specifying | |
| # the health check port by referring to the backend service. Only supported | |
| # by backend services for proxy load balancers. Not supported by target | |
| # pools. Not supported by backend services for passthrough load balancers. | |
| # Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group | |
| # backends. | |
| # | |
| # For GCE_VM_IP_PORT network endpoint group backends, the health | |
| # check uses the port number specified for each endpoint in the network | |
| # endpoint group. For instance group backends, the health check uses the | |
| # port number determined by looking up the backend service's named port in | |
| # the instance group's list of named ports. | |
| "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. | |
| "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is/. Must comply withRFC3986. | |
| "response": "A String", # Creates a content-based HTTP/2 health check. In addition to the required | |
| # HTTP 200 (OK) status code, you can configure the health check to pass only | |
| # when the backend sends this specific ASCII response string within the first | |
| # 1024 bytes of the HTTP response body. For details, see: | |
| # https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http | |
| }, | |
| "httpHealthCheck": { | |
| "host": "A String", # The value of the host header in the HTTP health check request. If left | |
| # empty (default value), the host header is set to the destination IP address | |
| # to which health check packets are sent. The destination IP address depends | |
| # on the type of load balancer. For details, see: | |
| # https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest | |
| "port": 42, # The TCP port number to which the health check prober sends packets. The | |
| # default value is 80. Valid values are 1 through65535. | |
| "portName": "A String", # Not supported. | |
| "portSpecification": "A String", # Specifies how a port is selected for health checking. Can be one of the | |
| # following values: | |
| # USE_FIXED_PORT: Specifies a port number explicitly using theport field in the health check. Supported by backend services | |
| # for passthrough load balancers and backend services for proxy load | |
| # balancers. Also supported in legacy HTTP health checks for target pools. | |
| # The health check supports all backends supported by the backend service | |
| # provided the backend can be health checked. For example,GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT | |
| # network endpoint groups, and instance group backends. | |
| # USE_NAMED_PORT: Not supported. | |
| # USE_SERVING_PORT: Provides an indirect method of specifying | |
| # the health check port by referring to the backend service. Only supported | |
| # by backend services for proxy load balancers. Not supported by target | |
| # pools. Not supported by backend services for pass-through load balancers. | |
| # Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group | |
| # backends. | |
| # | |
| # For GCE_VM_IP_PORT network endpoint group backends, the health | |
| # check uses the port number specified for each endpoint in the network | |
| # endpoint group. For instance group backends, the health check uses the | |
| # port number determined by looking up the backend service's named port in | |
| # the instance group's list of named ports. | |
| "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. | |
| "requestPath": "A String", # The request path of the HTTP health check request. The default value is/. Must comply withRFC3986. | |
| "response": "A String", # Creates a content-based HTTP health check. In addition to the required | |
| # HTTP 200 (OK) status code, you can configure the health check to pass only | |
| # when the backend sends this specific ASCII response string within the first | |
| # 1024 bytes of the HTTP response body. For details, see: | |
| # https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http | |
| }, | |
| "httpsHealthCheck": { | |
| "host": "A String", # The value of the host header in the HTTPS health check request. If left | |
| # empty (default value), the host header is set to the destination IP address | |
| # to which health check packets are sent. The destination IP address depends | |
| # on the type of load balancer. For details, see: | |
| # https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest | |
| "port": 42, # The TCP port number to which the health check prober sends packets. The | |
| # default value is 443. Valid values are 1 through65535. | |
| "portName": "A String", # Not supported. | |
| "portSpecification": "A String", # Specifies how a port is selected for health checking. Can be one of the | |
| # following values: | |
| # USE_FIXED_PORT: Specifies a port number explicitly using theport field in the health check. Supported by backend services | |
| # for passthrough load balancers and backend services for proxy load | |
| # balancers. Not supported by target pools. The health check supports all | |
| # backends supported by the backend service provided the backend can be | |
| # health checked. For example, GCE_VM_IP network endpoint | |
| # groups, GCE_VM_IP_PORT network endpoint groups, and instance | |
| # group backends. | |
| # USE_NAMED_PORT: Not supported. | |
| # USE_SERVING_PORT: Provides an indirect method of specifying | |
| # the health check port by referring to the backend service. Only supported | |
| # by backend services for proxy load balancers. Not supported by target | |
| # pools. Not supported by backend services for passthrough load balancers. | |
| # Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group | |
| # backends. | |
| # | |
| # For GCE_VM_IP_PORT network endpoint group backends, the health | |
| # check uses the port number specified for each endpoint in the network | |
| # endpoint group. For instance group backends, the health check uses the | |
| # port number determined by looking up the backend service's named port in | |
| # the instance group's list of named ports. | |
| "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. | |
| "requestPath": "A String", # The request path of the HTTPS health check request. The default value is/. Must comply withRFC3986. | |
| "response": "A String", # Creates a content-based HTTPS health check. In addition to the required | |
| # HTTP 200 (OK) status code, you can configure the health check to pass only | |
| # when the backend sends this specific ASCII response string within the first | |
| # 1024 bytes of the HTTP response body. For details, see: | |
| # https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http | |
| }, | |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is | |
| # defined by the server. | |
| "kind": "compute#healthCheck", # Output only. Type of the resource. | |
| "logConfig": { # Configuration of logging on a health check. If logging is enabled, logs # Configure logging on this health check. | |
| # will be exported to Stackdriver. | |
| "enable": True or False, # Indicates whether or not to export logs. This is false by default, which | |
| # means no health check logging will be done. | |
| }, | |
| "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 withRFC1035. | |
| # For example, a name that is 1-63 characters long, matches the regular | |
| # expression `[a-z]([-a-z0-9]*[a-z0-9])?`, and otherwise complies with | |
| # RFC1035. This regular expression describes a name where the first | |
| # character is a lowercase letter, and all following characters are a dash, | |
| # lowercase letter, or digit, except the last character, which isn't a dash. | |
| "region": "A String", # Output only. [Output Only] Region where the health check resides. Not applicable to | |
| # global health checks. | |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. | |
| "sourceRegions": [ # The list of cloud regions from which health checks are performed. If any | |
| # regions are specified, then exactly 3 regions should be specified. The | |
| # region names must be valid names of Google Cloud regions. | |
| # This can only be set for global health check. | |
| # If this list is non-empty, then there are restrictions | |
| # on what other health check fields are supported and what other resources | |
| # can use this health check: | |
| # | |
| # - SSL, HTTP2, GRPC, and GRPC_WITH_TLS protocols are not supported. | |
| # - The TCP request field is not supported. | |
| # - The proxyHeader field for HTTP, HTTPS, and TCP is not | |
| # supported. | |
| # - The checkIntervalSec field must be at least 30. | |
| # - The health check cannot be used with BackendService nor with managed | |
| # instance group auto-healing. | |
| "A String", | |
| ], | |
| "sslHealthCheck": { | |
| "port": 42, # The TCP port number to which the health check prober sends packets. The | |
| # default value is 443. Valid values are 1 through65535. | |
| "portName": "A String", # Not supported. | |
| "portSpecification": "A String", # Specifies how a port is selected for health checking. Can be one of the | |
| # following values: | |
| # USE_FIXED_PORT: Specifies a port number explicitly using theport field in the health check. Supported by backend services | |
| # for passthrough load balancers and backend services for proxy load | |
| # balancers. Not supported by target pools. The health check supports all | |
| # backends supported by the backend service provided the backend can be | |
| # health checked. For example, GCE_VM_IP network endpoint | |
| # groups, GCE_VM_IP_PORT network endpoint groups, and instance | |
| # group backends. | |
| # USE_NAMED_PORT: Not supported. | |
| # USE_SERVING_PORT: Provides an indirect method of specifying | |
| # the health check port by referring to the backend service. Only supported | |
| # by backend services for proxy load balancers. Not supported by target | |
| # pools. Not supported by backend services for passthrough load balancers. | |
| # Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group | |
| # backends. | |
| # | |
| # For GCE_VM_IP_PORT network endpoint group backends, the health | |
| # check uses the port number specified for each endpoint in the network | |
| # endpoint group. For instance group backends, the health check uses the | |
| # port number determined by looking up the backend service's named port in | |
| # the instance group's list of named ports. | |
| "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. | |
| "request": "A String", # Instructs the health check prober to send this exact ASCII string, up to | |
| # 1024 bytes in length, after establishing the TCP connection and SSL | |
| # handshake. | |
| "response": "A String", # Creates a content-based SSL health check. In addition to establishing a | |
| # TCP connection and the TLS handshake, you can configure the health check to | |
| # pass only when the backend sends this exact response ASCII string, up to | |
| # 1024 bytes in length. For details, see: | |
| # https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-ssl-tcp | |
| }, | |
| "tcpHealthCheck": { | |
| "port": 42, # The TCP port number to which the health check prober sends packets. The | |
| # default value is 80. Valid values are 1 through65535. | |
| "portName": "A String", # Not supported. | |
| "portSpecification": "A String", # Specifies how a port is selected for health checking. Can be one of the | |
| # following values: | |
| # USE_FIXED_PORT: Specifies a port number explicitly using theport field in the health check. Supported by backend services | |
| # for passthrough load balancers and backend services for proxy load | |
| # balancers. Not supported by target pools. The health check supports all | |
| # backends supported by the backend service provided the backend can be | |
| # health checked. For example, GCE_VM_IP network endpoint | |
| # groups, GCE_VM_IP_PORT network endpoint groups, and instance | |
| # group backends. | |
| # USE_NAMED_PORT: Not supported. | |
| # USE_SERVING_PORT: Provides an indirect method of specifying | |
| # the health check port by referring to the backend service. Only supported | |
| # by backend services for proxy load balancers. Not supported by target | |
| # pools. Not supported by backend services for passthrough load balancers. | |
| # Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group | |
| # backends. | |
| # | |
| # For GCE_VM_IP_PORT network endpoint group backends, the health | |
| # check uses the port number specified for each endpoint in the network | |
| # endpoint group. For instance group backends, the health check uses the | |
| # port number determined by looking up the backend service's named port in | |
| # the instance group's list of named ports. | |
| "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. | |
| "request": "A String", # Instructs the health check prober to send this exact ASCII string, up to | |
| # 1024 bytes in length, after establishing the TCP connection. | |
| "response": "A String", # Creates a content-based TCP health check. In addition to establishing a | |
| # TCP connection, you can configure the health check to pass only when the | |
| # backend sends this exact response ASCII string, up to 1024 bytes in length. | |
| # For details, see: | |
| # https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-ssl-tcp | |
| }, | |
| "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. | |
| "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2, GRPC or GRPC_WITH_TLS. | |
| # Exactly one of the protocol-specific health check fields must be specified, | |
| # which must match type field. | |
| "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many | |
| # consecutive failures. The default value is 2. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</code> | |
| <pre>Creates a HealthCheck resource in the specified project using the data | |
| included in the request. | |
| Args: | |
| project: string, Project ID for this request. (required) | |
| region: string, Name of the region scoping this request. (required) | |
| body: object, The request body. | |
| The object takes the form of: | |
| { # Represents a health check resource. | |
| # | |
| # Google Compute Engine has two health check resources: | |
| # | |
| # * [Regional](/compute/docs/reference/rest/v1/regionHealthChecks) | |
| # * [Global](/compute/docs/reference/rest/v1/healthChecks) | |
| # | |
| # These health check resources can be used for load balancing and for | |
| # autohealing VMs in a managed instance group (MIG). | |
| # | |
| # **Load balancing** | |
| # | |
| # Health check requirements vary depending on the type of load balancer. For | |
| # details about the type of health check supported for | |
| # each load balancer and corresponding backend type, | |
| # see Health | |
| # checks overview: Load balancer guide. | |
| # | |
| # **Autohealing in MIGs** | |
| # | |
| # The health checks that you use for autohealing VMs in a MIG can be either | |
| # regional or global. For more information, see Set up an | |
| # application health check and autohealing. | |
| # | |
| # For more information, seeHealth checks | |
| # overview. | |
| "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 | |
| # seconds. | |
| "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp in3339 | |
| # text format. | |
| "description": "A String", # An optional description of this resource. Provide this property when you | |
| # create the resource. | |
| "grpcHealthCheck": { | |
| "grpcServiceName": "A String", # The gRPC service name for the health check. This field is optional. The | |
| # value of grpc_service_name has the following meanings by convention: | |
| # | |
| # - Empty service_name means the overall status of all services at the | |
| # backend. | |
| # | |
| # - Non-empty service_name means the health of that gRPC service, as defined | |
| # by the owner of the service. | |
| # | |
| # The grpc_service_name can only be ASCII. | |
| "port": 42, # The TCP port number to which the health check prober sends packets. Valid | |
| # values are 1 through 65535. | |
| "portName": "A String", # Not supported. | |
| "portSpecification": "A String", # Specifies how a port is selected for health checking. Can be one of the | |
| # following values: | |
| # USE_FIXED_PORT: Specifies a port number explicitly using theport field in the health check. Supported by backend services | |
| # for passthrough load balancers and backend services for proxy load | |
| # balancers. Not supported by target pools. The health check supports all | |
| # backends supported by the backend service provided the backend can be | |
| # health checked. For example, GCE_VM_IP network endpoint | |
| # groups, GCE_VM_IP_PORT network endpoint groups, and instance | |
| # group backends. | |
| # USE_NAMED_PORT: Not supported. | |
| # USE_SERVING_PORT: Provides an indirect method of specifying | |
| # the health check port by referring to the backend service. Only supported | |
| # by backend services for proxy load balancers. Not supported by target | |
| # pools. Not supported by backend services for passthrough load balancers. | |
| # Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group | |
| # backends. | |
| # | |
| # For GCE_VM_IP_PORT network endpoint group backends, the health | |
| # check uses the port number specified for each endpoint in the network | |
| # endpoint group. For instance group backends, the health check uses the | |
| # port number determined by looking up the backend service's named port in | |
| # the instance group's list of named ports. | |
| }, | |
| "grpcTlsHealthCheck": { | |
| "grpcServiceName": "A String", # The gRPC service name for the health check. This field is optional. The | |
| # value of grpc_service_name has the following meanings by convention: | |
| # | |
| # - Empty service_name means the overall status of all services at the | |
| # backend. | |
| # | |
| # - Non-empty service_name means the health of that gRPC service, as defined | |
| # by the owner of the service. | |
| # | |
| # The grpc_service_name can only be ASCII. | |
| "port": 42, # The TCP port number to which the health check prober sends packets. Valid | |
| # values are 1 through 65535. | |
| "portSpecification": "A String", # Specifies how a port is selected for health checking. Can be one of the | |
| # following values: | |
| # USE_FIXED_PORT: Specifies a port number explicitly using theport field in the health check. Supported by backend services | |
| # for passthrough load balancers and backend services for proxy load | |
| # balancers. Not supported by target pools. The health check supports all | |
| # backends supported by the backend service provided the backend can be | |
| # health checked. For example, GCE_VM_IP network endpoint | |
| # groups, GCE_VM_IP_PORT network endpoint groups, and instance | |
| # group backends. | |
| # USE_NAMED_PORT: Not supported. | |
| # USE_SERVING_PORT: Provides an indirect method of specifying | |
| # the health check port by referring to the backend service. Only supported | |
| # by backend services for proxy load balancers. Not supported by target | |
| # pools. Not supported by backend services for passthrough load balancers. | |
| # Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group | |
| # backends. | |
| # | |
| # For GCE_VM_IP_PORT network endpoint group backends, the health | |
| # check uses the port number specified for each endpoint in the network | |
| # endpoint group. For instance group backends, the health check uses the | |
| # port number determined by looking up the backend service's named port in | |
| # the instance group's list of named ports. | |
| }, | |
| "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this | |
| # many consecutive successes. The default value is 2. | |
| "http2HealthCheck": { | |
| "host": "A String", # The value of the host header in the HTTP/2 health check request. If left | |
| # empty (default value), the host header is set to the destination IP address | |
| # to which health check packets are sent. The destination IP address depends | |
| # on the type of load balancer. For details, see: | |
| # https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest | |
| "port": 42, # The TCP port number to which the health check prober sends packets. The | |
| # default value is 443. Valid values are 1 through65535. | |
| "portName": "A String", # Not supported. | |
| "portSpecification": "A String", # Specifies how a port is selected for health checking. Can be one of the | |
| # following values: | |
| # USE_FIXED_PORT: Specifies a port number explicitly using theport field in the health check. Supported by backend services | |
| # for passthrough load balancers and backend services for proxy load | |
| # balancers. Not supported by target pools. The health check supports all | |
| # backends supported by the backend service provided the backend can be | |
| # health checked. For example, GCE_VM_IP network endpoint | |
| # groups, GCE_VM_IP_PORT network endpoint groups, and instance | |
| # group backends. | |
| # USE_NAMED_PORT: Not supported. | |
| # USE_SERVING_PORT: Provides an indirect method of specifying | |
| # the health check port by referring to the backend service. Only supported | |
| # by backend services for proxy load balancers. Not supported by target | |
| # pools. Not supported by backend services for passthrough load balancers. | |
| # Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group | |
| # backends. | |
| # | |
| # For GCE_VM_IP_PORT network endpoint group backends, the health | |
| # check uses the port number specified for each endpoint in the network | |
| # endpoint group. For instance group backends, the health check uses the | |
| # port number determined by looking up the backend service's named port in | |
| # the instance group's list of named ports. | |
| "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. | |
| "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is/. Must comply withRFC3986. | |
| "response": "A String", # Creates a content-based HTTP/2 health check. In addition to the required | |
| # HTTP 200 (OK) status code, you can configure the health check to pass only | |
| # when the backend sends this specific ASCII response string within the first | |
| # 1024 bytes of the HTTP response body. For details, see: | |
| # https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http | |
| }, | |
| "httpHealthCheck": { | |
| "host": "A String", # The value of the host header in the HTTP health check request. If left | |
| # empty (default value), the host header is set to the destination IP address | |
| # to which health check packets are sent. The destination IP address depends | |
| # on the type of load balancer. For details, see: | |
| # https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest | |
| "port": 42, # The TCP port number to which the health check prober sends packets. The | |
| # default value is 80. Valid values are 1 through65535. | |
| "portName": "A String", # Not supported. | |
| "portSpecification": "A String", # Specifies how a port is selected for health checking. Can be one of the | |
| # following values: | |
| # USE_FIXED_PORT: Specifies a port number explicitly using theport field in the health check. Supported by backend services | |
| # for passthrough load balancers and backend services for proxy load | |
| # balancers. Also supported in legacy HTTP health checks for target pools. | |
| # The health check supports all backends supported by the backend service | |
| # provided the backend can be health checked. For example,GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT | |
| # network endpoint groups, and instance group backends. | |
| # USE_NAMED_PORT: Not supported. | |
| # USE_SERVING_PORT: Provides an indirect method of specifying | |
| # the health check port by referring to the backend service. Only supported | |
| # by backend services for proxy load balancers. Not supported by target | |
| # pools. Not supported by backend services for pass-through load balancers. | |
| # Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group | |
| # backends. | |
| # | |
| # For GCE_VM_IP_PORT network endpoint group backends, the health | |
| # check uses the port number specified for each endpoint in the network | |
| # endpoint group. For instance group backends, the health check uses the | |
| # port number determined by looking up the backend service's named port in | |
| # the instance group's list of named ports. | |
| "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. | |
| "requestPath": "A String", # The request path of the HTTP health check request. The default value is/. Must comply withRFC3986. | |
| "response": "A String", # Creates a content-based HTTP health check. In addition to the required | |
| # HTTP 200 (OK) status code, you can configure the health check to pass only | |
| # when the backend sends this specific ASCII response string within the first | |
| # 1024 bytes of the HTTP response body. For details, see: | |
| # https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http | |
| }, | |
| "httpsHealthCheck": { | |
| "host": "A String", # The value of the host header in the HTTPS health check request. If left | |
| # empty (default value), the host header is set to the destination IP address | |
| # to which health check packets are sent. The destination IP address depends | |
| # on the type of load balancer. For details, see: | |
| # https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest | |
| "port": 42, # The TCP port number to which the health check prober sends packets. The | |
| # default value is 443. Valid values are 1 through65535. | |
| "portName": "A String", # Not supported. | |
| "portSpecification": "A String", # Specifies how a port is selected for health checking. Can be one of the | |
| # following values: | |
| # USE_FIXED_PORT: Specifies a port number explicitly using theport field in the health check. Supported by backend services | |
| # for passthrough load balancers and backend services for proxy load | |
| # balancers. Not supported by target pools. The health check supports all | |
| # backends supported by the backend service provided the backend can be | |
| # health checked. For example, GCE_VM_IP network endpoint | |
| # groups, GCE_VM_IP_PORT network endpoint groups, and instance | |
| # group backends. | |
| # USE_NAMED_PORT: Not supported. | |
| # USE_SERVING_PORT: Provides an indirect method of specifying | |
| # the health check port by referring to the backend service. Only supported | |
| # by backend services for proxy load balancers. Not supported by target | |
| # pools. Not supported by backend services for passthrough load balancers. | |
| # Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group | |
| # backends. | |
| # | |
| # For GCE_VM_IP_PORT network endpoint group backends, the health | |
| # check uses the port number specified for each endpoint in the network | |
| # endpoint group. For instance group backends, the health check uses the | |
| # port number determined by looking up the backend service's named port in | |
| # the instance group's list of named ports. | |
| "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. | |
| "requestPath": "A String", # The request path of the HTTPS health check request. The default value is/. Must comply withRFC3986. | |
| "response": "A String", # Creates a content-based HTTPS health check. In addition to the required | |
| # HTTP 200 (OK) status code, you can configure the health check to pass only | |
| # when the backend sends this specific ASCII response string within the first | |
| # 1024 bytes of the HTTP response body. For details, see: | |
| # https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http | |
| }, | |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is | |
| # defined by the server. | |
| "kind": "compute#healthCheck", # Output only. Type of the resource. | |
| "logConfig": { # Configuration of logging on a health check. If logging is enabled, logs # Configure logging on this health check. | |
| # will be exported to Stackdriver. | |
| "enable": True or False, # Indicates whether or not to export logs. This is false by default, which | |
| # means no health check logging will be done. | |
| }, | |
| "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 withRFC1035. | |
| # For example, a name that is 1-63 characters long, matches the regular | |
| # expression `[a-z]([-a-z0-9]*[a-z0-9])?`, and otherwise complies with | |
| # RFC1035. This regular expression describes a name where the first | |
| # character is a lowercase letter, and all following characters are a dash, | |
| # lowercase letter, or digit, except the last character, which isn't a dash. | |
| "region": "A String", # Output only. [Output Only] Region where the health check resides. Not applicable to | |
| # global health checks. | |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. | |
| "sourceRegions": [ # The list of cloud regions from which health checks are performed. If any | |
| # regions are specified, then exactly 3 regions should be specified. The | |
| # region names must be valid names of Google Cloud regions. | |
| # This can only be set for global health check. | |
| # If this list is non-empty, then there are restrictions | |
| # on what other health check fields are supported and what other resources | |
| # can use this health check: | |
| # | |
| # - SSL, HTTP2, GRPC, and GRPC_WITH_TLS protocols are not supported. | |
| # - The TCP request field is not supported. | |
| # - The proxyHeader field for HTTP, HTTPS, and TCP is not | |
| # supported. | |
| # - The checkIntervalSec field must be at least 30. | |
| # - The health check cannot be used with BackendService nor with managed | |
| # instance group auto-healing. | |
| "A String", | |
| ], | |
| "sslHealthCheck": { | |
| "port": 42, # The TCP port number to which the health check prober sends packets. The | |
| # default value is 443. Valid values are 1 through65535. | |
| "portName": "A String", # Not supported. | |
| "portSpecification": "A String", # Specifies how a port is selected for health checking. Can be one of the | |
| # following values: | |
| # USE_FIXED_PORT: Specifies a port number explicitly using theport field in the health check. Supported by backend services | |
| # for passthrough load balancers and backend services for proxy load | |
| # balancers. Not supported by target pools. The health check supports all | |
| # backends supported by the backend service provided the backend can be | |
| # health checked. For example, GCE_VM_IP network endpoint | |
| # groups, GCE_VM_IP_PORT network endpoint groups, and instance | |
| # group backends. | |
| # USE_NAMED_PORT: Not supported. | |
| # USE_SERVING_PORT: Provides an indirect method of specifying | |
| # the health check port by referring to the backend service. Only supported | |
| # by backend services for proxy load balancers. Not supported by target | |
| # pools. Not supported by backend services for passthrough load balancers. | |
| # Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group | |
| # backends. | |
| # | |
| # For GCE_VM_IP_PORT network endpoint group backends, the health | |
| # check uses the port number specified for each endpoint in the network | |
| # endpoint group. For instance group backends, the health check uses the | |
| # port number determined by looking up the backend service's named port in | |
| # the instance group's list of named ports. | |
| "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. | |
| "request": "A String", # Instructs the health check prober to send this exact ASCII string, up to | |
| # 1024 bytes in length, after establishing the TCP connection and SSL | |
| # handshake. | |
| "response": "A String", # Creates a content-based SSL health check. In addition to establishing a | |
| # TCP connection and the TLS handshake, you can configure the health check to | |
| # pass only when the backend sends this exact response ASCII string, up to | |
| # 1024 bytes in length. For details, see: | |
| # https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-ssl-tcp | |
| }, | |
| "tcpHealthCheck": { | |
| "port": 42, # The TCP port number to which the health check prober sends packets. The | |
| # default value is 80. Valid values are 1 through65535. | |
| "portName": "A String", # Not supported. | |
| "portSpecification": "A String", # Specifies how a port is selected for health checking. Can be one of the | |
| # following values: | |
| # USE_FIXED_PORT: Specifies a port number explicitly using theport field in the health check. Supported by backend services | |
| # for passthrough load balancers and backend services for proxy load | |
| # balancers. Not supported by target pools. The health check supports all | |
| # backends supported by the backend service provided the backend can be | |
| # health checked. For example, GCE_VM_IP network endpoint | |
| # groups, GCE_VM_IP_PORT network endpoint groups, and instance | |
| # group backends. | |
| # USE_NAMED_PORT: Not supported. | |
| # USE_SERVING_PORT: Provides an indirect method of specifying | |
| # the health check port by referring to the backend service. Only supported | |
| # by backend services for proxy load balancers. Not supported by target | |
| # pools. Not supported by backend services for passthrough load balancers. | |
| # Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group | |
| # backends. | |
| # | |
| # For GCE_VM_IP_PORT network endpoint group backends, the health | |
| # check uses the port number specified for each endpoint in the network | |
| # endpoint group. For instance group backends, the health check uses the | |
| # port number determined by looking up the backend service's named port in | |
| # the instance group's list of named ports. | |
| "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. | |
| "request": "A String", # Instructs the health check prober to send this exact ASCII string, up to | |
| # 1024 bytes in length, after establishing the TCP connection. | |
| "response": "A String", # Creates a content-based TCP health check. In addition to establishing a | |
| # TCP connection, you can configure the health check to pass only when the | |
| # backend sends this exact response ASCII string, up to 1024 bytes in length. | |
| # For details, see: | |
| # https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-ssl-tcp | |
| }, | |
| "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. | |
| "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2, GRPC or GRPC_WITH_TLS. | |
| # Exactly one of the protocol-specific health check fields must be specified, | |
| # which must match type field. | |
| "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many | |
| # consecutive failures. The default value is 2. | |
| } | |
| 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. | |
| 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. | |
| The request ID must be | |
| a valid UUID with the exception that zero UUID is not supported | |
| (00000000-0000-0000-0000-000000000000). | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Represents an Operation resource. | |
| # | |
| # Google Compute Engine has three Operation resources: | |
| # | |
| # * [Global](/compute/docs/reference/rest/v1/globalOperations) | |
| # * [Regional](/compute/docs/reference/rest/v1/regionOperations) | |
| # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) | |
| # | |
| # You can use an operation resource to manage asynchronous API requests. | |
| # For more information, readHandling | |
| # API responses. | |
| # | |
| # Operations can be global, regional or zonal. | |
| # | |
| # - For global operations, use the `globalOperations` | |
| # resource. | |
| # - For regional operations, use the | |
| # `regionOperations` resource. | |
| # - For zonal operations, use | |
| # the `zoneOperations` resource. | |
| # | |
| # | |
| # | |
| # For more information, read | |
| # Global, Regional, and Zonal Resources. | |
| # | |
| # Note that completed Operation resources have a limited | |
| # retention period. | |
| "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. | |
| # Not present otherwise. | |
| "creationTimestamp": "A String", # [Deprecated] This field is deprecated. | |
| "description": "A String", # [Output Only] A textual description of the operation, which is | |
| # set when the operation is created. | |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 | |
| # text format. | |
| "error": { # [Output Only] If errors are generated during processing of the operation, | |
| # this field will be populated. | |
| "errors": [ # [Output Only] The array of errors encountered while processing this | |
| # operation. | |
| { # Represents a single error encountered during the processing of an | |
| # operation. | |
| "code": "A String", # [Output Only] The error type identifier for this error. | |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error | |
| # details. There is a set of defined message types to use for providing | |
| # details.The syntax depends on the error code. For example, | |
| # QuotaExceededInfo will have details when the error code is | |
| # QUOTA_EXCEEDED. | |
| { # Container for structured error details providing additional context | |
| # specific to the encountered error code. | |
| "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. | |
| # | |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it | |
| # is not enabled: | |
| # | |
| # { "reason": "API_DISABLED" | |
| # "domain": "googleapis.com" | |
| # "metadata": { | |
| # "resource": "projects/123", | |
| # "service": "pubsub.googleapis.com" | |
| # } | |
| # } | |
| # | |
| # This response indicates that the pubsub.googleapis.com API is not enabled. | |
| # | |
| # Example of an error that is returned when attempting to create a Spanner | |
| # instance in a region that is out of stock: | |
| # | |
| # { "reason": "STOCKOUT" | |
| # "domain": "spanner.googleapis.com", | |
| # "metadata": { | |
| # "availableRegions": "us-central1,us-east2" | |
| # } | |
| # } | |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain | |
| # is typically the registered service name of the tool or product that | |
| # generates the error. Example: "pubsub.googleapis.com". If the error is | |
| # generated by some common infrastructure, the error domain must be a | |
| # globally unique value that identifies the infrastructure. For Google API | |
| # infrastructure, the error domain is "googleapis.com". | |
| "metadatas": { # Additional structured details about this error. | |
| # | |
| # Keys must match a regular expression of `a-z+` but should | |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in | |
| # length. When identifying the current value of an exceeded limit, the units | |
| # should be contained in the key, not the value. For example, rather than | |
| # `{"instanceLimit": "100/request"}`, should be returned as, | |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of | |
| # instances that can be created in a single (batch) request. | |
| "a_key": "A String", | |
| }, | |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the | |
| # proximate cause of the error. Error reasons are unique within a particular | |
| # domain of errors. This should be at most 63 characters and match a | |
| # regular expression of `A-Z+[A-Z0-9]`, which represents | |
| # UPPER_SNAKE_CASE. | |
| }, | |
| "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. | |
| # | |
| # For example, if a quota check failed with an error indicating the calling | |
| # project hasn't enabled the accessed service, this can contain a URL pointing | |
| # directly to the right place in the developer console to flip the bit. | |
| "links": [ # URL(s) pointing to additional information on handling the current error. | |
| { # Describes a URL link. | |
| "description": "A String", # Describes what the link offers. | |
| "url": "A String", # The URL of the link. | |
| }, | |
| ], | |
| }, | |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. | |
| # which can be attached to an RPC error. | |
| "locale": "A String", # The locale used following the specification defined at | |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. | |
| # Examples are: "en-US", "fr-CH", "es-MX" | |
| "message": "A String", # The localized error message in the above locale. | |
| }, | |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. | |
| "dimensions": { # The map holding related quota dimensions. | |
| "a_key": "A String", | |
| }, | |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota | |
| # type or metric. | |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type | |
| # or metric. | |
| "limitName": "A String", # The name of the quota limit. | |
| "metricName": "A String", # The Compute Engine quota metric name. | |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. | |
| }, | |
| }, | |
| ], | |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. | |
| # This property is optional. | |
| "message": "A String", # [Output Only] An optional, human-readable error message. | |
| }, | |
| ], | |
| }, | |
| "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. | |
| "healthInfo": { # Health information. # Output only. The health information. | |
| "availabilitySloStatus": "A String", # Output only. The availability SLO status. | |
| "healthStatus": "A String", # Output only. The health status. | |
| "repairCategory": "A String", # Output only. The repair category. | |
| "unhealthyReason": "A String", # Output only. The reason for unhealthy status. | |
| "updateTime": "A String", # Output only. The time when health info was updated. | |
| }, | |
| }, | |
| "getVersionOperationMetadata": { | |
| "inlineSbomInfo": { | |
| "currentComponentVersions": { # A mapping of components to their currently-applied versions or other | |
| # appropriate identifiers. | |
| "a_key": "A String", | |
| }, | |
| "targetComponentVersions": { # A mapping of components to their target versions or other appropriate | |
| # identifiers. | |
| "a_key": "A String", | |
| }, | |
| }, | |
| }, | |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error | |
| # message that was returned, such as `NOT FOUND`. | |
| "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. | |
| "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is | |
| # defined by the server. | |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. | |
| # This value is inRFC3339 | |
| # text format. | |
| "instancesBulkInsertOperationMetadata": { | |
| "perLocationStatus": { # Status information per location (location name is key). | |
| # Example key: zones/us-central1-a | |
| "a_key": { | |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. | |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. | |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an | |
| # error. | |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information | |
| # if the flow is rolling forward or rolling back. | |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. | |
| }, | |
| }, | |
| }, | |
| "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. | |
| "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. | |
| }, | |
| "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for | |
| # Operation resources. | |
| "name": "A String", # [Output Only] Name of the operation. | |
| "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a | |
| # group of operations results from a `bulkInsert` API request. | |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, | |
| # `update`, or `delete`, and so on. | |
| "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. | |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only | |
| # applicable when performing regional operations. | |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. | |
| "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata, | |
| # this field will contain information on all underlying zonal actions and | |
| # their state. | |
| "clientOperationId": "A String", # [Output Only] The client operation id. | |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). | |
| # Example key: zones/us-central1-a | |
| "a_key": { | |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is | |
| # populated. | |
| # different programming environments, including REST APIs and RPC APIs. It is | |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains | |
| # three pieces of data: error code, error message, and error details. | |
| # | |
| # You can find out more about this error model and how to work with it in the | |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). | |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. | |
| "details": [ # A list of messages that carry the error details. There is a common set of | |
| # message types for APIs to use. | |
| { | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| ], | |
| "message": "A String", # A developer-facing error message, which should be in English. Any | |
| # user-facing error message should be localized and sent in the | |
| # google.rpc.Status.details field, or localized by the client. | |
| }, | |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: | |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. | |
| }, | |
| }, | |
| }, | |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. | |
| # This value is inRFC3339 | |
| # text format. | |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the | |
| # following: | |
| # `PENDING`, `RUNNING`, or `DONE`. | |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the | |
| # operation. | |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation | |
| # of the target resource. | |
| "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 disk | |
| # that the snapshot was created from. | |
| "user": "A String", # [Output Only] User who requested the operation, for example: | |
| # `user@example.com` or | |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. | |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the | |
| # operation, this field will be populated. | |
| { | |
| "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. | |
| "data": [ # [Output Only] Metadata about this warning in key: | |
| # value format. For example: | |
| # | |
| # "data": [ | |
| # { | |
| # "key": "scope", | |
| # "value": "zones/us-east1-d" | |
| # }] | |
| { | |
| "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). | |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. | |
| }, | |
| ], | |
| "message": "A String", # [Output Only] A human-readable description of the warning code. | |
| }, | |
| ], | |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only | |
| # applicable when performing per-zone operations. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, x__xgafv=None)</code> | |
| <pre>Retrieves the list of HealthCheck resources available to the specified | |
| project. | |
| Args: | |
| project: string, Project ID for this request. (required) | |
| region: string, Name of the region scoping this request. (required) | |
| filter: string, A filter expression that filters resources listed in the response. Most | |
| Compute resources support two types of filter expressions: | |
| expressions that support regular expressions and expressions that follow | |
| API improvement proposal AIP-160. | |
| These two types of filter expressions cannot be mixed in one request. | |
| If you want to use AIP-160, your expression must specify the field name, an | |
| operator, and the value that you want to use for filtering. The value | |
| must be a string, a number, or a boolean. The operator | |
| must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. | |
| For example, if you are filtering Compute Engine instances, you can | |
| exclude instances named `example-instance` by specifying | |
| `name != example-instance`. | |
| The `:*` comparison can be used to test whether a key has been defined. | |
| For example, to find all objects with `owner` label use: | |
| ``` | |
| labels.owner:* | |
| ``` | |
| 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 onresource labels. | |
| 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) | |
| ``` | |
| If you want to use a regular expression, use the `eq` (equal) or `ne` | |
| (not equal) operator against a single un-parenthesized expression with or | |
| without quotes or against multiple parenthesized expressions. Examples: | |
| `fieldname eq unquoted literal` | |
| `fieldname eq 'single quoted literal'` | |
| `fieldname eq "double quoted literal"` | |
| `(fieldname1 eq literal) (fieldname2 ne "literal")` | |
| The literal value is interpreted as a regular expression using GoogleRE2 library syntax. | |
| The literal value must match the entire field. | |
| For example, to filter for instances that do not end with name "instance", | |
| you would use `name ne .*instance`. | |
| You cannot combine constraints on multiple fields using regular | |
| expressions. | |
| 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`) | |
| orderBy: string, Sorts list results by a certain order. By default, results | |
| are returned in alphanumerical order based on the resource name. | |
| 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. | |
| Currently, only sorting by `name` or | |
| `creationTimestamp desc` is supported. | |
| 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. | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Contains a list of HealthCheck resources. | |
| "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. | |
| "items": [ # A list of HealthCheck resources. | |
| { # Represents a health check resource. | |
| # | |
| # Google Compute Engine has two health check resources: | |
| # | |
| # * [Regional](/compute/docs/reference/rest/v1/regionHealthChecks) | |
| # * [Global](/compute/docs/reference/rest/v1/healthChecks) | |
| # | |
| # These health check resources can be used for load balancing and for | |
| # autohealing VMs in a managed instance group (MIG). | |
| # | |
| # **Load balancing** | |
| # | |
| # Health check requirements vary depending on the type of load balancer. For | |
| # details about the type of health check supported for | |
| # each load balancer and corresponding backend type, | |
| # see Health | |
| # checks overview: Load balancer guide. | |
| # | |
| # **Autohealing in MIGs** | |
| # | |
| # The health checks that you use for autohealing VMs in a MIG can be either | |
| # regional or global. For more information, see Set up an | |
| # application health check and autohealing. | |
| # | |
| # For more information, seeHealth checks | |
| # overview. | |
| "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 | |
| # seconds. | |
| "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp in3339 | |
| # text format. | |
| "description": "A String", # An optional description of this resource. Provide this property when you | |
| # create the resource. | |
| "grpcHealthCheck": { | |
| "grpcServiceName": "A String", # The gRPC service name for the health check. This field is optional. The | |
| # value of grpc_service_name has the following meanings by convention: | |
| # | |
| # - Empty service_name means the overall status of all services at the | |
| # backend. | |
| # | |
| # - Non-empty service_name means the health of that gRPC service, as defined | |
| # by the owner of the service. | |
| # | |
| # The grpc_service_name can only be ASCII. | |
| "port": 42, # The TCP port number to which the health check prober sends packets. Valid | |
| # values are 1 through 65535. | |
| "portName": "A String", # Not supported. | |
| "portSpecification": "A String", # Specifies how a port is selected for health checking. Can be one of the | |
| # following values: | |
| # USE_FIXED_PORT: Specifies a port number explicitly using theport field in the health check. Supported by backend services | |
| # for passthrough load balancers and backend services for proxy load | |
| # balancers. Not supported by target pools. The health check supports all | |
| # backends supported by the backend service provided the backend can be | |
| # health checked. For example, GCE_VM_IP network endpoint | |
| # groups, GCE_VM_IP_PORT network endpoint groups, and instance | |
| # group backends. | |
| # USE_NAMED_PORT: Not supported. | |
| # USE_SERVING_PORT: Provides an indirect method of specifying | |
| # the health check port by referring to the backend service. Only supported | |
| # by backend services for proxy load balancers. Not supported by target | |
| # pools. Not supported by backend services for passthrough load balancers. | |
| # Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group | |
| # backends. | |
| # | |
| # For GCE_VM_IP_PORT network endpoint group backends, the health | |
| # check uses the port number specified for each endpoint in the network | |
| # endpoint group. For instance group backends, the health check uses the | |
| # port number determined by looking up the backend service's named port in | |
| # the instance group's list of named ports. | |
| }, | |
| "grpcTlsHealthCheck": { | |
| "grpcServiceName": "A String", # The gRPC service name for the health check. This field is optional. The | |
| # value of grpc_service_name has the following meanings by convention: | |
| # | |
| # - Empty service_name means the overall status of all services at the | |
| # backend. | |
| # | |
| # - Non-empty service_name means the health of that gRPC service, as defined | |
| # by the owner of the service. | |
| # | |
| # The grpc_service_name can only be ASCII. | |
| "port": 42, # The TCP port number to which the health check prober sends packets. Valid | |
| # values are 1 through 65535. | |
| "portSpecification": "A String", # Specifies how a port is selected for health checking. Can be one of the | |
| # following values: | |
| # USE_FIXED_PORT: Specifies a port number explicitly using theport field in the health check. Supported by backend services | |
| # for passthrough load balancers and backend services for proxy load | |
| # balancers. Not supported by target pools. The health check supports all | |
| # backends supported by the backend service provided the backend can be | |
| # health checked. For example, GCE_VM_IP network endpoint | |
| # groups, GCE_VM_IP_PORT network endpoint groups, and instance | |
| # group backends. | |
| # USE_NAMED_PORT: Not supported. | |
| # USE_SERVING_PORT: Provides an indirect method of specifying | |
| # the health check port by referring to the backend service. Only supported | |
| # by backend services for proxy load balancers. Not supported by target | |
| # pools. Not supported by backend services for passthrough load balancers. | |
| # Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group | |
| # backends. | |
| # | |
| # For GCE_VM_IP_PORT network endpoint group backends, the health | |
| # check uses the port number specified for each endpoint in the network | |
| # endpoint group. For instance group backends, the health check uses the | |
| # port number determined by looking up the backend service's named port in | |
| # the instance group's list of named ports. | |
| }, | |
| "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this | |
| # many consecutive successes. The default value is 2. | |
| "http2HealthCheck": { | |
| "host": "A String", # The value of the host header in the HTTP/2 health check request. If left | |
| # empty (default value), the host header is set to the destination IP address | |
| # to which health check packets are sent. The destination IP address depends | |
| # on the type of load balancer. For details, see: | |
| # https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest | |
| "port": 42, # The TCP port number to which the health check prober sends packets. The | |
| # default value is 443. Valid values are 1 through65535. | |
| "portName": "A String", # Not supported. | |
| "portSpecification": "A String", # Specifies how a port is selected for health checking. Can be one of the | |
| # following values: | |
| # USE_FIXED_PORT: Specifies a port number explicitly using theport field in the health check. Supported by backend services | |
| # for passthrough load balancers and backend services for proxy load | |
| # balancers. Not supported by target pools. The health check supports all | |
| # backends supported by the backend service provided the backend can be | |
| # health checked. For example, GCE_VM_IP network endpoint | |
| # groups, GCE_VM_IP_PORT network endpoint groups, and instance | |
| # group backends. | |
| # USE_NAMED_PORT: Not supported. | |
| # USE_SERVING_PORT: Provides an indirect method of specifying | |
| # the health check port by referring to the backend service. Only supported | |
| # by backend services for proxy load balancers. Not supported by target | |
| # pools. Not supported by backend services for passthrough load balancers. | |
| # Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group | |
| # backends. | |
| # | |
| # For GCE_VM_IP_PORT network endpoint group backends, the health | |
| # check uses the port number specified for each endpoint in the network | |
| # endpoint group. For instance group backends, the health check uses the | |
| # port number determined by looking up the backend service's named port in | |
| # the instance group's list of named ports. | |
| "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. | |
| "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is/. Must comply withRFC3986. | |
| "response": "A String", # Creates a content-based HTTP/2 health check. In addition to the required | |
| # HTTP 200 (OK) status code, you can configure the health check to pass only | |
| # when the backend sends this specific ASCII response string within the first | |
| # 1024 bytes of the HTTP response body. For details, see: | |
| # https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http | |
| }, | |
| "httpHealthCheck": { | |
| "host": "A String", # The value of the host header in the HTTP health check request. If left | |
| # empty (default value), the host header is set to the destination IP address | |
| # to which health check packets are sent. The destination IP address depends | |
| # on the type of load balancer. For details, see: | |
| # https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest | |
| "port": 42, # The TCP port number to which the health check prober sends packets. The | |
| # default value is 80. Valid values are 1 through65535. | |
| "portName": "A String", # Not supported. | |
| "portSpecification": "A String", # Specifies how a port is selected for health checking. Can be one of the | |
| # following values: | |
| # USE_FIXED_PORT: Specifies a port number explicitly using theport field in the health check. Supported by backend services | |
| # for passthrough load balancers and backend services for proxy load | |
| # balancers. Also supported in legacy HTTP health checks for target pools. | |
| # The health check supports all backends supported by the backend service | |
| # provided the backend can be health checked. For example,GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT | |
| # network endpoint groups, and instance group backends. | |
| # USE_NAMED_PORT: Not supported. | |
| # USE_SERVING_PORT: Provides an indirect method of specifying | |
| # the health check port by referring to the backend service. Only supported | |
| # by backend services for proxy load balancers. Not supported by target | |
| # pools. Not supported by backend services for pass-through load balancers. | |
| # Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group | |
| # backends. | |
| # | |
| # For GCE_VM_IP_PORT network endpoint group backends, the health | |
| # check uses the port number specified for each endpoint in the network | |
| # endpoint group. For instance group backends, the health check uses the | |
| # port number determined by looking up the backend service's named port in | |
| # the instance group's list of named ports. | |
| "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. | |
| "requestPath": "A String", # The request path of the HTTP health check request. The default value is/. Must comply withRFC3986. | |
| "response": "A String", # Creates a content-based HTTP health check. In addition to the required | |
| # HTTP 200 (OK) status code, you can configure the health check to pass only | |
| # when the backend sends this specific ASCII response string within the first | |
| # 1024 bytes of the HTTP response body. For details, see: | |
| # https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http | |
| }, | |
| "httpsHealthCheck": { | |
| "host": "A String", # The value of the host header in the HTTPS health check request. If left | |
| # empty (default value), the host header is set to the destination IP address | |
| # to which health check packets are sent. The destination IP address depends | |
| # on the type of load balancer. For details, see: | |
| # https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest | |
| "port": 42, # The TCP port number to which the health check prober sends packets. The | |
| # default value is 443. Valid values are 1 through65535. | |
| "portName": "A String", # Not supported. | |
| "portSpecification": "A String", # Specifies how a port is selected for health checking. Can be one of the | |
| # following values: | |
| # USE_FIXED_PORT: Specifies a port number explicitly using theport field in the health check. Supported by backend services | |
| # for passthrough load balancers and backend services for proxy load | |
| # balancers. Not supported by target pools. The health check supports all | |
| # backends supported by the backend service provided the backend can be | |
| # health checked. For example, GCE_VM_IP network endpoint | |
| # groups, GCE_VM_IP_PORT network endpoint groups, and instance | |
| # group backends. | |
| # USE_NAMED_PORT: Not supported. | |
| # USE_SERVING_PORT: Provides an indirect method of specifying | |
| # the health check port by referring to the backend service. Only supported | |
| # by backend services for proxy load balancers. Not supported by target | |
| # pools. Not supported by backend services for passthrough load balancers. | |
| # Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group | |
| # backends. | |
| # | |
| # For GCE_VM_IP_PORT network endpoint group backends, the health | |
| # check uses the port number specified for each endpoint in the network | |
| # endpoint group. For instance group backends, the health check uses the | |
| # port number determined by looking up the backend service's named port in | |
| # the instance group's list of named ports. | |
| "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. | |
| "requestPath": "A String", # The request path of the HTTPS health check request. The default value is/. Must comply withRFC3986. | |
| "response": "A String", # Creates a content-based HTTPS health check. In addition to the required | |
| # HTTP 200 (OK) status code, you can configure the health check to pass only | |
| # when the backend sends this specific ASCII response string within the first | |
| # 1024 bytes of the HTTP response body. For details, see: | |
| # https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http | |
| }, | |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is | |
| # defined by the server. | |
| "kind": "compute#healthCheck", # Output only. Type of the resource. | |
| "logConfig": { # Configuration of logging on a health check. If logging is enabled, logs # Configure logging on this health check. | |
| # will be exported to Stackdriver. | |
| "enable": True or False, # Indicates whether or not to export logs. This is false by default, which | |
| # means no health check logging will be done. | |
| }, | |
| "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 withRFC1035. | |
| # For example, a name that is 1-63 characters long, matches the regular | |
| # expression `[a-z]([-a-z0-9]*[a-z0-9])?`, and otherwise complies with | |
| # RFC1035. This regular expression describes a name where the first | |
| # character is a lowercase letter, and all following characters are a dash, | |
| # lowercase letter, or digit, except the last character, which isn't a dash. | |
| "region": "A String", # Output only. [Output Only] Region where the health check resides. Not applicable to | |
| # global health checks. | |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. | |
| "sourceRegions": [ # The list of cloud regions from which health checks are performed. If any | |
| # regions are specified, then exactly 3 regions should be specified. The | |
| # region names must be valid names of Google Cloud regions. | |
| # This can only be set for global health check. | |
| # If this list is non-empty, then there are restrictions | |
| # on what other health check fields are supported and what other resources | |
| # can use this health check: | |
| # | |
| # - SSL, HTTP2, GRPC, and GRPC_WITH_TLS protocols are not supported. | |
| # - The TCP request field is not supported. | |
| # - The proxyHeader field for HTTP, HTTPS, and TCP is not | |
| # supported. | |
| # - The checkIntervalSec field must be at least 30. | |
| # - The health check cannot be used with BackendService nor with managed | |
| # instance group auto-healing. | |
| "A String", | |
| ], | |
| "sslHealthCheck": { | |
| "port": 42, # The TCP port number to which the health check prober sends packets. The | |
| # default value is 443. Valid values are 1 through65535. | |
| "portName": "A String", # Not supported. | |
| "portSpecification": "A String", # Specifies how a port is selected for health checking. Can be one of the | |
| # following values: | |
| # USE_FIXED_PORT: Specifies a port number explicitly using theport field in the health check. Supported by backend services | |
| # for passthrough load balancers and backend services for proxy load | |
| # balancers. Not supported by target pools. The health check supports all | |
| # backends supported by the backend service provided the backend can be | |
| # health checked. For example, GCE_VM_IP network endpoint | |
| # groups, GCE_VM_IP_PORT network endpoint groups, and instance | |
| # group backends. | |
| # USE_NAMED_PORT: Not supported. | |
| # USE_SERVING_PORT: Provides an indirect method of specifying | |
| # the health check port by referring to the backend service. Only supported | |
| # by backend services for proxy load balancers. Not supported by target | |
| # pools. Not supported by backend services for passthrough load balancers. | |
| # Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group | |
| # backends. | |
| # | |
| # For GCE_VM_IP_PORT network endpoint group backends, the health | |
| # check uses the port number specified for each endpoint in the network | |
| # endpoint group. For instance group backends, the health check uses the | |
| # port number determined by looking up the backend service's named port in | |
| # the instance group's list of named ports. | |
| "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. | |
| "request": "A String", # Instructs the health check prober to send this exact ASCII string, up to | |
| # 1024 bytes in length, after establishing the TCP connection and SSL | |
| # handshake. | |
| "response": "A String", # Creates a content-based SSL health check. In addition to establishing a | |
| # TCP connection and the TLS handshake, you can configure the health check to | |
| # pass only when the backend sends this exact response ASCII string, up to | |
| # 1024 bytes in length. For details, see: | |
| # https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-ssl-tcp | |
| }, | |
| "tcpHealthCheck": { | |
| "port": 42, # The TCP port number to which the health check prober sends packets. The | |
| # default value is 80. Valid values are 1 through65535. | |
| "portName": "A String", # Not supported. | |
| "portSpecification": "A String", # Specifies how a port is selected for health checking. Can be one of the | |
| # following values: | |
| # USE_FIXED_PORT: Specifies a port number explicitly using theport field in the health check. Supported by backend services | |
| # for passthrough load balancers and backend services for proxy load | |
| # balancers. Not supported by target pools. The health check supports all | |
| # backends supported by the backend service provided the backend can be | |
| # health checked. For example, GCE_VM_IP network endpoint | |
| # groups, GCE_VM_IP_PORT network endpoint groups, and instance | |
| # group backends. | |
| # USE_NAMED_PORT: Not supported. | |
| # USE_SERVING_PORT: Provides an indirect method of specifying | |
| # the health check port by referring to the backend service. Only supported | |
| # by backend services for proxy load balancers. Not supported by target | |
| # pools. Not supported by backend services for passthrough load balancers. | |
| # Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group | |
| # backends. | |
| # | |
| # For GCE_VM_IP_PORT network endpoint group backends, the health | |
| # check uses the port number specified for each endpoint in the network | |
| # endpoint group. For instance group backends, the health check uses the | |
| # port number determined by looking up the backend service's named port in | |
| # the instance group's list of named ports. | |
| "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. | |
| "request": "A String", # Instructs the health check prober to send this exact ASCII string, up to | |
| # 1024 bytes in length, after establishing the TCP connection. | |
| "response": "A String", # Creates a content-based TCP health check. In addition to establishing a | |
| # TCP connection, you can configure the health check to pass only when the | |
| # backend sends this exact response ASCII string, up to 1024 bytes in length. | |
| # For details, see: | |
| # https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-ssl-tcp | |
| }, | |
| "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. | |
| "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2, GRPC or GRPC_WITH_TLS. | |
| # Exactly one of the protocol-specific health check fields must be specified, | |
| # which must match type field. | |
| "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many | |
| # consecutive failures. The default value is 2. | |
| }, | |
| ], | |
| "kind": "compute#healthCheckList", # Output only. Type of resource. | |
| "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 thanmaxResults, 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. | |
| "selfLink": "A String", # Output only. [Output Only] Server-defined URL for this resource. | |
| "warning": { # [Output Only] Informational warning message. | |
| "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. | |
| "data": [ # [Output Only] Metadata about this warning in key: | |
| # value format. For example: | |
| # | |
| # "data": [ | |
| # { | |
| # "key": "scope", | |
| # "value": "zones/us-east1-d" | |
| # }] | |
| { | |
| "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). | |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. | |
| }, | |
| ], | |
| "message": "A String", # [Output Only] A human-readable description of the warning code. | |
| }, | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> | |
| <pre>Retrieves the next page of results. | |
| Args: | |
| previous_request: The request for the previous page. (required) | |
| previous_response: The response from the request for the previous page. (required) | |
| Returns: | |
| A request object that you can call 'execute()' on to request the next | |
| page. Returns None if there are no more items in the collection. | |
| </pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="patch">patch(project, region, healthCheck, body=None, requestId=None, x__xgafv=None)</code> | |
| <pre>Updates a HealthCheck resource in the specified project using the data | |
| included in the request. This method supportsPATCH | |
| semantics and uses theJSON merge | |
| patch format and processing rules. | |
| Args: | |
| project: string, Project ID for this request. (required) | |
| region: string, Name of the region scoping this request. (required) | |
| healthCheck: string, Name of the HealthCheck resource to patch. (required) | |
| body: object, The request body. | |
| The object takes the form of: | |
| { # Represents a health check resource. | |
| # | |
| # Google Compute Engine has two health check resources: | |
| # | |
| # * [Regional](/compute/docs/reference/rest/v1/regionHealthChecks) | |
| # * [Global](/compute/docs/reference/rest/v1/healthChecks) | |
| # | |
| # These health check resources can be used for load balancing and for | |
| # autohealing VMs in a managed instance group (MIG). | |
| # | |
| # **Load balancing** | |
| # | |
| # Health check requirements vary depending on the type of load balancer. For | |
| # details about the type of health check supported for | |
| # each load balancer and corresponding backend type, | |
| # see Health | |
| # checks overview: Load balancer guide. | |
| # | |
| # **Autohealing in MIGs** | |
| # | |
| # The health checks that you use for autohealing VMs in a MIG can be either | |
| # regional or global. For more information, see Set up an | |
| # application health check and autohealing. | |
| # | |
| # For more information, seeHealth checks | |
| # overview. | |
| "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 | |
| # seconds. | |
| "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp in3339 | |
| # text format. | |
| "description": "A String", # An optional description of this resource. Provide this property when you | |
| # create the resource. | |
| "grpcHealthCheck": { | |
| "grpcServiceName": "A String", # The gRPC service name for the health check. This field is optional. The | |
| # value of grpc_service_name has the following meanings by convention: | |
| # | |
| # - Empty service_name means the overall status of all services at the | |
| # backend. | |
| # | |
| # - Non-empty service_name means the health of that gRPC service, as defined | |
| # by the owner of the service. | |
| # | |
| # The grpc_service_name can only be ASCII. | |
| "port": 42, # The TCP port number to which the health check prober sends packets. Valid | |
| # values are 1 through 65535. | |
| "portName": "A String", # Not supported. | |
| "portSpecification": "A String", # Specifies how a port is selected for health checking. Can be one of the | |
| # following values: | |
| # USE_FIXED_PORT: Specifies a port number explicitly using theport field in the health check. Supported by backend services | |
| # for passthrough load balancers and backend services for proxy load | |
| # balancers. Not supported by target pools. The health check supports all | |
| # backends supported by the backend service provided the backend can be | |
| # health checked. For example, GCE_VM_IP network endpoint | |
| # groups, GCE_VM_IP_PORT network endpoint groups, and instance | |
| # group backends. | |
| # USE_NAMED_PORT: Not supported. | |
| # USE_SERVING_PORT: Provides an indirect method of specifying | |
| # the health check port by referring to the backend service. Only supported | |
| # by backend services for proxy load balancers. Not supported by target | |
| # pools. Not supported by backend services for passthrough load balancers. | |
| # Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group | |
| # backends. | |
| # | |
| # For GCE_VM_IP_PORT network endpoint group backends, the health | |
| # check uses the port number specified for each endpoint in the network | |
| # endpoint group. For instance group backends, the health check uses the | |
| # port number determined by looking up the backend service's named port in | |
| # the instance group's list of named ports. | |
| }, | |
| "grpcTlsHealthCheck": { | |
| "grpcServiceName": "A String", # The gRPC service name for the health check. This field is optional. The | |
| # value of grpc_service_name has the following meanings by convention: | |
| # | |
| # - Empty service_name means the overall status of all services at the | |
| # backend. | |
| # | |
| # - Non-empty service_name means the health of that gRPC service, as defined | |
| # by the owner of the service. | |
| # | |
| # The grpc_service_name can only be ASCII. | |
| "port": 42, # The TCP port number to which the health check prober sends packets. Valid | |
| # values are 1 through 65535. | |
| "portSpecification": "A String", # Specifies how a port is selected for health checking. Can be one of the | |
| # following values: | |
| # USE_FIXED_PORT: Specifies a port number explicitly using theport field in the health check. Supported by backend services | |
| # for passthrough load balancers and backend services for proxy load | |
| # balancers. Not supported by target pools. The health check supports all | |
| # backends supported by the backend service provided the backend can be | |
| # health checked. For example, GCE_VM_IP network endpoint | |
| # groups, GCE_VM_IP_PORT network endpoint groups, and instance | |
| # group backends. | |
| # USE_NAMED_PORT: Not supported. | |
| # USE_SERVING_PORT: Provides an indirect method of specifying | |
| # the health check port by referring to the backend service. Only supported | |
| # by backend services for proxy load balancers. Not supported by target | |
| # pools. Not supported by backend services for passthrough load balancers. | |
| # Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group | |
| # backends. | |
| # | |
| # For GCE_VM_IP_PORT network endpoint group backends, the health | |
| # check uses the port number specified for each endpoint in the network | |
| # endpoint group. For instance group backends, the health check uses the | |
| # port number determined by looking up the backend service's named port in | |
| # the instance group's list of named ports. | |
| }, | |
| "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this | |
| # many consecutive successes. The default value is 2. | |
| "http2HealthCheck": { | |
| "host": "A String", # The value of the host header in the HTTP/2 health check request. If left | |
| # empty (default value), the host header is set to the destination IP address | |
| # to which health check packets are sent. The destination IP address depends | |
| # on the type of load balancer. For details, see: | |
| # https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest | |
| "port": 42, # The TCP port number to which the health check prober sends packets. The | |
| # default value is 443. Valid values are 1 through65535. | |
| "portName": "A String", # Not supported. | |
| "portSpecification": "A String", # Specifies how a port is selected for health checking. Can be one of the | |
| # following values: | |
| # USE_FIXED_PORT: Specifies a port number explicitly using theport field in the health check. Supported by backend services | |
| # for passthrough load balancers and backend services for proxy load | |
| # balancers. Not supported by target pools. The health check supports all | |
| # backends supported by the backend service provided the backend can be | |
| # health checked. For example, GCE_VM_IP network endpoint | |
| # groups, GCE_VM_IP_PORT network endpoint groups, and instance | |
| # group backends. | |
| # USE_NAMED_PORT: Not supported. | |
| # USE_SERVING_PORT: Provides an indirect method of specifying | |
| # the health check port by referring to the backend service. Only supported | |
| # by backend services for proxy load balancers. Not supported by target | |
| # pools. Not supported by backend services for passthrough load balancers. | |
| # Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group | |
| # backends. | |
| # | |
| # For GCE_VM_IP_PORT network endpoint group backends, the health | |
| # check uses the port number specified for each endpoint in the network | |
| # endpoint group. For instance group backends, the health check uses the | |
| # port number determined by looking up the backend service's named port in | |
| # the instance group's list of named ports. | |
| "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. | |
| "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is/. Must comply withRFC3986. | |
| "response": "A String", # Creates a content-based HTTP/2 health check. In addition to the required | |
| # HTTP 200 (OK) status code, you can configure the health check to pass only | |
| # when the backend sends this specific ASCII response string within the first | |
| # 1024 bytes of the HTTP response body. For details, see: | |
| # https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http | |
| }, | |
| "httpHealthCheck": { | |
| "host": "A String", # The value of the host header in the HTTP health check request. If left | |
| # empty (default value), the host header is set to the destination IP address | |
| # to which health check packets are sent. The destination IP address depends | |
| # on the type of load balancer. For details, see: | |
| # https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest | |
| "port": 42, # The TCP port number to which the health check prober sends packets. The | |
| # default value is 80. Valid values are 1 through65535. | |
| "portName": "A String", # Not supported. | |
| "portSpecification": "A String", # Specifies how a port is selected for health checking. Can be one of the | |
| # following values: | |
| # USE_FIXED_PORT: Specifies a port number explicitly using theport field in the health check. Supported by backend services | |
| # for passthrough load balancers and backend services for proxy load | |
| # balancers. Also supported in legacy HTTP health checks for target pools. | |
| # The health check supports all backends supported by the backend service | |
| # provided the backend can be health checked. For example,GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT | |
| # network endpoint groups, and instance group backends. | |
| # USE_NAMED_PORT: Not supported. | |
| # USE_SERVING_PORT: Provides an indirect method of specifying | |
| # the health check port by referring to the backend service. Only supported | |
| # by backend services for proxy load balancers. Not supported by target | |
| # pools. Not supported by backend services for pass-through load balancers. | |
| # Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group | |
| # backends. | |
| # | |
| # For GCE_VM_IP_PORT network endpoint group backends, the health | |
| # check uses the port number specified for each endpoint in the network | |
| # endpoint group. For instance group backends, the health check uses the | |
| # port number determined by looking up the backend service's named port in | |
| # the instance group's list of named ports. | |
| "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. | |
| "requestPath": "A String", # The request path of the HTTP health check request. The default value is/. Must comply withRFC3986. | |
| "response": "A String", # Creates a content-based HTTP health check. In addition to the required | |
| # HTTP 200 (OK) status code, you can configure the health check to pass only | |
| # when the backend sends this specific ASCII response string within the first | |
| # 1024 bytes of the HTTP response body. For details, see: | |
| # https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http | |
| }, | |
| "httpsHealthCheck": { | |
| "host": "A String", # The value of the host header in the HTTPS health check request. If left | |
| # empty (default value), the host header is set to the destination IP address | |
| # to which health check packets are sent. The destination IP address depends | |
| # on the type of load balancer. For details, see: | |
| # https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest | |
| "port": 42, # The TCP port number to which the health check prober sends packets. The | |
| # default value is 443. Valid values are 1 through65535. | |
| "portName": "A String", # Not supported. | |
| "portSpecification": "A String", # Specifies how a port is selected for health checking. Can be one of the | |
| # following values: | |
| # USE_FIXED_PORT: Specifies a port number explicitly using theport field in the health check. Supported by backend services | |
| # for passthrough load balancers and backend services for proxy load | |
| # balancers. Not supported by target pools. The health check supports all | |
| # backends supported by the backend service provided the backend can be | |
| # health checked. For example, GCE_VM_IP network endpoint | |
| # groups, GCE_VM_IP_PORT network endpoint groups, and instance | |
| # group backends. | |
| # USE_NAMED_PORT: Not supported. | |
| # USE_SERVING_PORT: Provides an indirect method of specifying | |
| # the health check port by referring to the backend service. Only supported | |
| # by backend services for proxy load balancers. Not supported by target | |
| # pools. Not supported by backend services for passthrough load balancers. | |
| # Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group | |
| # backends. | |
| # | |
| # For GCE_VM_IP_PORT network endpoint group backends, the health | |
| # check uses the port number specified for each endpoint in the network | |
| # endpoint group. For instance group backends, the health check uses the | |
| # port number determined by looking up the backend service's named port in | |
| # the instance group's list of named ports. | |
| "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. | |
| "requestPath": "A String", # The request path of the HTTPS health check request. The default value is/. Must comply withRFC3986. | |
| "response": "A String", # Creates a content-based HTTPS health check. In addition to the required | |
| # HTTP 200 (OK) status code, you can configure the health check to pass only | |
| # when the backend sends this specific ASCII response string within the first | |
| # 1024 bytes of the HTTP response body. For details, see: | |
| # https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http | |
| }, | |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is | |
| # defined by the server. | |
| "kind": "compute#healthCheck", # Output only. Type of the resource. | |
| "logConfig": { # Configuration of logging on a health check. If logging is enabled, logs # Configure logging on this health check. | |
| # will be exported to Stackdriver. | |
| "enable": True or False, # Indicates whether or not to export logs. This is false by default, which | |
| # means no health check logging will be done. | |
| }, | |
| "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 withRFC1035. | |
| # For example, a name that is 1-63 characters long, matches the regular | |
| # expression `[a-z]([-a-z0-9]*[a-z0-9])?`, and otherwise complies with | |
| # RFC1035. This regular expression describes a name where the first | |
| # character is a lowercase letter, and all following characters are a dash, | |
| # lowercase letter, or digit, except the last character, which isn't a dash. | |
| "region": "A String", # Output only. [Output Only] Region where the health check resides. Not applicable to | |
| # global health checks. | |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. | |
| "sourceRegions": [ # The list of cloud regions from which health checks are performed. If any | |
| # regions are specified, then exactly 3 regions should be specified. The | |
| # region names must be valid names of Google Cloud regions. | |
| # This can only be set for global health check. | |
| # If this list is non-empty, then there are restrictions | |
| # on what other health check fields are supported and what other resources | |
| # can use this health check: | |
| # | |
| # - SSL, HTTP2, GRPC, and GRPC_WITH_TLS protocols are not supported. | |
| # - The TCP request field is not supported. | |
| # - The proxyHeader field for HTTP, HTTPS, and TCP is not | |
| # supported. | |
| # - The checkIntervalSec field must be at least 30. | |
| # - The health check cannot be used with BackendService nor with managed | |
| # instance group auto-healing. | |
| "A String", | |
| ], | |
| "sslHealthCheck": { | |
| "port": 42, # The TCP port number to which the health check prober sends packets. The | |
| # default value is 443. Valid values are 1 through65535. | |
| "portName": "A String", # Not supported. | |
| "portSpecification": "A String", # Specifies how a port is selected for health checking. Can be one of the | |
| # following values: | |
| # USE_FIXED_PORT: Specifies a port number explicitly using theport field in the health check. Supported by backend services | |
| # for passthrough load balancers and backend services for proxy load | |
| # balancers. Not supported by target pools. The health check supports all | |
| # backends supported by the backend service provided the backend can be | |
| # health checked. For example, GCE_VM_IP network endpoint | |
| # groups, GCE_VM_IP_PORT network endpoint groups, and instance | |
| # group backends. | |
| # USE_NAMED_PORT: Not supported. | |
| # USE_SERVING_PORT: Provides an indirect method of specifying | |
| # the health check port by referring to the backend service. Only supported | |
| # by backend services for proxy load balancers. Not supported by target | |
| # pools. Not supported by backend services for passthrough load balancers. | |
| # Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group | |
| # backends. | |
| # | |
| # For GCE_VM_IP_PORT network endpoint group backends, the health | |
| # check uses the port number specified for each endpoint in the network | |
| # endpoint group. For instance group backends, the health check uses the | |
| # port number determined by looking up the backend service's named port in | |
| # the instance group's list of named ports. | |
| "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. | |
| "request": "A String", # Instructs the health check prober to send this exact ASCII string, up to | |
| # 1024 bytes in length, after establishing the TCP connection and SSL | |
| # handshake. | |
| "response": "A String", # Creates a content-based SSL health check. In addition to establishing a | |
| # TCP connection and the TLS handshake, you can configure the health check to | |
| # pass only when the backend sends this exact response ASCII string, up to | |
| # 1024 bytes in length. For details, see: | |
| # https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-ssl-tcp | |
| }, | |
| "tcpHealthCheck": { | |
| "port": 42, # The TCP port number to which the health check prober sends packets. The | |
| # default value is 80. Valid values are 1 through65535. | |
| "portName": "A String", # Not supported. | |
| "portSpecification": "A String", # Specifies how a port is selected for health checking. Can be one of the | |
| # following values: | |
| # USE_FIXED_PORT: Specifies a port number explicitly using theport field in the health check. Supported by backend services | |
| # for passthrough load balancers and backend services for proxy load | |
| # balancers. Not supported by target pools. The health check supports all | |
| # backends supported by the backend service provided the backend can be | |
| # health checked. For example, GCE_VM_IP network endpoint | |
| # groups, GCE_VM_IP_PORT network endpoint groups, and instance | |
| # group backends. | |
| # USE_NAMED_PORT: Not supported. | |
| # USE_SERVING_PORT: Provides an indirect method of specifying | |
| # the health check port by referring to the backend service. Only supported | |
| # by backend services for proxy load balancers. Not supported by target | |
| # pools. Not supported by backend services for passthrough load balancers. | |
| # Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group | |
| # backends. | |
| # | |
| # For GCE_VM_IP_PORT network endpoint group backends, the health | |
| # check uses the port number specified for each endpoint in the network | |
| # endpoint group. For instance group backends, the health check uses the | |
| # port number determined by looking up the backend service's named port in | |
| # the instance group's list of named ports. | |
| "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. | |
| "request": "A String", # Instructs the health check prober to send this exact ASCII string, up to | |
| # 1024 bytes in length, after establishing the TCP connection. | |
| "response": "A String", # Creates a content-based TCP health check. In addition to establishing a | |
| # TCP connection, you can configure the health check to pass only when the | |
| # backend sends this exact response ASCII string, up to 1024 bytes in length. | |
| # For details, see: | |
| # https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-ssl-tcp | |
| }, | |
| "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. | |
| "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2, GRPC or GRPC_WITH_TLS. | |
| # Exactly one of the protocol-specific health check fields must be specified, | |
| # which must match type field. | |
| "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many | |
| # consecutive failures. The default value is 2. | |
| } | |
| 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. | |
| 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. | |
| The request ID must be | |
| a valid UUID with the exception that zero UUID is not supported | |
| (00000000-0000-0000-0000-000000000000). | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Represents an Operation resource. | |
| # | |
| # Google Compute Engine has three Operation resources: | |
| # | |
| # * [Global](/compute/docs/reference/rest/v1/globalOperations) | |
| # * [Regional](/compute/docs/reference/rest/v1/regionOperations) | |
| # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) | |
| # | |
| # You can use an operation resource to manage asynchronous API requests. | |
| # For more information, readHandling | |
| # API responses. | |
| # | |
| # Operations can be global, regional or zonal. | |
| # | |
| # - For global operations, use the `globalOperations` | |
| # resource. | |
| # - For regional operations, use the | |
| # `regionOperations` resource. | |
| # - For zonal operations, use | |
| # the `zoneOperations` resource. | |
| # | |
| # | |
| # | |
| # For more information, read | |
| # Global, Regional, and Zonal Resources. | |
| # | |
| # Note that completed Operation resources have a limited | |
| # retention period. | |
| "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. | |
| # Not present otherwise. | |
| "creationTimestamp": "A String", # [Deprecated] This field is deprecated. | |
| "description": "A String", # [Output Only] A textual description of the operation, which is | |
| # set when the operation is created. | |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 | |
| # text format. | |
| "error": { # [Output Only] If errors are generated during processing of the operation, | |
| # this field will be populated. | |
| "errors": [ # [Output Only] The array of errors encountered while processing this | |
| # operation. | |
| { # Represents a single error encountered during the processing of an | |
| # operation. | |
| "code": "A String", # [Output Only] The error type identifier for this error. | |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error | |
| # details. There is a set of defined message types to use for providing | |
| # details.The syntax depends on the error code. For example, | |
| # QuotaExceededInfo will have details when the error code is | |
| # QUOTA_EXCEEDED. | |
| { # Container for structured error details providing additional context | |
| # specific to the encountered error code. | |
| "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. | |
| # | |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it | |
| # is not enabled: | |
| # | |
| # { "reason": "API_DISABLED" | |
| # "domain": "googleapis.com" | |
| # "metadata": { | |
| # "resource": "projects/123", | |
| # "service": "pubsub.googleapis.com" | |
| # } | |
| # } | |
| # | |
| # This response indicates that the pubsub.googleapis.com API is not enabled. | |
| # | |
| # Example of an error that is returned when attempting to create a Spanner | |
| # instance in a region that is out of stock: | |
| # | |
| # { "reason": "STOCKOUT" | |
| # "domain": "spanner.googleapis.com", | |
| # "metadata": { | |
| # "availableRegions": "us-central1,us-east2" | |
| # } | |
| # } | |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain | |
| # is typically the registered service name of the tool or product that | |
| # generates the error. Example: "pubsub.googleapis.com". If the error is | |
| # generated by some common infrastructure, the error domain must be a | |
| # globally unique value that identifies the infrastructure. For Google API | |
| # infrastructure, the error domain is "googleapis.com". | |
| "metadatas": { # Additional structured details about this error. | |
| # | |
| # Keys must match a regular expression of `a-z+` but should | |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in | |
| # length. When identifying the current value of an exceeded limit, the units | |
| # should be contained in the key, not the value. For example, rather than | |
| # `{"instanceLimit": "100/request"}`, should be returned as, | |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of | |
| # instances that can be created in a single (batch) request. | |
| "a_key": "A String", | |
| }, | |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the | |
| # proximate cause of the error. Error reasons are unique within a particular | |
| # domain of errors. This should be at most 63 characters and match a | |
| # regular expression of `A-Z+[A-Z0-9]`, which represents | |
| # UPPER_SNAKE_CASE. | |
| }, | |
| "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. | |
| # | |
| # For example, if a quota check failed with an error indicating the calling | |
| # project hasn't enabled the accessed service, this can contain a URL pointing | |
| # directly to the right place in the developer console to flip the bit. | |
| "links": [ # URL(s) pointing to additional information on handling the current error. | |
| { # Describes a URL link. | |
| "description": "A String", # Describes what the link offers. | |
| "url": "A String", # The URL of the link. | |
| }, | |
| ], | |
| }, | |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. | |
| # which can be attached to an RPC error. | |
| "locale": "A String", # The locale used following the specification defined at | |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. | |
| # Examples are: "en-US", "fr-CH", "es-MX" | |
| "message": "A String", # The localized error message in the above locale. | |
| }, | |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. | |
| "dimensions": { # The map holding related quota dimensions. | |
| "a_key": "A String", | |
| }, | |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota | |
| # type or metric. | |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type | |
| # or metric. | |
| "limitName": "A String", # The name of the quota limit. | |
| "metricName": "A String", # The Compute Engine quota metric name. | |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. | |
| }, | |
| }, | |
| ], | |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. | |
| # This property is optional. | |
| "message": "A String", # [Output Only] An optional, human-readable error message. | |
| }, | |
| ], | |
| }, | |
| "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. | |
| "healthInfo": { # Health information. # Output only. The health information. | |
| "availabilitySloStatus": "A String", # Output only. The availability SLO status. | |
| "healthStatus": "A String", # Output only. The health status. | |
| "repairCategory": "A String", # Output only. The repair category. | |
| "unhealthyReason": "A String", # Output only. The reason for unhealthy status. | |
| "updateTime": "A String", # Output only. The time when health info was updated. | |
| }, | |
| }, | |
| "getVersionOperationMetadata": { | |
| "inlineSbomInfo": { | |
| "currentComponentVersions": { # A mapping of components to their currently-applied versions or other | |
| # appropriate identifiers. | |
| "a_key": "A String", | |
| }, | |
| "targetComponentVersions": { # A mapping of components to their target versions or other appropriate | |
| # identifiers. | |
| "a_key": "A String", | |
| }, | |
| }, | |
| }, | |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error | |
| # message that was returned, such as `NOT FOUND`. | |
| "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. | |
| "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is | |
| # defined by the server. | |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. | |
| # This value is inRFC3339 | |
| # text format. | |
| "instancesBulkInsertOperationMetadata": { | |
| "perLocationStatus": { # Status information per location (location name is key). | |
| # Example key: zones/us-central1-a | |
| "a_key": { | |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. | |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. | |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an | |
| # error. | |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information | |
| # if the flow is rolling forward or rolling back. | |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. | |
| }, | |
| }, | |
| }, | |
| "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. | |
| "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. | |
| }, | |
| "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for | |
| # Operation resources. | |
| "name": "A String", # [Output Only] Name of the operation. | |
| "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a | |
| # group of operations results from a `bulkInsert` API request. | |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, | |
| # `update`, or `delete`, and so on. | |
| "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. | |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only | |
| # applicable when performing regional operations. | |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. | |
| "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata, | |
| # this field will contain information on all underlying zonal actions and | |
| # their state. | |
| "clientOperationId": "A String", # [Output Only] The client operation id. | |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). | |
| # Example key: zones/us-central1-a | |
| "a_key": { | |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is | |
| # populated. | |
| # different programming environments, including REST APIs and RPC APIs. It is | |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains | |
| # three pieces of data: error code, error message, and error details. | |
| # | |
| # You can find out more about this error model and how to work with it in the | |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). | |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. | |
| "details": [ # A list of messages that carry the error details. There is a common set of | |
| # message types for APIs to use. | |
| { | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| ], | |
| "message": "A String", # A developer-facing error message, which should be in English. Any | |
| # user-facing error message should be localized and sent in the | |
| # google.rpc.Status.details field, or localized by the client. | |
| }, | |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: | |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. | |
| }, | |
| }, | |
| }, | |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. | |
| # This value is inRFC3339 | |
| # text format. | |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the | |
| # following: | |
| # `PENDING`, `RUNNING`, or `DONE`. | |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the | |
| # operation. | |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation | |
| # of the target resource. | |
| "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 disk | |
| # that the snapshot was created from. | |
| "user": "A String", # [Output Only] User who requested the operation, for example: | |
| # `user@example.com` or | |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. | |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the | |
| # operation, this field will be populated. | |
| { | |
| "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. | |
| "data": [ # [Output Only] Metadata about this warning in key: | |
| # value format. For example: | |
| # | |
| # "data": [ | |
| # { | |
| # "key": "scope", | |
| # "value": "zones/us-east1-d" | |
| # }] | |
| { | |
| "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). | |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. | |
| }, | |
| ], | |
| "message": "A String", # [Output Only] A human-readable description of the warning code. | |
| }, | |
| ], | |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only | |
| # applicable when performing per-zone operations. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</code> | |
| <pre>Returns permissions that a caller has on the specified resource. | |
| Args: | |
| project: string, Project ID for this request. (required) | |
| region: string, The name of the region for this request. (required) | |
| resource: string, Name or id of the resource for this request. (required) | |
| body: object, The request body. | |
| The object takes the form of: | |
| { | |
| "permissions": [ # The set of permissions to check for the 'resource'. Permissions with | |
| # wildcards (such as '*' or 'storage.*') are not allowed. | |
| "A String", | |
| ], | |
| } | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { | |
| "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is | |
| # allowed. | |
| "A String", | |
| ], | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="update">update(project, region, healthCheck, body=None, requestId=None, x__xgafv=None)</code> | |
| <pre>Updates a HealthCheck resource in the specified project using the data | |
| included in the request. | |
| Args: | |
| project: string, Project ID for this request. (required) | |
| region: string, Name of the region scoping this request. (required) | |
| healthCheck: string, Name of the HealthCheck resource to update. (required) | |
| body: object, The request body. | |
| The object takes the form of: | |
| { # Represents a health check resource. | |
| # | |
| # Google Compute Engine has two health check resources: | |
| # | |
| # * [Regional](/compute/docs/reference/rest/v1/regionHealthChecks) | |
| # * [Global](/compute/docs/reference/rest/v1/healthChecks) | |
| # | |
| # These health check resources can be used for load balancing and for | |
| # autohealing VMs in a managed instance group (MIG). | |
| # | |
| # **Load balancing** | |
| # | |
| # Health check requirements vary depending on the type of load balancer. For | |
| # details about the type of health check supported for | |
| # each load balancer and corresponding backend type, | |
| # see Health | |
| # checks overview: Load balancer guide. | |
| # | |
| # **Autohealing in MIGs** | |
| # | |
| # The health checks that you use for autohealing VMs in a MIG can be either | |
| # regional or global. For more information, see Set up an | |
| # application health check and autohealing. | |
| # | |
| # For more information, seeHealth checks | |
| # overview. | |
| "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 | |
| # seconds. | |
| "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp in3339 | |
| # text format. | |
| "description": "A String", # An optional description of this resource. Provide this property when you | |
| # create the resource. | |
| "grpcHealthCheck": { | |
| "grpcServiceName": "A String", # The gRPC service name for the health check. This field is optional. The | |
| # value of grpc_service_name has the following meanings by convention: | |
| # | |
| # - Empty service_name means the overall status of all services at the | |
| # backend. | |
| # | |
| # - Non-empty service_name means the health of that gRPC service, as defined | |
| # by the owner of the service. | |
| # | |
| # The grpc_service_name can only be ASCII. | |
| "port": 42, # The TCP port number to which the health check prober sends packets. Valid | |
| # values are 1 through 65535. | |
| "portName": "A String", # Not supported. | |
| "portSpecification": "A String", # Specifies how a port is selected for health checking. Can be one of the | |
| # following values: | |
| # USE_FIXED_PORT: Specifies a port number explicitly using theport field in the health check. Supported by backend services | |
| # for passthrough load balancers and backend services for proxy load | |
| # balancers. Not supported by target pools. The health check supports all | |
| # backends supported by the backend service provided the backend can be | |
| # health checked. For example, GCE_VM_IP network endpoint | |
| # groups, GCE_VM_IP_PORT network endpoint groups, and instance | |
| # group backends. | |
| # USE_NAMED_PORT: Not supported. | |
| # USE_SERVING_PORT: Provides an indirect method of specifying | |
| # the health check port by referring to the backend service. Only supported | |
| # by backend services for proxy load balancers. Not supported by target | |
| # pools. Not supported by backend services for passthrough load balancers. | |
| # Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group | |
| # backends. | |
| # | |
| # For GCE_VM_IP_PORT network endpoint group backends, the health | |
| # check uses the port number specified for each endpoint in the network | |
| # endpoint group. For instance group backends, the health check uses the | |
| # port number determined by looking up the backend service's named port in | |
| # the instance group's list of named ports. | |
| }, | |
| "grpcTlsHealthCheck": { | |
| "grpcServiceName": "A String", # The gRPC service name for the health check. This field is optional. The | |
| # value of grpc_service_name has the following meanings by convention: | |
| # | |
| # - Empty service_name means the overall status of all services at the | |
| # backend. | |
| # | |
| # - Non-empty service_name means the health of that gRPC service, as defined | |
| # by the owner of the service. | |
| # | |
| # The grpc_service_name can only be ASCII. | |
| "port": 42, # The TCP port number to which the health check prober sends packets. Valid | |
| # values are 1 through 65535. | |
| "portSpecification": "A String", # Specifies how a port is selected for health checking. Can be one of the | |
| # following values: | |
| # USE_FIXED_PORT: Specifies a port number explicitly using theport field in the health check. Supported by backend services | |
| # for passthrough load balancers and backend services for proxy load | |
| # balancers. Not supported by target pools. The health check supports all | |
| # backends supported by the backend service provided the backend can be | |
| # health checked. For example, GCE_VM_IP network endpoint | |
| # groups, GCE_VM_IP_PORT network endpoint groups, and instance | |
| # group backends. | |
| # USE_NAMED_PORT: Not supported. | |
| # USE_SERVING_PORT: Provides an indirect method of specifying | |
| # the health check port by referring to the backend service. Only supported | |
| # by backend services for proxy load balancers. Not supported by target | |
| # pools. Not supported by backend services for passthrough load balancers. | |
| # Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group | |
| # backends. | |
| # | |
| # For GCE_VM_IP_PORT network endpoint group backends, the health | |
| # check uses the port number specified for each endpoint in the network | |
| # endpoint group. For instance group backends, the health check uses the | |
| # port number determined by looking up the backend service's named port in | |
| # the instance group's list of named ports. | |
| }, | |
| "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this | |
| # many consecutive successes. The default value is 2. | |
| "http2HealthCheck": { | |
| "host": "A String", # The value of the host header in the HTTP/2 health check request. If left | |
| # empty (default value), the host header is set to the destination IP address | |
| # to which health check packets are sent. The destination IP address depends | |
| # on the type of load balancer. For details, see: | |
| # https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest | |
| "port": 42, # The TCP port number to which the health check prober sends packets. The | |
| # default value is 443. Valid values are 1 through65535. | |
| "portName": "A String", # Not supported. | |
| "portSpecification": "A String", # Specifies how a port is selected for health checking. Can be one of the | |
| # following values: | |
| # USE_FIXED_PORT: Specifies a port number explicitly using theport field in the health check. Supported by backend services | |
| # for passthrough load balancers and backend services for proxy load | |
| # balancers. Not supported by target pools. The health check supports all | |
| # backends supported by the backend service provided the backend can be | |
| # health checked. For example, GCE_VM_IP network endpoint | |
| # groups, GCE_VM_IP_PORT network endpoint groups, and instance | |
| # group backends. | |
| # USE_NAMED_PORT: Not supported. | |
| # USE_SERVING_PORT: Provides an indirect method of specifying | |
| # the health check port by referring to the backend service. Only supported | |
| # by backend services for proxy load balancers. Not supported by target | |
| # pools. Not supported by backend services for passthrough load balancers. | |
| # Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group | |
| # backends. | |
| # | |
| # For GCE_VM_IP_PORT network endpoint group backends, the health | |
| # check uses the port number specified for each endpoint in the network | |
| # endpoint group. For instance group backends, the health check uses the | |
| # port number determined by looking up the backend service's named port in | |
| # the instance group's list of named ports. | |
| "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. | |
| "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is/. Must comply withRFC3986. | |
| "response": "A String", # Creates a content-based HTTP/2 health check. In addition to the required | |
| # HTTP 200 (OK) status code, you can configure the health check to pass only | |
| # when the backend sends this specific ASCII response string within the first | |
| # 1024 bytes of the HTTP response body. For details, see: | |
| # https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http | |
| }, | |
| "httpHealthCheck": { | |
| "host": "A String", # The value of the host header in the HTTP health check request. If left | |
| # empty (default value), the host header is set to the destination IP address | |
| # to which health check packets are sent. The destination IP address depends | |
| # on the type of load balancer. For details, see: | |
| # https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest | |
| "port": 42, # The TCP port number to which the health check prober sends packets. The | |
| # default value is 80. Valid values are 1 through65535. | |
| "portName": "A String", # Not supported. | |
| "portSpecification": "A String", # Specifies how a port is selected for health checking. Can be one of the | |
| # following values: | |
| # USE_FIXED_PORT: Specifies a port number explicitly using theport field in the health check. Supported by backend services | |
| # for passthrough load balancers and backend services for proxy load | |
| # balancers. Also supported in legacy HTTP health checks for target pools. | |
| # The health check supports all backends supported by the backend service | |
| # provided the backend can be health checked. For example,GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT | |
| # network endpoint groups, and instance group backends. | |
| # USE_NAMED_PORT: Not supported. | |
| # USE_SERVING_PORT: Provides an indirect method of specifying | |
| # the health check port by referring to the backend service. Only supported | |
| # by backend services for proxy load balancers. Not supported by target | |
| # pools. Not supported by backend services for pass-through load balancers. | |
| # Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group | |
| # backends. | |
| # | |
| # For GCE_VM_IP_PORT network endpoint group backends, the health | |
| # check uses the port number specified for each endpoint in the network | |
| # endpoint group. For instance group backends, the health check uses the | |
| # port number determined by looking up the backend service's named port in | |
| # the instance group's list of named ports. | |
| "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. | |
| "requestPath": "A String", # The request path of the HTTP health check request. The default value is/. Must comply withRFC3986. | |
| "response": "A String", # Creates a content-based HTTP health check. In addition to the required | |
| # HTTP 200 (OK) status code, you can configure the health check to pass only | |
| # when the backend sends this specific ASCII response string within the first | |
| # 1024 bytes of the HTTP response body. For details, see: | |
| # https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http | |
| }, | |
| "httpsHealthCheck": { | |
| "host": "A String", # The value of the host header in the HTTPS health check request. If left | |
| # empty (default value), the host header is set to the destination IP address | |
| # to which health check packets are sent. The destination IP address depends | |
| # on the type of load balancer. For details, see: | |
| # https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest | |
| "port": 42, # The TCP port number to which the health check prober sends packets. The | |
| # default value is 443. Valid values are 1 through65535. | |
| "portName": "A String", # Not supported. | |
| "portSpecification": "A String", # Specifies how a port is selected for health checking. Can be one of the | |
| # following values: | |
| # USE_FIXED_PORT: Specifies a port number explicitly using theport field in the health check. Supported by backend services | |
| # for passthrough load balancers and backend services for proxy load | |
| # balancers. Not supported by target pools. The health check supports all | |
| # backends supported by the backend service provided the backend can be | |
| # health checked. For example, GCE_VM_IP network endpoint | |
| # groups, GCE_VM_IP_PORT network endpoint groups, and instance | |
| # group backends. | |
| # USE_NAMED_PORT: Not supported. | |
| # USE_SERVING_PORT: Provides an indirect method of specifying | |
| # the health check port by referring to the backend service. Only supported | |
| # by backend services for proxy load balancers. Not supported by target | |
| # pools. Not supported by backend services for passthrough load balancers. | |
| # Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group | |
| # backends. | |
| # | |
| # For GCE_VM_IP_PORT network endpoint group backends, the health | |
| # check uses the port number specified for each endpoint in the network | |
| # endpoint group. For instance group backends, the health check uses the | |
| # port number determined by looking up the backend service's named port in | |
| # the instance group's list of named ports. | |
| "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. | |
| "requestPath": "A String", # The request path of the HTTPS health check request. The default value is/. Must comply withRFC3986. | |
| "response": "A String", # Creates a content-based HTTPS health check. In addition to the required | |
| # HTTP 200 (OK) status code, you can configure the health check to pass only | |
| # when the backend sends this specific ASCII response string within the first | |
| # 1024 bytes of the HTTP response body. For details, see: | |
| # https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http | |
| }, | |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is | |
| # defined by the server. | |
| "kind": "compute#healthCheck", # Output only. Type of the resource. | |
| "logConfig": { # Configuration of logging on a health check. If logging is enabled, logs # Configure logging on this health check. | |
| # will be exported to Stackdriver. | |
| "enable": True or False, # Indicates whether or not to export logs. This is false by default, which | |
| # means no health check logging will be done. | |
| }, | |
| "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 withRFC1035. | |
| # For example, a name that is 1-63 characters long, matches the regular | |
| # expression `[a-z]([-a-z0-9]*[a-z0-9])?`, and otherwise complies with | |
| # RFC1035. This regular expression describes a name where the first | |
| # character is a lowercase letter, and all following characters are a dash, | |
| # lowercase letter, or digit, except the last character, which isn't a dash. | |
| "region": "A String", # Output only. [Output Only] Region where the health check resides. Not applicable to | |
| # global health checks. | |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. | |
| "sourceRegions": [ # The list of cloud regions from which health checks are performed. If any | |
| # regions are specified, then exactly 3 regions should be specified. The | |
| # region names must be valid names of Google Cloud regions. | |
| # This can only be set for global health check. | |
| # If this list is non-empty, then there are restrictions | |
| # on what other health check fields are supported and what other resources | |
| # can use this health check: | |
| # | |
| # - SSL, HTTP2, GRPC, and GRPC_WITH_TLS protocols are not supported. | |
| # - The TCP request field is not supported. | |
| # - The proxyHeader field for HTTP, HTTPS, and TCP is not | |
| # supported. | |
| # - The checkIntervalSec field must be at least 30. | |
| # - The health check cannot be used with BackendService nor with managed | |
| # instance group auto-healing. | |
| "A String", | |
| ], | |
| "sslHealthCheck": { | |
| "port": 42, # The TCP port number to which the health check prober sends packets. The | |
| # default value is 443. Valid values are 1 through65535. | |
| "portName": "A String", # Not supported. | |
| "portSpecification": "A String", # Specifies how a port is selected for health checking. Can be one of the | |
| # following values: | |
| # USE_FIXED_PORT: Specifies a port number explicitly using theport field in the health check. Supported by backend services | |
| # for passthrough load balancers and backend services for proxy load | |
| # balancers. Not supported by target pools. The health check supports all | |
| # backends supported by the backend service provided the backend can be | |
| # health checked. For example, GCE_VM_IP network endpoint | |
| # groups, GCE_VM_IP_PORT network endpoint groups, and instance | |
| # group backends. | |
| # USE_NAMED_PORT: Not supported. | |
| # USE_SERVING_PORT: Provides an indirect method of specifying | |
| # the health check port by referring to the backend service. Only supported | |
| # by backend services for proxy load balancers. Not supported by target | |
| # pools. Not supported by backend services for passthrough load balancers. | |
| # Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group | |
| # backends. | |
| # | |
| # For GCE_VM_IP_PORT network endpoint group backends, the health | |
| # check uses the port number specified for each endpoint in the network | |
| # endpoint group. For instance group backends, the health check uses the | |
| # port number determined by looking up the backend service's named port in | |
| # the instance group's list of named ports. | |
| "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. | |
| "request": "A String", # Instructs the health check prober to send this exact ASCII string, up to | |
| # 1024 bytes in length, after establishing the TCP connection and SSL | |
| # handshake. | |
| "response": "A String", # Creates a content-based SSL health check. In addition to establishing a | |
| # TCP connection and the TLS handshake, you can configure the health check to | |
| # pass only when the backend sends this exact response ASCII string, up to | |
| # 1024 bytes in length. For details, see: | |
| # https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-ssl-tcp | |
| }, | |
| "tcpHealthCheck": { | |
| "port": 42, # The TCP port number to which the health check prober sends packets. The | |
| # default value is 80. Valid values are 1 through65535. | |
| "portName": "A String", # Not supported. | |
| "portSpecification": "A String", # Specifies how a port is selected for health checking. Can be one of the | |
| # following values: | |
| # USE_FIXED_PORT: Specifies a port number explicitly using theport field in the health check. Supported by backend services | |
| # for passthrough load balancers and backend services for proxy load | |
| # balancers. Not supported by target pools. The health check supports all | |
| # backends supported by the backend service provided the backend can be | |
| # health checked. For example, GCE_VM_IP network endpoint | |
| # groups, GCE_VM_IP_PORT network endpoint groups, and instance | |
| # group backends. | |
| # USE_NAMED_PORT: Not supported. | |
| # USE_SERVING_PORT: Provides an indirect method of specifying | |
| # the health check port by referring to the backend service. Only supported | |
| # by backend services for proxy load balancers. Not supported by target | |
| # pools. Not supported by backend services for passthrough load balancers. | |
| # Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group | |
| # backends. | |
| # | |
| # For GCE_VM_IP_PORT network endpoint group backends, the health | |
| # check uses the port number specified for each endpoint in the network | |
| # endpoint group. For instance group backends, the health check uses the | |
| # port number determined by looking up the backend service's named port in | |
| # the instance group's list of named ports. | |
| "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. | |
| "request": "A String", # Instructs the health check prober to send this exact ASCII string, up to | |
| # 1024 bytes in length, after establishing the TCP connection. | |
| "response": "A String", # Creates a content-based TCP health check. In addition to establishing a | |
| # TCP connection, you can configure the health check to pass only when the | |
| # backend sends this exact response ASCII string, up to 1024 bytes in length. | |
| # For details, see: | |
| # https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-ssl-tcp | |
| }, | |
| "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. | |
| "type": "A String", # Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2, GRPC or GRPC_WITH_TLS. | |
| # Exactly one of the protocol-specific health check fields must be specified, | |
| # which must match type field. | |
| "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many | |
| # consecutive failures. The default value is 2. | |
| } | |
| 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. | |
| 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. | |
| The request ID must be | |
| a valid UUID with the exception that zero UUID is not supported | |
| (00000000-0000-0000-0000-000000000000). | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Represents an Operation resource. | |
| # | |
| # Google Compute Engine has three Operation resources: | |
| # | |
| # * [Global](/compute/docs/reference/rest/v1/globalOperations) | |
| # * [Regional](/compute/docs/reference/rest/v1/regionOperations) | |
| # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) | |
| # | |
| # You can use an operation resource to manage asynchronous API requests. | |
| # For more information, readHandling | |
| # API responses. | |
| # | |
| # Operations can be global, regional or zonal. | |
| # | |
| # - For global operations, use the `globalOperations` | |
| # resource. | |
| # - For regional operations, use the | |
| # `regionOperations` resource. | |
| # - For zonal operations, use | |
| # the `zoneOperations` resource. | |
| # | |
| # | |
| # | |
| # For more information, read | |
| # Global, Regional, and Zonal Resources. | |
| # | |
| # Note that completed Operation resources have a limited | |
| # retention period. | |
| "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. | |
| # Not present otherwise. | |
| "creationTimestamp": "A String", # [Deprecated] This field is deprecated. | |
| "description": "A String", # [Output Only] A textual description of the operation, which is | |
| # set when the operation is created. | |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 | |
| # text format. | |
| "error": { # [Output Only] If errors are generated during processing of the operation, | |
| # this field will be populated. | |
| "errors": [ # [Output Only] The array of errors encountered while processing this | |
| # operation. | |
| { # Represents a single error encountered during the processing of an | |
| # operation. | |
| "code": "A String", # [Output Only] The error type identifier for this error. | |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error | |
| # details. There is a set of defined message types to use for providing | |
| # details.The syntax depends on the error code. For example, | |
| # QuotaExceededInfo will have details when the error code is | |
| # QUOTA_EXCEEDED. | |
| { # Container for structured error details providing additional context | |
| # specific to the encountered error code. | |
| "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. | |
| # | |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it | |
| # is not enabled: | |
| # | |
| # { "reason": "API_DISABLED" | |
| # "domain": "googleapis.com" | |
| # "metadata": { | |
| # "resource": "projects/123", | |
| # "service": "pubsub.googleapis.com" | |
| # } | |
| # } | |
| # | |
| # This response indicates that the pubsub.googleapis.com API is not enabled. | |
| # | |
| # Example of an error that is returned when attempting to create a Spanner | |
| # instance in a region that is out of stock: | |
| # | |
| # { "reason": "STOCKOUT" | |
| # "domain": "spanner.googleapis.com", | |
| # "metadata": { | |
| # "availableRegions": "us-central1,us-east2" | |
| # } | |
| # } | |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain | |
| # is typically the registered service name of the tool or product that | |
| # generates the error. Example: "pubsub.googleapis.com". If the error is | |
| # generated by some common infrastructure, the error domain must be a | |
| # globally unique value that identifies the infrastructure. For Google API | |
| # infrastructure, the error domain is "googleapis.com". | |
| "metadatas": { # Additional structured details about this error. | |
| # | |
| # Keys must match a regular expression of `a-z+` but should | |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in | |
| # length. When identifying the current value of an exceeded limit, the units | |
| # should be contained in the key, not the value. For example, rather than | |
| # `{"instanceLimit": "100/request"}`, should be returned as, | |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of | |
| # instances that can be created in a single (batch) request. | |
| "a_key": "A String", | |
| }, | |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the | |
| # proximate cause of the error. Error reasons are unique within a particular | |
| # domain of errors. This should be at most 63 characters and match a | |
| # regular expression of `A-Z+[A-Z0-9]`, which represents | |
| # UPPER_SNAKE_CASE. | |
| }, | |
| "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. | |
| # | |
| # For example, if a quota check failed with an error indicating the calling | |
| # project hasn't enabled the accessed service, this can contain a URL pointing | |
| # directly to the right place in the developer console to flip the bit. | |
| "links": [ # URL(s) pointing to additional information on handling the current error. | |
| { # Describes a URL link. | |
| "description": "A String", # Describes what the link offers. | |
| "url": "A String", # The URL of the link. | |
| }, | |
| ], | |
| }, | |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. | |
| # which can be attached to an RPC error. | |
| "locale": "A String", # The locale used following the specification defined at | |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. | |
| # Examples are: "en-US", "fr-CH", "es-MX" | |
| "message": "A String", # The localized error message in the above locale. | |
| }, | |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. | |
| "dimensions": { # The map holding related quota dimensions. | |
| "a_key": "A String", | |
| }, | |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota | |
| # type or metric. | |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type | |
| # or metric. | |
| "limitName": "A String", # The name of the quota limit. | |
| "metricName": "A String", # The Compute Engine quota metric name. | |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. | |
| }, | |
| }, | |
| ], | |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. | |
| # This property is optional. | |
| "message": "A String", # [Output Only] An optional, human-readable error message. | |
| }, | |
| ], | |
| }, | |
| "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. | |
| "healthInfo": { # Health information. # Output only. The health information. | |
| "availabilitySloStatus": "A String", # Output only. The availability SLO status. | |
| "healthStatus": "A String", # Output only. The health status. | |
| "repairCategory": "A String", # Output only. The repair category. | |
| "unhealthyReason": "A String", # Output only. The reason for unhealthy status. | |
| "updateTime": "A String", # Output only. The time when health info was updated. | |
| }, | |
| }, | |
| "getVersionOperationMetadata": { | |
| "inlineSbomInfo": { | |
| "currentComponentVersions": { # A mapping of components to their currently-applied versions or other | |
| # appropriate identifiers. | |
| "a_key": "A String", | |
| }, | |
| "targetComponentVersions": { # A mapping of components to their target versions or other appropriate | |
| # identifiers. | |
| "a_key": "A String", | |
| }, | |
| }, | |
| }, | |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error | |
| # message that was returned, such as `NOT FOUND`. | |
| "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. | |
| "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is | |
| # defined by the server. | |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. | |
| # This value is inRFC3339 | |
| # text format. | |
| "instancesBulkInsertOperationMetadata": { | |
| "perLocationStatus": { # Status information per location (location name is key). | |
| # Example key: zones/us-central1-a | |
| "a_key": { | |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. | |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. | |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an | |
| # error. | |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information | |
| # if the flow is rolling forward or rolling back. | |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. | |
| }, | |
| }, | |
| }, | |
| "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. | |
| "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. | |
| }, | |
| "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for | |
| # Operation resources. | |
| "name": "A String", # [Output Only] Name of the operation. | |
| "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a | |
| # group of operations results from a `bulkInsert` API request. | |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, | |
| # `update`, or `delete`, and so on. | |
| "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. | |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only | |
| # applicable when performing regional operations. | |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. | |
| "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata, | |
| # this field will contain information on all underlying zonal actions and | |
| # their state. | |
| "clientOperationId": "A String", # [Output Only] The client operation id. | |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). | |
| # Example key: zones/us-central1-a | |
| "a_key": { | |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is | |
| # populated. | |
| # different programming environments, including REST APIs and RPC APIs. It is | |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains | |
| # three pieces of data: error code, error message, and error details. | |
| # | |
| # You can find out more about this error model and how to work with it in the | |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). | |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. | |
| "details": [ # A list of messages that carry the error details. There is a common set of | |
| # message types for APIs to use. | |
| { | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| ], | |
| "message": "A String", # A developer-facing error message, which should be in English. Any | |
| # user-facing error message should be localized and sent in the | |
| # google.rpc.Status.details field, or localized by the client. | |
| }, | |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: | |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. | |
| }, | |
| }, | |
| }, | |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. | |
| # This value is inRFC3339 | |
| # text format. | |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the | |
| # following: | |
| # `PENDING`, `RUNNING`, or `DONE`. | |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the | |
| # operation. | |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation | |
| # of the target resource. | |
| "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 disk | |
| # that the snapshot was created from. | |
| "user": "A String", # [Output Only] User who requested the operation, for example: | |
| # `user@example.com` or | |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. | |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the | |
| # operation, this field will be populated. | |
| { | |
| "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. | |
| "data": [ # [Output Only] Metadata about this warning in key: | |
| # value format. For example: | |
| # | |
| # "data": [ | |
| # { | |
| # "key": "scope", | |
| # "value": "zones/us-east1-d" | |
| # }] | |
| { | |
| "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). | |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. | |
| }, | |
| ], | |
| "message": "A String", # [Output Only] A human-readable description of the warning code. | |
| }, | |
| ], | |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only | |
| # applicable when performing per-zone operations. | |
| }</pre> | |
| </div> | |
| </body></html> |