- [HTTP request](https://docs.cloud.google.com/compute/docs/reference/rest/2026-09-01/regionHealthChecks/insert#body.HTTP_TEMPLATE) - [Path parameters](https://docs.cloud.google.com/compute/docs/reference/rest/2026-09-01/regionHealthChecks/insert#body.PATH_PARAMETERS) - [Query parameters](https://docs.cloud.google.com/compute/docs/reference/rest/2026-09-01/regionHealthChecks/insert#body.QUERY_PARAMETERS) - [Request body](https://docs.cloud.google.com/compute/docs/reference/rest/2026-09-01/regionHealthChecks/insert#body.request_body) - [JSON representation](https://docs.cloud.google.com/compute/docs/reference/rest/2026-09-01/regionHealthChecks/insert#body.request_body.SCHEMA_REPRESENTATION) - [Response body](https://docs.cloud.google.com/compute/docs/reference/rest/2026-09-01/regionHealthChecks/insert#body.response_body) - [JSON representation](https://docs.cloud.google.com/compute/docs/reference/rest/2026-09-01/regionHealthChecks/insert#body.Operation.SCHEMA_REPRESENTATION) - [JSON representation](https://docs.cloud.google.com/compute/docs/reference/rest/2026-09-01/regionHealthChecks/insert#body.Operation.SCHEMA_REPRESENTATION.error.SCHEMA_REPRESENTATION) - [JSON representation](https://docs.cloud.google.com/compute/docs/reference/rest/2026-09-01/regionHealthChecks/insert#body.Operation.SCHEMA_REPRESENTATION.error.SCHEMA_REPRESENTATION.error_details.SCHEMA_REPRESENTATION) - [JSON representation](https://docs.cloud.google.com/compute/docs/reference/rest/2026-09-01/regionHealthChecks/insert#body.Operation.SCHEMA_REPRESENTATION.error.SCHEMA_REPRESENTATION.error_details.SCHEMA_REPRESENTATION_1) - [JSON representation](https://docs.cloud.google.com/compute/docs/reference/rest/2026-09-01/regionHealthChecks/insert#body.Operation.SCHEMA_REPRESENTATION.error.SCHEMA_REPRESENTATION.error_details.SCHEMA_REPRESENTATION_2) - [JSON representation](https://docs.cloud.google.com/compute/docs/reference/rest/2026-09-01/regionHealthChecks/insert#body.Operation.SCHEMA_REPRESENTATION.error.SCHEMA_REPRESENTATION.error_details.SCHEMA_REPRESENTATION_3) - [JSON representation](https://docs.cloud.google.com/compute/docs/reference/rest/2026-09-01/regionHealthChecks/insert#body.Operation.SCHEMA_REPRESENTATION.warning.SCHEMA_REPRESENTATION) - [JSON representation](https://docs.cloud.google.com/compute/docs/reference/rest/2026-09-01/regionHealthChecks/insert#body.Operation.SCHEMA_REPRESENTATION.set_common_instance_metadata_operation_metadata.inlinedField_1.map_entry1.value.SCHEMA_REPRESENTATION) - [JSON representation](https://docs.cloud.google.com/compute/docs/reference/rest/2026-09-01/regionHealthChecks/insert#body.Operation.SCHEMA_REPRESENTATION.get_version_operation_metadata.SCHEMA_REPRESENTATION) - [JSON representation](https://docs.cloud.google.com/compute/docs/reference/rest/2026-09-01/regionHealthChecks/insert#body.Operation.SCHEMA_REPRESENTATION.get_health_operation_metadata.SCHEMA_REPRESENTATION) - [Authorization scopes](https://docs.cloud.google.com/compute/docs/reference/rest/2026-09-01/regionHealthChecks/insert#body.aspect) - [Try it!](https://docs.cloud.google.com/compute/docs/reference/rest/2026-09-01/regionHealthChecks/insert#try-it) API Version : 2026-09-01 Creates a HealthCheck resource in the specified project using the data included in the request. ### HTTP request Choose an endpoint: global africa-south1 asia-east1 asia-east2 asia-northeast1 asia-northeast2 asia-northeast3 asia-south1 asia-south2 asia-southeast1 asia-southeast2 asia-southeast3 australia-southeast1 australia-southeast2 europe-central2 europe-north1 europe-north2 europe-southwest1 europe-west1 europe-west10 europe-west12 europe-west2 europe-west3 europe-west4 europe-west6 europe-west8 europe-west9 me-central1 me-central2 me-west1 northamerica-northeast1 northamerica-northeast2 northamerica-south1 southamerica-east1 southamerica-west1 us-central1 us-east1 us-east4 us-east5 us-south1 us-west1 us-west2 us-west3 us-west4 `POST https://compute.googleapis.com/compute/v1/projects/{project}/regions/{region}/healthChecks?$apiVersion=2026-09-01`
The URLs use [gRPC Transcoding](https://google.aip.dev/127) syntax. ### Path parameters | Parameters || |---|---| | `project` | `string` Project ID for this request. | | `region` | `string` Name of the region scoping this request. | ### Query parameters | Parameters || |---|---| | `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](https://tools.ietf.org/html/rfc4122) with the exception that zero UUID is not supported (`00000000-0000-0000-0000-000000000000`). | ### Request body The request body contains data with the following structure: | JSON representation | |---| | ``` { "kind": string, "id": string, "creationTimestamp": string, "name": string, "description": string, "checkIntervalSec": integer, "timeoutSec": integer, "unhealthyThreshold": integer, "healthyThreshold": integer, "type": enum, "tcpHealthCheck": { "port": integer, "portName": string, "portSpecification": enum, "request": string, "response": string, "proxyHeader": enum }, "sslHealthCheck": { "port": integer, "portName": string, "portSpecification": enum, "request": string, "response": string, "proxyHeader": enum }, "httpHealthCheck": { "port": integer, "portName": string, "portSpecification": enum, "host": string, "requestPath": string, "proxyHeader": enum, "response": string }, "httpsHealthCheck": { "port": integer, "portName": string, "portSpecification": enum, "host": string, "requestPath": string, "proxyHeader": enum, "response": string }, "http2HealthCheck": { "port": integer, "portName": string, "portSpecification": enum, "host": string, "requestPath": string, "proxyHeader": enum, "response": string }, "grpcHealthCheck": { "port": integer, "portName": string, "portSpecification": enum, "grpcServiceName": string }, "grpcTlsHealthCheck": { "port": integer, "portSpecification": enum, "grpcServiceName": string }, "sourceRegions": [ string ], "selfLink": string, "region": string, "logConfig": { "enable": boolean } } ``` | | Fields || |---|---| | `kind` | `string` Output only. Type of the resource. | | `id` | `string (https://developers.google.com/discovery/v1/type-format format)` Output only. The unique identifier for the resource. This identifier is defined by the server. | | `creationTimestamp` | `string` Output only. Creation timestamp in [3339](https://www.ietf.org/rfc/rfc3339.txt) text format. | | `name` | `string` Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). 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. | | `description` | `string` An optional description of this resource. Provide this property when you create the resource. | | `checkIntervalSec` | `integer` How often (in seconds) to send a health check. The default value is 5 seconds. | | `timeoutSec` | `integer` 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`. | | `unhealthyThreshold` | `integer` A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. | | `healthyThreshold` | `integer` A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. | | `type` | `enum` 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. | | `tcpHealthCheck` | `object` | | `tcpHealthCheck.port` | `integer` The TCP port number to which the health check prober sends packets. The default value is `80`. Valid values are `1` through `65535`. | | `tcpHealthCheck.portName` | `string` Not supported. | | `tcpHealthCheck.portSpecification` | `enum` 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 the `port` 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. | | `tcpHealthCheck.request` | `string` Instructs the health check prober to send this exact ASCII string, up to 1024 bytes in length, after establishing the TCP connection. | | `tcpHealthCheck.response` | `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: | | `tcpHealthCheck.proxyHeader` | `enum` Specifies the type of proxy header to append before sending data to the backend, either `NONE` or `PROXY_V1`. The default is `NONE`. | | `sslHealthCheck` | `object` | | `sslHealthCheck.port` | `integer` The TCP port number to which the health check prober sends packets. The default value is `443`. Valid values are `1` through `65535`. | | `sslHealthCheck.portName` | `string` Not supported. | | `sslHealthCheck.portSpecification` | `enum` 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 the `port` 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. | | `sslHealthCheck.request` | `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. | | `sslHealthCheck.response` | `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: | | `sslHealthCheck.proxyHeader` | `enum` Specifies the type of proxy header to append before sending data to the backend, either `NONE` or `PROXY_V1`. The default is `NONE`. | | `httpHealthCheck` | `object` | | `httpHealthCheck.port` | `integer` The TCP port number to which the health check prober sends packets. The default value is `80`. Valid values are `1` through `65535`. | | `httpHealthCheck.portName` | `string` Not supported. | | `httpHealthCheck.portSpecification` | `enum` 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 the `port` 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. | | `httpHealthCheck.host` | `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: | | `httpHealthCheck.requestPath` | `string` The request path of the HTTP health check request. The default value is `/`. Must comply with [RFC3986](https://www.ietf.org/rfc/rfc3986.txt). | | `httpHealthCheck.proxyHeader` | `enum` Specifies the type of proxy header to append before sending data to the backend, either `NONE` or `PROXY_V1`. The default is `NONE`. | | `httpHealthCheck.response` | `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: | | `httpsHealthCheck` | `object` | | `httpsHealthCheck.port` | `integer` The TCP port number to which the health check prober sends packets. The default value is `443`. Valid values are `1` through `65535`. | | `httpsHealthCheck.portName` | `string` Not supported. | | `httpsHealthCheck.portSpecification` | `enum` 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 the `port` 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. | | `httpsHealthCheck.host` | `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: | | `httpsHealthCheck.requestPath` | `string` The request path of the HTTPS health check request. The default value is `/`. Must comply with [RFC3986](https://www.ietf.org/rfc/rfc3986.txt). | | `httpsHealthCheck.proxyHeader` | `enum` Specifies the type of proxy header to append before sending data to the backend, either `NONE` or `PROXY_V1`. The default is `NONE`. | | `httpsHealthCheck.response` | `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: | | `http2HealthCheck` | `object` | | `http2HealthCheck.port` | `integer` The TCP port number to which the health check prober sends packets. The default value is `443`. Valid values are `1` through `65535`. | | `http2HealthCheck.portName` | `string` Not supported. | | `http2HealthCheck.portSpecification` | `enum` 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 the `port` 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. | | `http2HealthCheck.host` | `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: | | `http2HealthCheck.requestPath` | `string` The request path of the HTTP/2 health check request. The default value is `/`. Must comply with [RFC3986](https://www.ietf.org/rfc/rfc3986.txt). | | `http2HealthCheck.proxyHeader` | `enum` Specifies the type of proxy header to append before sending data to the backend, either `NONE` or `PROXY_V1`. The default is `NONE`. | | `http2HealthCheck.response` | `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: | | `grpcHealthCheck` | `object` | | `grpcHealthCheck.port` | `integer` The TCP port number to which the health check prober sends packets. Valid values are `1` through `65535`. | | `grpcHealthCheck.portName` | `string` Not supported. | | `grpcHealthCheck.portSpecification` | `enum` 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 the `port` 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. | | `grpcHealthCheck.grpcServiceName` | `string` The gRPC service name for the health check. This field is optional. The value of grpcServiceName has the following meanings by convention: - Empty serviceName means the overall status of all services at the backend. - Non-empty serviceName means the health of that gRPC service, as defined by the owner of the service. The grpcServiceName can only be ASCII. | | `grpcTlsHealthCheck` | `object` | | `grpcTlsHealthCheck.port` | `integer` The TCP port number to which the health check prober sends packets. Valid values are `1` through `65535`. | | `grpcTlsHealthCheck.portSpecification` | `enum` 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 the `port` 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` | `string` The gRPC service name for the health check. This field is optional. The value of grpcServiceName has the following meanings by convention: - Empty serviceName means the overall status of all services at the backend. - Non-empty serviceName means the health of that gRPC service, as defined by the owner of the service. The grpcServiceName can only be ASCII. | | `sourceRegions[]` | `string` 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.
| | `selfLink` | `string` Output only. Server-defined URL for the resource. | | `region` | `string` Output only. Region where the health check resides. Not applicable to global health checks. | | `logConfig` | `object` Configure logging on this health check. | | `logConfig.enable` | `boolean` Indicates whether or not to export logs. This is false by default, which means no health check logging will be done. | ### Response body Represents an Operation resource. Google Compute Engine has three Operation resources: - [Global](https://docs.cloud.google.com/compute/docs/reference/rest/v1/globalOperations) - [Regional](https://docs.cloud.google.com/compute/docs/reference/rest/v1/regionOperations) - [Zonal](https://docs.cloud.google.com/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read [Handling API responses](https://docs.cloud.google.com/compute/docs/api/how-tos/api-requests-responses#handling_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](https://docs.cloud.google.com/compute/docs/regions-zones/global-regional-zonal-resources). Note that completed Operation resources have a limited [retention period.](https://cloud.google.com/compute/docs/instances/viewing-compute-operations#operation-retention-period) If successful, the response body contains data with the following structure: | JSON representation | |---| | ``` { "kind": string, "id": string, "creationTimestamp": string, "name": string, "zone": string, "clientOperationId": string, "operationType": string, "targetLink": string, "targetId": string, "status": enum, "statusMessage": string, "user": string, "progress": integer, "insertTime": string, "startTime": string, "endTime": string, "error": { "errors": [ { "code": string, "location": string, "message": string, "errorDetails": [ { "errorInfo": { "reason": string, "domain": string, "metadatas": { string: string, ... } }, "quotaInfo": { "metricName": string, "limitName": string, "dimensions": { string: string, ... }, "limit": number, "futureLimit": number, "rolloutStatus": enum }, "help": { "links": [ { "description": string, "url": string } ] }, "localizedMessage": { "locale": string, "message": string } } ] } ] }, "warnings": [ { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] } ], "httpErrorStatusCode": integer, "httpErrorMessage": string, "selfLink": string, "region": string, "description": string, "operationGroupId": string, // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "setCommonInstanceMetadataOperationMetadata": { "clientOperationId": string, "perLocationOperations": { string: { "state": enum, "error": { "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } }, ... } }, "instancesBulkInsertOperationMetadata": { "perLocationStatus": { string: { "status": enum, "targetVmCount": integer, "createdVmCount": integer, "failedToCreateVmCount": integer, "deletedVmCount": integer }, ... } }, "getVersionOperationMetadata": { "inlineSbomInfo": { "currentComponentVersions": { string: string, ... }, "targetComponentVersions": { string: string, ... } } }, "getHealthOperationMetadata": { "healthInfo": { "healthStatus": enum, "unhealthyReason": enum, "repairCategory": enum, "availabilitySloStatus": enum, "updateTime": string } } // End of mutually exclusive fields. } ``` | | Fields || |---|---| | `kind` | `string` Output only. Type of the resource. Always `compute#operation` for Operation resources. | | `id` | `string (https://developers.google.com/discovery/v1/type-format format)` Output only. The unique identifier for the operation. This identifier is defined by the server. | | `creationTimestamp` | `string` \[Deprecated\] This field is deprecated. | | `name` | `string` Output only. Name of the operation. | | `zone` | `string` Output only. The URL of the zone where the operation resides. Only applicable when performing per-zone operations. | | `clientOperationId` | `string` Output only. The value of `requestId` if you provided it in the request. Not present otherwise. | | `operationType` | `string` Output only. The type of operation, such as `insert`, `update`, or `delete`, and so on. | | `targetLink` | `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. | | `targetId` | `string (https://developers.google.com/discovery/v1/type-format format)` Output only. The unique target ID, which identifies a specific incarnation of the target resource. | | `status` | `enum` Output only. The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. | | `statusMessage` | `string` Output only. An optional textual description of the current status of the operation. | | `user` | `string` Output only. User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. | | `progress` | `integer` 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. | | `insertTime` | `string` Output only. The time that this operation was requested. This value is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. | | `startTime` | `string` Output only. The time that this operation was started by the server. This value is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. | | `endTime` | `string` Output only. The time that this operation was completed. This value is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. | | `error` | `object` Output only. If errors are generated during processing of the operation, this field will be populated. | | `error.errors[]` | `object` Output only. The array of errors encountered while processing this operation. | | `error.errors[].code` | `string` Output only. The error type identifier for this error. | | `error.errors[].location` | `string` Output only. Indicates the field in the request that caused the error. This property is optional. | | `error.errors[].message` | `string` Output only. An optional, human-readable error message. | | `error.errors[].errorDetails[]` | `object` 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. | | `error.errors[].errorDetails[].errorInfo` | `object` Error information containing structured domain, reason, and metadata. | | `error.errors[].errorDetails[].errorInfo.reason` | `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_]+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. | | `error.errors[].errorDetails[].errorInfo.domain` | `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". | | `error.errors[].errorDetails[].errorInfo.metadatas` | `map (key: string, value: string)` Additional structured details about this error. Keys must match a regular expression of `[a-z][a-zA-Z0-9-_]+` 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. | | `error.errors[].errorDetails[].quotaInfo` | `object` Details about quota limits and metrics when a quota is exceeded. | | `error.errors[].errorDetails[].quotaInfo.metricName` | `string` The Compute Engine quota metric name. | | `error.errors[].errorDetails[].quotaInfo.limitName` | `string` The name of the quota limit. | | `error.errors[].errorDetails[].quotaInfo.dimensions` | `map (key: string, value: string)` The map holding related quota dimensions. | | `error.errors[].errorDetails[].quotaInfo.limit` | `number` Current effective quota limit. The limit's unit depends on the quota type or metric. | | `error.errors[].errorDetails[].quotaInfo.futureLimit` | `number` Future quota limit being rolled out. The limit's unit depends on the quota type or metric. | | `error.errors[].errorDetails[].quotaInfo.rolloutStatus` | `enum` Rollout status of the future quota limit. | | `error.errors[].errorDetails[].help` | `object` Links and information to help the user resolve the error. | | `error.errors[].errorDetails[].help.links[]` | `object` URL(s) pointing to additional information on handling the current error. | | `error.errors[].errorDetails[].help.links[].description` | `string` Describes what the link offers. | | `error.errors[].errorDetails[].help.links[].url` | `string` The URL of the link. | | `error.errors[].errorDetails[].localizedMessage` | `object` A localized human-readable error message intended for end users. | | `error.errors[].errorDetails[].localizedMessage.locale` | `string` The locale used following the specification defined at . Examples are: "en-US", "fr-CH", "es-MX" | | `error.errors[].errorDetails[].localizedMessage.message` | `string` The localized error message in the above locale. | | `warnings[]` | `object` Output only. If warning messages are generated during processing of the operation, this field will be populated. | | `warnings[].code` | `enum` Output only. A warning code, if applicable. For example, Compute Engine returns `NO_RESULTS_ON_PAGE` if there are no results in the response. | | `warnings[].message` | `string` Output only. A human-readable description of the warning code. | | `warnings[].data[]` | `object` Output only. Metadata about this warning in `key: value` format. For example: ```html "data": [ { "key": "scope", "value": "zones/us-east1-d" }] ```
| | `warnings[].data[].key` | `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). | | `warnings[].data[].value` | `string` Output only. A warning data value corresponding to the key. | | `httpErrorStatusCode` | `integer` 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. | | `httpErrorMessage` | `string` Output only. If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. | | `selfLink` | `string` Output only. Server-defined URL for the resource. | | `region` | `string` Output only. The URL of the region where the operation resides. Only applicable when performing regional operations. | | `description` | `string` Output only. A textual description of the operation, which is set when the operation is created. | | `operationGroupId` | `string` Output only. An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. | | Output only. Service-specific metadata attached to this operation. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response: || | `setCommonInstanceMetadataOperationMetadata` | `object` Output only. If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state. | | `setCommonInstanceMetadataOperationMetadata.clientOperationId` | `string` Output only. The client operation id. | | `setCommonInstanceMetadataOperationMetadata.perLocationOperations[]` | `map (key: string, value: object)` Output only. Status information per location (location name is key). Example key: zones/us-central1-a | | `setCommonInstanceMetadataOperationMetadata.perLocationOperations[].state` | `enum` Output only. Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. | | `setCommonInstanceMetadataOperationMetadata.perLocationOperations[].error` | `object` Output only. If state is `ABANDONED` or `FAILED`, this field is populated. | | `setCommonInstanceMetadataOperationMetadata.perLocationOperations[].error.code` | `integer` The status code, which should be an enum value of `google.rpc.Code`. | | `setCommonInstanceMetadataOperationMetadata.perLocationOperations[].error.message` | `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. | | `setCommonInstanceMetadataOperationMetadata.perLocationOperations[].error.details[]` | `object` A list of messages that carry the error details. There is a common set of message types for APIs to use. An object containing fields of an arbitrary type. An additional field `"@type"` contains a URI identifying the type. Example: `{ "id": 1234, "@type": "types.example.com/standard/id" }`. | | `instancesBulkInsertOperationMetadata` | `object` | | `instancesBulkInsertOperationMetadata.perLocationStatus[]` | `map (key: string, value: object)` Status information per location (location name is key). Example key: zones/us-central1-a | | `instancesBulkInsertOperationMetadata.perLocationStatus[].status` | `enum` Output only. Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. | | `instancesBulkInsertOperationMetadata.perLocationStatus[].targetVmCount` | `integer` Output only. Count of VMs originally planned to be created. | | `instancesBulkInsertOperationMetadata.perLocationStatus[].createdVmCount` | `integer` Output only. Count of VMs successfully created so far. | | `instancesBulkInsertOperationMetadata.perLocationStatus[].failedToCreateVmCount` | `integer` Output only. Count of VMs that started creating but encountered an error. | | `instancesBulkInsertOperationMetadata.perLocationStatus[].deletedVmCount` | `integer` Output only. Count of VMs that got deleted during rollback. | | `getVersionOperationMetadata` | `object` | | `getVersionOperationMetadata.inlineSbomInfo` | `object` | | `getVersionOperationMetadata.inlineSbomInfo.currentComponentVersions` | `map (key: string, value: string)` A mapping of components to their currently-applied versions or other appropriate identifiers. | | `getVersionOperationMetadata.inlineSbomInfo.targetComponentVersions` | `map (key: string, value: string)` A mapping of components to their target versions or other appropriate identifiers. | | `getHealthOperationMetadata` | `object` Output only. Metadata for GetHealth operations. | | `getHealthOperationMetadata.healthInfo` | `object` Output only. The health information. | | `getHealthOperationMetadata.healthInfo.healthStatus` | `enum` Output only. The health status. | | `getHealthOperationMetadata.healthInfo.unhealthyReason` | `enum` Output only. The reason for unhealthy status. | | `getHealthOperationMetadata.healthInfo.repairCategory` | `enum` Output only. The repair category. | | `getHealthOperationMetadata.healthInfo.availabilitySloStatus` | `enum` Output only. The availability SLO status. | | `getHealthOperationMetadata.healthInfo.updateTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. The time when health info was updated. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. | | End of mutually exclusive fields. || ### Authorization scopes Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/compute` - ` https://www.googleapis.com/auth/cloud-platform` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp).