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

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.
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	Information involved in an HTTP/HTTPS Uptime check request.
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.
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" }}
period	string	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 resource submessage for group checks. It can be used instead of a monitored resource, when multiple resources are being monitored.
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	Describes a Synthetic Monitor to be invoked by Uptime.
tcpCheck	object	Information required for a TCP Uptime check request.
timeout	string	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

Name	Accessible by	Required Params	Description
projects_uptime_check_configs_get	SELECT	projectsId, uptimeCheckConfigsId	Gets a single Uptime check configuration.
projects_uptime_check_configs_list	SELECT	projectsId	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_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.
projects_uptime_check_configs_patch	UPDATE	projectsId, uptimeCheckConfigsId	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.

SELECT examples

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

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

INSERT example

Use the following StackQL query and manifest file to create a new uptime_check_configs resource.

All Properties

/*+ create */
INSERT INTO google.monitoring.uptime_check_configs (
projectsId,
name,
displayName,
monitoredResource,
resourceGroup,
syntheticMonitor,
httpCheck,
tcpCheck,
period,
timeout,
contentMatchers,
checkerType,
selectedRegions,
isInternal,
internalCheckers,
userLabels
)
SELECT 
'{{ projectsId }}',
'{{ name }}',
'{{ displayName }}',
'{{ monitoredResource }}',
'{{ resourceGroup }}',
'{{ syntheticMonitor }}',
'{{ httpCheck }}',
'{{ tcpCheck }}',
'{{ period }}',
'{{ timeout }}',
'{{ contentMatchers }}',
'{{ checkerType }}',
'{{ selectedRegions }}',
{{ isInternal }},
'{{ internalCheckers }}',
'{{ userLabels }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: displayName
      value: string
    - name: monitoredResource
      value:
        - name: type
          value: string
        - name: labels
          value: object
    - name: resourceGroup
      value:
        - name: groupId
          value: string
        - name: resourceType
          value: string
    - name: syntheticMonitor
      value:
        - name: cloudFunctionV2
          value:
            - name: name
              value: string
    - name: httpCheck
      value:
        - name: requestMethod
          value: string
        - name: useSsl
          value: boolean
        - name: path
          value: string
        - name: port
          value: integer
        - name: authInfo
          value:
            - name: username
              value: string
            - name: password
              value: string
        - name: maskHeaders
          value: boolean
        - name: headers
          value: object
        - name: contentType
          value: string
        - name: customContentType
          value: string
        - name: validateSsl
          value: boolean
        - name: body
          value: string
        - name: acceptedResponseStatusCodes
          value:
            - - name: statusValue
                value: integer
              - name: statusClass
                value: string
        - name: pingConfig
          value:
            - name: pingsCount
              value: integer
        - name: serviceAgentAuthentication
          value:
            - name: type
              value: string
    - name: tcpCheck
      value:
        - name: port
          value: integer
    - name: period
      value: string
    - name: timeout
      value: string
    - name: contentMatchers
      value:
        - - name: content
            value: string
          - name: matcher
            value: string
          - name: jsonPathMatcher
            value:
              - name: jsonPath
                value: string
              - name: jsonMatcher
                value: string
    - name: checkerType
      value: string
    - name: selectedRegions
      value:
        - string
    - name: isInternal
      value: boolean
    - name: internalCheckers
      value:
        - - name: name
            value: string
          - name: displayName
            value: string
          - name: network
            value: string
          - name: gcpZone
            value: string
          - name: peerProjectId
            value: string
          - name: state
            value: string
    - name: userLabels
      value: object

UPDATE example

Updates a uptime_check_configs resource.

/*+ update */
UPDATE google.monitoring.uptime_check_configs
SET 
name = '{{ name }}',
displayName = '{{ displayName }}',
monitoredResource = '{{ monitoredResource }}',
resourceGroup = '{{ resourceGroup }}',
syntheticMonitor = '{{ syntheticMonitor }}',
httpCheck = '{{ httpCheck }}',
tcpCheck = '{{ tcpCheck }}',
period = '{{ period }}',
timeout = '{{ timeout }}',
contentMatchers = '{{ contentMatchers }}',
checkerType = '{{ checkerType }}',
selectedRegions = '{{ selectedRegions }}',
isInternal = true|false,
internalCheckers = '{{ internalCheckers }}',
userLabels = '{{ userLabels }}'
WHERE 
projectsId = '{{ projectsId }}'
AND uptimeCheckConfigsId = '{{ uptimeCheckConfigsId }}';

DELETE example

Deletes the specified uptime_check_configs resource.

/*+ delete */
DELETE FROM google.monitoring.uptime_check_configs
WHERE projectsId = '{{ projectsId }}'
AND uptimeCheckConfigsId = '{{ uptimeCheckConfigsId }}';