This product is not supported for your selected Datadog site. ().
이 페이지는 아직 영어로 제공되지 않습니다. 번역 작업 중입니다.
현재 번역 프로젝트에 대한 질문이나 피드백이 있으신 경우 언제든지 연락주시기 바랍니다.

gcp_compute_health_check

ancestors

Type: UNORDERED_LIST_STRING

check_interval_sec

Type: INT32
Provider name: checkIntervalSec
Description: How often (in seconds) to send a health check. The default value is 5 seconds.

creation_timestamp

Type: TIMESTAMP
Provider name: creationTimestamp
Description: [Output Only] Creation timestamp in 3339 text format.

description

Type: STRING
Provider name: description
Description: An optional description of this resource. Provide this property when you create the resource.

grpc_health_check

Type: STRUCT
Provider name: grpcHealthCheck

  • grpc_service_name
    Type: STRING
    Provider name: grpcServiceName
    Description: 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
    Type: INT32
    Provider name: port
    Description: The TCP port number to which the health check prober sends packets. Valid values are 1 through 65535.
  • port_name
    Type: STRING
    Provider name: portName
    Description: Not supported.
  • port_specification
    Type: STRING
    Provider name: portSpecification
    Description: 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.
    Possible values:
    • USE_FIXED_PORT - The port number in the health check’s port is used for health checking. Applies to network endpoint group and instance group backends.
    • USE_NAMED_PORT - Not supported.
    • USE_SERVING_PORT - For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service’s named port defined in the instance group’s named ports.

healthy_threshold

Type: INT32
Provider name: healthyThreshold
Description: A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.

http2_health_check

Type: STRUCT
Provider name: http2HealthCheck

  • host
    Type: STRING
    Provider name: host
    Description: 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
    Type: INT32
    Provider name: port
    Description: The TCP port number to which the health check prober sends packets. The default value is 443. Valid values are 1 through 65535.
  • port_name
    Type: STRING
    Provider name: portName
    Description: Not supported.
  • port_specification
    Type: STRING
    Provider name: portSpecification
    Description: 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.
    Possible values:
    • USE_FIXED_PORT - The port number in the health check’s port is used for health checking. Applies to network endpoint group and instance group backends.
    • USE_NAMED_PORT - Not supported.
    • USE_SERVING_PORT - For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service’s named port defined in the instance group’s named ports.
  • proxy_header
    Type: STRING
    Provider name: proxyHeader
    Description: Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
    Possible values:
    • NONE
    • PROXY_V1
  • request_path
    Type: STRING
    Provider name: requestPath
    Description: The request path of the HTTP/2 health check request. The default value is /. Must comply with RFC3986.
  • response
    Type: STRING
    Provider name: response
    Description: 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

http_health_check

Type: STRUCT
Provider name: httpHealthCheck

  • host
    Type: STRING
    Provider name: host
    Description: 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
    Type: INT32
    Provider name: port
    Description: The TCP port number to which the health check prober sends packets. The default value is 80. Valid values are 1 through 65535.
  • port_name
    Type: STRING
    Provider name: portName
    Description: Not supported.
  • port_specification
    Type: STRING
    Provider name: portSpecification
    Description: 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.
    Possible values:
    • USE_FIXED_PORT - The port number in the health check’s port is used for health checking. Applies to network endpoint group and instance group backends.
    • USE_NAMED_PORT - Not supported.
    • USE_SERVING_PORT - For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service’s named port defined in the instance group’s named ports.
  • proxy_header
    Type: STRING
    Provider name: proxyHeader
    Description: Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
    Possible values:
    • NONE
    • PROXY_V1
  • request_path
    Type: STRING
    Provider name: requestPath
    Description: The request path of the HTTP health check request. The default value is /. Must comply with RFC3986.
  • response
    Type: STRING
    Provider name: response
    Description: 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

https_health_check

