- HTTP request
- Path parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
Returns the specified regional HealthCheckService
resource.
HTTP request
GET https://compute.googleapis.com/compute/beta/projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project |
Project ID for this request. |
region |
Name of the region scoping this request. |
healthCheckService |
Name of the |
Request body
The request body must be empty.
Response body
Represents a Health-Check as a Service resource.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{ "kind": string, "id": string, "creationTimestamp": string, "selfLink": string, "name": string, "description": string, "region": string, "healthStatusAggregationStrategy": enum, "healthStatusAggregationPolicy": enum, "healthChecks": [ string ], "networkEndpointGroups": [ string ], "notificationEndpoints": [ string ], "fingerprint": string } |
Fields | |
---|---|
kind |
[Output only] Type of the resource. Always |
id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
creationTimestamp |
[Output Only] Creation timestamp in RFC3339 text format. |
selfLink |
[Output Only] Server-defined URL for the resource. |
name |
Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression |
description |
An optional description of this resource. Provide this property when you create the resource. |
region |
[Output Only] URL of the region where the health check service resides. This field is not applicable to global health check services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. |
healthStatusAggregationStrategy |
This field is deprecated. Use healthStatusAggregationPolicy instead. Policy for how the results from multiple health checks for the same endpoint are aggregated.
|
healthStatusAggregationPolicy |
Optional. Policy for how the results from multiple health checks for the same endpoint are aggregated. Defaults to NO_AGGREGATION if unspecified.
HealthCheckService .
|
healthChecks[] |
A list of URLs to the |
networkEndpointGroups[] |
A list of URLs to the |
notificationEndpoints[] |
A list of URLs to the |
fingerprint |
Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a A base64-encoded string. |
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/compute.readonly
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.regionHealthCheckServices.get
To find predefined roles that contain those permissions, see Compute Engine IAM Roles.