uptime_check_configs

Creates, updates, deletes, gets or lists a uptime_check_configs resource.

Overview

Name	uptime_check_configs
Type	Resource
Id	google.monitoring.uptime_check_configs

Fields

The following fields are returned by SELECT queries:

projects_uptime_check_configs_get

Successful response

Name	Datatype	Description
name	string	Identifier. A unique resource name for this Uptime check configuration. The format is: projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID] [PROJECT_ID_OR_NUMBER] is the Workspace host project associated with the Uptime check.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.
checkerType	string	The type of checkers to use to execute the Uptime check.
contentMatchers	array	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 content_matchers list is supported, and additional entries will be ignored. This field is optional and should only be specified if a content match is required as part of the/ Uptime check.
disabled	boolean	Whether the check is disabled or not.
displayName	string	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.
httpCheck	object	Contains information needed to make an HTTP or HTTPS check. (id: HttpCheck)
internalCheckers	array	The internal checkers that this check will egress from. If is_internal is true and this list is empty, the check will egress from all the InternalCheckers configured for the project that owns this UptimeCheckConfig.
isInternal	boolean	If this is true, then checks are made only from the 'internal_checkers'. If it is false, then checks are made only from the 'selected_regions'. It is an error to provide 'selected_regions' when is_internal is true, or to provide 'internal_checkers' when is_internal is false.
logCheckFailures	boolean	To specify whether to log the results of failed probes to Cloud Logging.
monitoredResource	object	An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for "gce_instance" has labels "project_id", "instance_id" and "zone": { "type": "gce_instance", "labels": { "project_id": "my-project", "instance_id": "12345678901234", "zone": "us-central1-a" }} (id: MonitoredResource)
period	string (google-duration)	How often, in seconds, the Uptime check is performed. Currently, the only supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional, defaults to 60s.
resourceGroup	object	The group resource associated with the configuration. (id: ResourceGroup)
selectedRegions	array	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.
syntheticMonitor	object	Specifies a Synthetic Monitor to invoke. (id: SyntheticMonitorTarget)
tcpCheck	object	Contains information needed to make a TCP check. (id: TcpCheck)
timeout	string (google-duration)	The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required.
userLabels	object	User-supplied key/value data to be used for organizing and identifying the UptimeCheckConfig objects.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.

projects_uptime_check_configs_list

Successful response

Name	Datatype	Description
name	string	Identifier. A unique resource name for this Uptime check configuration. The format is: projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID] [PROJECT_ID_OR_NUMBER] is the Workspace host project associated with the Uptime check.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.
checkerType	string	The type of checkers to use to execute the Uptime check.
contentMatchers	array	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 content_matchers list is supported, and additional entries will be ignored. This field is optional and should only be specified if a content match is required as part of the/ Uptime check.
disabled	boolean	Whether the check is disabled or not.
displayName	string	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.
httpCheck	object	Contains information needed to make an HTTP or HTTPS check. (id: HttpCheck)
internalCheckers	array	The internal checkers that this check will egress from. If is_internal is true and this list is empty, the check will egress from all the InternalCheckers configured for the project that owns this UptimeCheckConfig.
isInternal	boolean	If this is true, then checks are made only from the 'internal_checkers'. If it is false, then checks are made only from the 'selected_regions'. It is an error to provide 'selected_regions' when is_internal is true, or to provide 'internal_checkers' when is_internal is false.
logCheckFailures	boolean	To specify whether to log the results of failed probes to Cloud Logging.
monitoredResource	object	An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for "gce_instance" has labels "project_id", "instance_id" and "zone": { "type": "gce_instance", "labels": { "project_id": "my-project", "instance_id": "12345678901234", "zone": "us-central1-a" }} (id: MonitoredResource)
period	string (google-duration)	How often, in seconds, the Uptime check is performed. Currently, the only supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional, defaults to 60s.
resourceGroup	object	The group resource associated with the configuration. (id: ResourceGroup)
selectedRegions	array	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.
syntheticMonitor	object	Specifies a Synthetic Monitor to invoke. (id: SyntheticMonitorTarget)
tcpCheck	object	Contains information needed to make a TCP check. (id: TcpCheck)
timeout	string (google-duration)	The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required.
userLabels	object	User-supplied key/value data to be used for organizing and identifying the UptimeCheckConfig objects.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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_uptime_check_configs_get	select	projectsId, uptimeCheckConfigsId		Gets a single Uptime check configuration.
projects_uptime_check_configs_list	select	projectsId	filter, pageSize, pageToken	Lists the existing valid Uptime check configurations for the project (leaving out any invalid configurations).
projects_uptime_check_configs_create	insert	projectsId		Creates a new Uptime check configuration.
projects_uptime_check_configs_patch	update	projectsId, uptimeCheckConfigsId	updateMask	Updates an Uptime check configuration. You can either replace the entire configuration with a new one or replace only certain fields in the current configuration by specifying the fields to be updated via updateMask. Returns the updated configuration.
projects_uptime_check_configs_delete	delete	projectsId, uptimeCheckConfigsId		Deletes an Uptime check configuration. Note that this method will fail if the Uptime check configuration is referenced by an alert policy or other dependent configs that would be rendered invalid by the deletion.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
projectsId	string
uptimeCheckConfigsId	string
filter	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