Type: STRUCT
Provider name: httpsHealthCheck

  • host
    Type: STRING
    Provider name: host
    Description: 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
    Type: INT32
    Provider name: port
    Description: The TCP port number to which the health check prober sends packets. The default value is 443. Valid values are 1 through 65535.
  • port_name
    Type: STRING
    Provider name: portName
    Description: Not supported.
  • port_specification
    Type: STRING
    Provider name: portSpecification
    Description: 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.
    Possible values:
    • USE_FIXED_PORT - The port number in the health check’s port is used for health checking. Applies to network endpoint group and instance group backends.
    • USE_NAMED_PORT - Not supported.
    • USE_SERVING_PORT - For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service’s named port defined in the instance group’s named ports.
  • proxy_header
    Type: STRING
    Provider name: proxyHeader
    Description: Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
    Possible values:
    • NONE
    • PROXY_V1
  • request_path
    Type: STRING
    Provider name: requestPath
    Description: The request path of the HTTPS health check request. The default value is /. Must comply with RFC3986.
  • response
    Type: STRING
    Provider name: response
    Description: 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

Type: STRING
Provider name: id
Description: [Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind

Type: STRING
Provider name: kind
Description: Type of the resource.

labels

Type: UNORDERED_LIST_STRING

log_config

Type: STRUCT
Provider name: logConfig
Description: Configure logging on this health check.

  • enable
    Type: BOOLEAN
    Provider name: enable
    Description: Indicates whether or not to export logs. This is false by default, which means no health check logging will be done.

name

Type: STRING
Provider name: name
Description: 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.

organization_id

Type: STRING

parent

Type: STRING

project_id

Type: STRING

project_number

Type: STRING

region

Type: STRING
Provider name: region
Description: [Output Only] Region where the health check resides. Not applicable to global health checks.

resource_name

Type: STRING

Type: STRING
Provider name: selfLink
Description: [Output Only] Server-defined URL for the resource.

source_regions

Type: UNORDERED_LIST_STRING
Provider name: sourceRegions
Description: 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.

ssl_health_check

Type: STRUCT
Provider name: sslHealthCheck

  • port
    Type: INT32
    Provider name: port
    Description: The TCP port number to which the health check prober sends packets. The default value is 443. Valid values are 1 through 65535.
  • port_name
    Type: STRING
    Provider name: portName
    Description: Not supported.
  • port_specification
    Type: STRING
    Provider name: portSpecification
    Description: 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.
    Possible values:
    • USE_FIXED_PORT - The port number in the health check’s port is used for health checking. Applies to network endpoint group and instance group backends.
    • USE_NAMED_PORT - Not supported.
    • USE_SERVING_PORT - For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service’s named port defined in the instance group’s named ports.
  • proxy_header
    Type: STRING
    Provider name: proxyHeader
    Description: Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
    Possible values:
    • NONE
    • PROXY_V1
  • request
    Type: STRING
    Provider name: request
    Description: 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
    Type: STRING
    Provider name: response
    Description: 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

tags

Type: UNORDERED_LIST_STRING

tcp_health_check

Type: STRUCT
Provider name: tcpHealthCheck

  • port
    Type: INT32
    Provider name: port
    Description: The TCP port number to which the health check prober sends packets. The default value is 80. Valid values are 1 through 65535.
  • port_name
    Type: STRING
    Provider name: portName
    Description: Not supported.
  • port_specification
    Type: STRING
    Provider name: portSpecification
    Description: 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.
    Possible values:
    • USE_FIXED_PORT - The port number in the health check’s port is used for health checking. Applies to network endpoint group and instance group backends.
    • USE_NAMED_PORT - Not supported.
    • USE_SERVING_PORT - For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service’s named port defined in the instance group’s named ports.
  • proxy_header
    Type: STRING
    Provider name: proxyHeader
    Description: Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
    Possible values:
    • NONE
    • PROXY_V1
  • request
    Type: STRING
    Provider name: request
    Description: Instructs the health check prober to send this exact ASCII string, up to 1024 bytes in length, after establishing the TCP connection.
  • response
    Type: STRING
    Provider name: response
    Description: 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

timeout_sec

Type: INT32
Provider name: timeoutSec
Description: 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

Type: STRING
Provider name: type
Description: 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.
Possible values:

  • GRPC
  • HTTP
  • HTTP2
  • HTTPS
  • INVALID
  • SSL
  • TCP

unhealthy_threshold

Type: INT32
Provider name: unhealthyThreshold
Description: A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.