- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
Updates a HealthCheck resource in the specified project using the data included in the request.
HTTP request
PUT https://compute.googleapis.com/compute/beta/projects/{project}/global/healthChecks/{healthCheck}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project
|
Project ID for this request. |
healthCheck
|
Name of the HealthCheck resource to update. |
Query parameters
Parameters | |
---|---|
requestId
|
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 ( |
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 } , "sourceRegions" : [ string ] , "selfLink" : string , "region" : string , "logConfig" : { "enable" : boolean } } |
kind
string
Type of the resource.
id
string ( uint64
format)
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
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
. 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
or GRPC
. 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: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-ssl-tcp
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: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-ssl-tcp
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: https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest
httpHealthCheck.requestPath
string
The request path of the HTTP health check request. The default value is /
. Must comply with RFC3986
.
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: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http
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: https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest
httpsHealthCheck.requestPath
string
The request path of the HTTPS health check request. The default value is /
. Must comply with RFC3986
.
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: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http
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: https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest
http2HealthCheck.requestPath
string
The request path of the HTTP/2 health check request. The default value is /
. Must comply with RFC3986
.
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: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http
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.
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, and GRPC 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:
You can use an operation resource to manage asynchronous API requests. For more information, read 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 .
Note that completed Operation resources have a limited 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 , // Union field |
kind
string
[Output Only] Type of the resource. Always compute#operation
for Operation resources.
id
string ( uint64
format)
[Output Only] The unique identifier for the operation. This identifier is defined by the server.
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 persistent disk that the snapshot was created from.
targetId
string ( uint64
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
.
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.
startTime
string
[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
endTime
string
[Output Only] The time that this operation was completed. This value is in RFC3339 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.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-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
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
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
error.errors[].errorDetails[].localizedMessage.locale
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"
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:
"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.
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.
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.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.
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 .
IAM Permissions
In addition to any permissions specified on the fields above, authorization requires one or more of the following IAM permissions:
-
compute.healthChecks.update
To find predefined roles that contain those permissions, see Compute Engine IAM Roles .