- Resource: UptimeCheckConfig
- ResourceGroup
- GroupResourceType
- SyntheticMonitorTarget
- CloudFunctionV2Target
- HttpCheck
- RequestMethod
- BasicAuthentication
- ContentType
- ResponseStatusCode
- StatusClass
- PingConfig
- ServiceAgentAuthentication
- ServiceAgentAuthenticationType
- TcpCheck
- ContentMatcher
- ContentMatcherOption
- JsonPathMatcher
- JsonPathMatcherOption
- CheckerType
- UptimeCheckRegion
- InternalChecker
- State
- Methods
Resource: UptimeCheckConfig
This message configures which resources and services to monitor for availability.
JSON representation |
---|
{ "name": string, "displayName": string, "period": string, "timeout": string, "contentMatchers": [ { object ( |
Fields | |
---|---|
name |
Identifier. A unique resource name for this Uptime check configuration. The format is:
This field should be omitted when creating the Uptime check configuration; on create, the resource name is assigned by the server and included in the response. |
display |
A human-friendly name for the Uptime check configuration. The display name should be unique within a Cloud Monitoring Workspace in order to make it easier to identify; however, uniqueness is not enforced. Required. |
period |
How often, in seconds, the Uptime check is performed. Currently, the only supported values are |
timeout |
The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required. |
content |
The content that is expected to appear in the data returned by the target server against which the check is run. Currently, only the first entry in the |
checker |
The type of checkers to use to execute the Uptime check. |
selected |
The list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions must be provided to include a minimum of 3 locations. Not specifying this field will result in Uptime checks running from all available regions. |
isInternal |
If this is |
internalCheckers[] |
The internal checkers that this check will egress from. If |
user |
User-supplied key/value data to be used for organizing and identifying the The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter. |
Union field resource . The resource the check is checking. Required. resource can be only one of the following: |
|
monitored |
The monitored resource associated with the configuration. The following monitored resource types are valid for this field: |
resource |
The group resource associated with the configuration. |
synthetic |
Specifies a Synthetic Monitor to invoke. |
Union field check_request_type . The type of Uptime check request. check_request_type can be only one of the following: |
|
http |
Contains information needed to make an HTTP or HTTPS check. |
tcp |
Contains information needed to make a TCP check. |
ResourceGroup
The resource submessage for group checks. It can be used instead of a monitored resource, when multiple resources are being monitored.
JSON representation |
---|
{
"groupId": string,
"resourceType": enum ( |
Fields | |
---|---|
group |
The group of resources being monitored. Should be only the |
resource |
The resource type of the group members. |
GroupResourceType
The supported resource types that can be used as values of group_resource.resource_type
. INSTANCE
includes gce_instance
and aws_ec2_instance
resource types. The resource types gae_app
and uptime_url
are not valid here because group checks on App Engine modules and URLs are not allowed.
Enums | |
---|---|
RESOURCE_TYPE_UNSPECIFIED |
Default value (not valid). |
INSTANCE |
A group of instances from Google Cloud Platform (GCP) or Amazon Web Services (AWS). |
AWS_ELB_LOAD_BALANCER |
A group of Amazon ELB load balancers. |
SyntheticMonitorTarget
Describes a Synthetic Monitor to be invoked by Uptime.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field target . Specifies a Synthetic Monitor's execution stack. target can be only one of the following: |
|
cloud |
Target a Synthetic Monitor GCFv2 instance. |
CloudFunctionV2Target
A Synthetic Monitor deployed to a Cloud Functions V2 instance.
JSON representation |
---|
{
"name": string,
"cloudRunRevision": {
object ( |
Fields | |
---|---|
name |
Required. Fully qualified GCFv2 resource name i.e. |
cloud |
Output only. The |
HttpCheck
Information involved in an HTTP/HTTPS Uptime check request.
JSON representation |
---|
{ "requestMethod": enum ( |
Fields | |
---|---|
request |
The HTTP request method to use for the check. If set to |
use |
If |
path |
Optional (defaults to "/"). The path to the page against which to run the check. Will be combined with the |
port |
Optional (defaults to 80 when |
auth |
The authentication information. Optional when creating an HTTP check; defaults to empty. Do not set both |
mask |
Boolean specifying whether to encrypt the header information. Encryption should be specified for any headers related to authentication that you do not wish to be seen when retrieving the configuration. The server will be responsible for encrypting the headers. On Get/List calls, if |
headers |
The list of headers to send as part of the Uptime check request. If two headers have the same key and different values, they should be entered as a single header, with the value being a comma-separated list of all the desired values as described at https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31). Entering two separate headers with the same key in a Create call will cause the first to be overwritten by the second. The maximum number of headers allowed is 100. |
content |
The content type header to use for the check. The following configurations result in errors: 1. Content type is specified in both the |
custom |
A user provided content type header to use for the check. The invalid configurations outlined in the |
validate |
Boolean specifying whether to include SSL certificate validation as a part of the Uptime check. Only applies to checks where |
body |
The request body associated with the HTTP POST request. If Note: If client libraries aren't used (which performs the conversion automatically) base64 encode your A base64-encoded string. |
accepted |
If present, the check will only pass if the HTTP response status code is in this set of status codes. If empty, the HTTP status code will only pass if the HTTP status code is 200-299. |
ping |
Contains information needed to add pings to an HTTP check. |
Union field auth_method . This field is optional and should be set only by users interested in an authenticated uptime check. Do not set both auth_method and auth_info . auth_method can be only one of the following: |
|
service |
If specified, Uptime will generate and attach an OIDC JWT token for the Monitoring service agent service account as an |
RequestMethod
The HTTP request method options.
Enums | |
---|---|
METHOD_UNSPECIFIED |
No request method specified. |
GET |
GET request. |
POST |
POST request. |
BasicAuthentication
The authentication parameters to provide to the specified resource or URL that requires a username and password. Currently, only Basic HTTP authentication is supported in Uptime checks.
JSON representation |
---|
{ "username": string, "password": string } |
Fields | |
---|---|
username |
The username to use when authenticating with the HTTP server. |
password |
The password to use when authenticating with the HTTP server. |
ContentType
Header options corresponding to the content type of a HTTP request body.
Enums | |
---|---|
TYPE_UNSPECIFIED |
No content type specified. |
URL_ENCODED |
body is in URL-encoded form. Equivalent to setting the Content-Type to application/x-www-form-urlencoded in the HTTP request. |
USER_PROVIDED |
body is in customContentType form. Equivalent to setting the Content-Type to the contents of customContentType in the HTTP request. |
ResponseStatusCode
A status to accept. Either a status code class like "2xx", or an integer status code like "200".
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field status_code . Either a specific value or a class of status codes. status_code can be only one of the following: |
|
status |
A status code to accept. |
status |
A class of status codes to accept. |
StatusClass
An HTTP status code class.
Enums | |
---|---|
STATUS_CLASS_UNSPECIFIED |
Default value that matches no status codes. |
STATUS_CLASS_1XX |
The class of status codes between 100 and 199. |
STATUS_CLASS_2XX |
The class of status codes between 200 and 299. |
STATUS_CLASS_3XX |
The class of status codes between 300 and 399. |
STATUS_CLASS_4XX |
The class of status codes between 400 and 499. |
STATUS_CLASS_5XX |
The class of status codes between 500 and 599. |
STATUS_CLASS_ANY |
The class of all status codes. |
PingConfig
Information involved in sending ICMP pings alongside public HTTP/TCP checks. For HTTP, the pings are performed for each part of the redirect chain.
JSON representation |
---|
{ "pingsCount": integer } |
Fields | |
---|---|
pings |
Number of ICMP pings. A maximum of 3 ICMP pings is currently supported. |
ServiceAgentAuthentication
Contains information needed for generating either an OpenID Connect token or OAuth token. The token will be generated for the Monitoring service agent service account.
JSON representation |
---|
{
"type": enum ( |
Fields | |
---|---|
type |
Type of authentication. |
ServiceAgentAuthenticationType
Type of authentication.
Enums | |
---|---|
SERVICE_AGENT_AUTHENTICATION_TYPE_UNSPECIFIED |
Default value, will result in OIDC Authentication. |
OIDC_TOKEN |
OIDC Authentication |
TcpCheck
Information required for a TCP Uptime check request.
JSON representation |
---|
{
"port": integer,
"pingConfig": {
object ( |
Fields | |
---|---|
port |
The TCP port on the server against which to run the check. Will be combined with host (specified within the |
ping |
Contains information needed to add pings to a TCP check. |
ContentMatcher
Optional. Used to perform content matching. This allows matching based on substrings and regular expressions, together with their negations. Only the first 4 MB of an HTTP or HTTPS check's response (and the first 1 MB of a TCP check's response) are examined for purposes of content matching.
JSON representation |
---|
{ "content": string, "matcher": enum ( |
Fields | |
---|---|
content |
String, regex or JSON content to match. Maximum 1024 bytes. An empty |
matcher |
The type of content matcher that will be applied to the server output, compared to the |
Union field additional_matcher_info . Certain ContentMatcherOption types require additional information. MATCHES_JSON_PATH or NOT_MATCHES_JSON_PATH require a JsonPathMatcher ; not used for other options. additional_matcher_info can be only one of the following: |
|
json |
Matcher information for |
ContentMatcherOption
Options to perform content matching.
Enums | |
---|---|
CONTENT_MATCHER_OPTION_UNSPECIFIED |
No content matcher type specified (maintained for backward compatibility, but deprecated for future use). Treated as CONTAINS_STRING . |
CONTAINS_STRING |
Selects substring matching. The match succeeds if the output contains the content string. This is the default value for checks without a matcher option, or where the value of matcher is CONTENT_MATCHER_OPTION_UNSPECIFIED . |
NOT_CONTAINS_STRING |
Selects negation of substring matching. The match succeeds if the output does NOT contain the content string. |
MATCHES_REGEX |
Selects regular-expression matching. The match succeeds if the output matches the regular expression specified in the content string. Regex matching is only supported for HTTP/HTTPS checks. |
NOT_MATCHES_REGEX |
Selects negation of regular-expression matching. The match succeeds if the output does NOT match the regular expression specified in the content string. Regex matching is only supported for HTTP/HTTPS checks. |
MATCHES_JSON_PATH |
Selects JSONPath matching. See JsonPathMatcher for details on when the match succeeds. JSONPath matching is only supported for HTTP/HTTPS checks. |
NOT_MATCHES_JSON_PATH |
Selects JSONPath matching. See JsonPathMatcher for details on when the match succeeds. Succeeds when output does NOT match as specified. JSONPath is only supported for HTTP/HTTPS checks. |
JsonPathMatcher
Information needed to perform a JSONPath content match. Used for ContentMatcherOption::MATCHES_JSON_PATH
and ContentMatcherOption::NOT_MATCHES_JSON_PATH
.
JSON representation |
---|
{
"jsonPath": string,
"jsonMatcher": enum ( |
Fields | |
---|---|
json |
JSONPath within the response output pointing to the expected |
json |
The type of JSONPath match that will be applied to the JSON output ( |
JsonPathMatcherOption
Options to perform JSONPath content matching.
Enums | |
---|---|
JSON_PATH_MATCHER_OPTION_UNSPECIFIED |
No JSONPath matcher type specified (not valid). |
EXACT_MATCH |
Selects 'exact string' matching. The match succeeds if the content at the jsonPath within the output is exactly the same as the content string. |
REGEX_MATCH |
Selects regular-expression matching. The match succeeds if the content at the jsonPath within the output matches the regular expression specified in the content string. |
CheckerType
What kind of checkers are available to be used by the check.
Enums | |
---|---|
CHECKER_TYPE_UNSPECIFIED |
The default checker type. Currently converted to STATIC_IP_CHECKERS on creation, the default conversion behavior may change in the future. |
STATIC_IP_CHECKERS |
STATIC_IP_CHECKERS are used for uptime checks that perform egress across the public internet. STATIC_IP_CHECKERS use the static IP addresses returned by uptimeCheckIps.list . |
VPC_CHECKERS |
VPC_CHECKERS are used for uptime checks that perform egress using Service Directory and private network access. When using VPC_CHECKERS , the monitored resource type must be servicedirectory_service . |
UptimeCheckRegion
The regions from which an Uptime check can be run.
Enums | |
---|---|
REGION_UNSPECIFIED |
Default value if no region is specified. Will result in Uptime checks running from all regions. |
USA |
Allows checks to run from locations within the United States of America. |
EUROPE |
Allows checks to run from locations within the continent of Europe. |
SOUTH_AMERICA |
Allows checks to run from locations within the continent of South America. |
ASIA_PACIFIC |
Allows checks to run from locations within the Asia Pacific area (ex: Singapore). |
USA_OREGON |
Allows checks to run from locations within the western United States of America |
USA_IOWA |
Allows checks to run from locations within the central United States of America |
USA_VIRGINIA |
Allows checks to run from locations within the eastern United States of America |
InternalChecker
An internal checker allows Uptime checks to run on private/internal GCP resources.
JSON representation |
---|
{
"name": string,
"displayName": string,
"network": string,
"gcpZone": string,
"peerProjectId": string,
"state": enum ( |
Fields | |
---|---|
name |
A unique resource name for this InternalChecker. The format is:
|
display |
The checker's human-readable name. The display name should be unique within a Cloud Monitoring Metrics Scope in order to make it easier to identify; however, uniqueness is not enforced. |
network |
The GCP VPC network where the internal resource lives (ex: "default"). |
gcp |
The GCP zone the Uptime check should egress from. Only respected for internal Uptime checks, where internal_network is specified. |
peer |
The GCP project ID where the internal checker lives. Not necessary the same as the Metrics Scope project. |
state |
The current operational state of the internal checker. |
State
Operational states for an internal checker.
Enums | |
---|---|
UNSPECIFIED |
An internal checker should never be in the unspecified state. |
CREATING |
The checker is being created, provisioned, and configured. A checker in this state can be returned by ListInternalCheckers or GetInternalChecker , as well as by examining the long running Operation that created it. |
RUNNING |
The checker is running and available for use. A checker in this state can be returned by ListInternalCheckers or GetInternalChecker as well as by examining the long running Operation that created it. If a checker is being torn down, it is neither visible nor usable, so there is no "deleting" or "down" state. |
Methods |
|
---|---|
|
Creates a new Uptime check configuration. |
|
Deletes an Uptime check configuration. |
|
Gets a single Uptime check configuration. |
|
Lists the existing valid Uptime check configurations for the project (leaving out any invalid configurations). |
|
Updates an Uptime check configuration. |