projects_uptime_check_configs_get

Gets a single Uptime check configuration.

SELECT
name,
checkerType,
contentMatchers,
disabled,
displayName,
httpCheck,
internalCheckers,
isInternal,
logCheckFailures,
monitoredResource,
period,
resourceGroup,
selectedRegions,
syntheticMonitor,
tcpCheck,
timeout,
userLabels
FROM google.monitoring.uptime_check_configs
WHERE projectsId = '{{ projectsId }}' -- required
AND uptimeCheckConfigsId = '{{ uptimeCheckConfigsId }}' -- required;

projects_uptime_check_configs_list

Lists the existing valid Uptime check configurations for the project (leaving out any invalid configurations).

SELECT
name,
checkerType,
contentMatchers,
disabled,
displayName,
httpCheck,
internalCheckers,
isInternal,
logCheckFailures,
monitoredResource,
period,
resourceGroup,
selectedRegions,
syntheticMonitor,
tcpCheck,
timeout,
userLabels
FROM google.monitoring.uptime_check_configs
WHERE projectsId = '{{ projectsId }}' -- required
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

projects_uptime_check_configs_create

Creates a new Uptime check configuration.

INSERT INTO google.monitoring.uptime_check_configs (
data__name,
data__displayName,
data__monitoredResource,
data__resourceGroup,
data__syntheticMonitor,
data__httpCheck,
data__tcpCheck,
data__period,
data__timeout,
data__contentMatchers,
data__checkerType,
data__disabled,
data__selectedRegions,
data__logCheckFailures,
data__isInternal,
data__internalCheckers,
data__userLabels,
projectsId
)
SELECT 
'{{ name }}',
'{{ displayName }}',
'{{ monitoredResource }}',
'{{ resourceGroup }}',
'{{ syntheticMonitor }}',
'{{ httpCheck }}',
'{{ tcpCheck }}',
'{{ period }}',
'{{ timeout }}',
'{{ contentMatchers }}',
'{{ checkerType }}',
{{ disabled }},
'{{ selectedRegions }}',
{{ logCheckFailures }},
{{ isInternal }},
'{{ internalCheckers }}',
'{{ userLabels }}',
'{{ projectsId }}'
RETURNING
name,
checkerType,
contentMatchers,
disabled,
displayName,
httpCheck,
internalCheckers,
isInternal,
logCheckFailures,
monitoredResource,
period,
resourceGroup,
selectedRegions,
syntheticMonitor,
tcpCheck,
timeout,
userLabels
;

Manifest

# Description fields are for documentation purposes
- name: uptime_check_configs
  props:
    - name: projectsId
      value: string
      description: Required parameter for the uptime_check_configs resource.
    - name: name
      value: string
      description: >
        Identifier. A unique resource name for this Uptime check configuration. The format is: projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID] [PROJECT_ID_OR_NUMBER] is the Workspace host project associated with the Uptime check.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.
        
    - name: displayName
      value: string
      description: >
        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.
        
    - name: monitoredResource
      value: object
      description: >
        An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for "gce_instance" has labels "project_id", "instance_id" and "zone": { "type": "gce_instance", "labels": { "project_id": "my-project", "instance_id": "12345678901234", "zone": "us-central1-a" }} 
        
    - name: resourceGroup
      value: object
      description: >
        The group resource associated with the configuration.
        
    - name: syntheticMonitor
      value: object
      description: >
        Specifies a Synthetic Monitor to invoke.
        
    - name: httpCheck
      value: object
      description: >
        Contains information needed to make an HTTP or HTTPS check.
        
    - name: tcpCheck
      value: object
      description: >
        Contains information needed to make a TCP check.
        
    - name: period
      value: string
      description: >
        How often, in seconds, the Uptime check is performed. Currently, the only supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional, defaults to 60s.
        
    - name: timeout
      value: string
      description: >
        The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required.
        
    - name: contentMatchers
      value: array
      description: >
        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 content_matchers list is supported, and additional entries will be ignored. This field is optional and should only be specified if a content match is required as part of the/ Uptime check.
        
    - name: checkerType
      value: string
      description: >
        The type of checkers to use to execute the Uptime check.
        
      valid_values: ['CHECKER_TYPE_UNSPECIFIED', 'STATIC_IP_CHECKERS', 'VPC_CHECKERS']
    - name: disabled
      value: boolean
      description: >
        Whether the check is disabled or not.
        
    - name: selectedRegions
      value: array
      description: >
        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.
        
    - name: logCheckFailures
      value: boolean
      description: >
        To specify whether to log the results of failed probes to Cloud Logging.
        
    - name: isInternal
      value: boolean
      description: >
        If this is true, then checks are made only from the 'internal_checkers'. If it is false, then checks are made only from the 'selected_regions'. It is an error to provide 'selected_regions' when is_internal is true, or to provide 'internal_checkers' when is_internal is false.
        
    - name: internalCheckers
      value: array
      description: >
        The internal checkers that this check will egress from. If is_internal is true and this list is empty, the check will egress from all the InternalCheckers configured for the project that owns this UptimeCheckConfig.
        
    - name: userLabels
      value: object
      description: >
        User-supplied key/value data to be used for organizing and identifying the UptimeCheckConfig objects.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.
        

UPDATE examples

projects_uptime_check_configs_patch

Updates an Uptime check configuration. You can either replace the entire configuration with a new one or replace only certain fields in the current configuration by specifying the fields to be updated via updateMask. Returns the updated configuration.

UPDATE google.monitoring.uptime_check_configs
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__monitoredResource = '{{ monitoredResource }}',
data__resourceGroup = '{{ resourceGroup }}',
data__syntheticMonitor = '{{ syntheticMonitor }}',
data__httpCheck = '{{ httpCheck }}',
data__tcpCheck = '{{ tcpCheck }}',
data__period = '{{ period }}',
data__timeout = '{{ timeout }}',
data__contentMatchers = '{{ contentMatchers }}',
data__checkerType = '{{ checkerType }}',
data__disabled = {{ disabled }},
data__selectedRegions = '{{ selectedRegions }}',
data__logCheckFailures = {{ logCheckFailures }},
data__isInternal = {{ isInternal }},
data__internalCheckers = '{{ internalCheckers }}',
data__userLabels = '{{ userLabels }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND uptimeCheckConfigsId = '{{ uptimeCheckConfigsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
checkerType,
contentMatchers,
disabled,
displayName,
httpCheck,
internalCheckers,
isInternal,
logCheckFailures,
monitoredResource,
period,
resourceGroup,
selectedRegions,
syntheticMonitor,
tcpCheck,
timeout,
userLabels;

DELETE examples

projects_uptime_check_configs_delete

Deletes an Uptime check configuration. Note that this method will fail if the Uptime check configuration is referenced by an alert policy or other dependent configs that would be rendered invalid by the deletion.

DELETE FROM google.monitoring.uptime_check_configs
WHERE projectsId = '{{ projectsId }}' --required
AND uptimeCheckConfigsId = '{{ uptimeCheckConfigsId }}' --required;