autoscalers

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

Overview

Name	autoscalers
Type	Resource
Id	google.compute.autoscalers

Fields

Name	Datatype	Description
id	string	[Output Only] The unique identifier for the resource. This identifier is defined by the server.
name	string	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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
description	string	An optional description of this resource. Provide this property when you create the resource.
autoscalingPolicy	object	Cloud Autoscaler policy.
creationTimestamp	string	[Output Only] Creation timestamp in RFC3339 text format.
kind	string	[Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
recommendedSize	integer	[Output Only] Target recommended MIG size (number of instances) computed by autoscaler. Autoscaler calculates the recommended MIG size even when the autoscaling policy mode is different from ON. This field is empty when autoscaler is not connected to an existing managed instance group or autoscaler did not generate its prediction.
region	string	[Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
scalingScheduleStatus	object	[Output Only] Status information of existing scaling schedules.
selfLink	string	[Output Only] Server-defined URL for the resource.
status	string	[Output Only] The status of the autoscaler configuration. Current set of possible values: - PENDING: Autoscaler backend hasn't read new/updated configuration. - DELETING: Configuration is being deleted. - ACTIVE: Configuration is acknowledged to be effective. Some warnings might be present in the statusDetails field. - ERROR: Configuration has errors. Actionable for users. Details are present in the statusDetails field. New values might be added in the future.
statusDetails	array	[Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
target	string	URL of the managed instance group that this autoscaler will scale. This field is required when creating an autoscaler.
zone	string	[Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).

Methods

Name	Accessible by	Required Params	Description
aggregated_list	SELECT	project	Retrieves an aggregated list of autoscalers. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.
get	SELECT	autoscaler, project, zone	Returns the specified autoscaler resource.
list	SELECT	project, zone	Retrieves a list of autoscalers contained within the specified zone.
insert	INSERT	project, zone	Creates an autoscaler in the specified project using the data included in the request.
delete	DELETE	autoscaler, project, zone	Deletes the specified autoscaler.
patch	UPDATE	project, zone	Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
update	REPLACE	project, zone	Updates an autoscaler in the specified project using the data included in the request.

SELECT examples

Retrieves an aggregated list of autoscalers. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

SELECT
id,
name,
description,
autoscalingPolicy,
creationTimestamp,
kind,
recommendedSize,
region,
scalingScheduleStatus,
selfLink,
status,
statusDetails,
target,
zone
FROM google.compute.autoscalers
WHERE project = '{{ project }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO google.compute.autoscalers (
project,
zone,
name,
description,
target,
autoscalingPolicy,
zone,
region,
status,
statusDetails,
recommendedSize,
scalingScheduleStatus
)
SELECT 
'{{ project }}',
'{{ zone }}',
'{{ name }}',
'{{ description }}',
'{{ target }}',
'{{ autoscalingPolicy }}',
'{{ zone }}',
'{{ region }}',
'{{ status }}',
'{{ statusDetails }}',
'{{ recommendedSize }}',
'{{ scalingScheduleStatus }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: kind
      value: string
    - name: id
      value: string
    - name: creationTimestamp
      value: string
    - name: name
      value: string
    - name: description
      value: string
    - name: target
      value: string
    - name: autoscalingPolicy
      value:
        - name: minNumReplicas
          value: integer
        - name: maxNumReplicas
          value: integer
        - name: scaleInControl
          value:
            - name: maxScaledInReplicas
              value:
                - name: fixed
                  value: integer
                - name: percent
                  value: integer
                - name: calculated
                  value: integer
            - name: timeWindowSec
              value: integer
        - name: coolDownPeriodSec
          value: integer
        - name: cpuUtilization
          value:
            - name: utilizationTarget
              value: number
            - name: predictiveMethod
              value: string
        - name: customMetricUtilizations
          value:
            - - name: metric
                value: string
              - name: filter
                value: string
              - name: utilizationTarget
                value: number
              - name: singleInstanceAssignment
                value: number
              - name: utilizationTargetType
                value: string
        - name: loadBalancingUtilization
          value:
            - name: utilizationTarget
              value: number
        - name: mode
          value: string
        - name: scalingSchedules
          value: object
    - name: zone
      value: string
    - name: region
      value: string
    - name: selfLink
      value: string
    - name: status
      value: string
    - name: statusDetails
      value:
        - - name: message
            value: string
          - name: type
            value: string
    - name: recommendedSize
      value: integer
    - name: scalingScheduleStatus
      value: object

UPDATE example

Updates a autoscalers resource.

/*+ update */
UPDATE google.compute.autoscalers
SET 
name = '{{ name }}',
description = '{{ description }}',
target = '{{ target }}',
autoscalingPolicy = '{{ autoscalingPolicy }}',
zone = '{{ zone }}',
region = '{{ region }}',
status = '{{ status }}',
statusDetails = '{{ statusDetails }}',
recommendedSize = '{{ recommendedSize }}',
scalingScheduleStatus = '{{ scalingScheduleStatus }}'
WHERE 
project = '{{ project }}'
AND zone = '{{ zone }}';

REPLACE example

Replaces all fields in the specified autoscalers resource.

/*+ update */
REPLACE google.compute.autoscalers
SET 
name = '{{ name }}',
description = '{{ description }}',
target = '{{ target }}',
autoscalingPolicy = '{{ autoscalingPolicy }}',
zone = '{{ zone }}',
region = '{{ region }}',
status = '{{ status }}',
statusDetails = '{{ statusDetails }}',
recommendedSize = '{{ recommendedSize }}',
scalingScheduleStatus = '{{ scalingScheduleStatus }}'
WHERE 
project = '{{ project }}'
AND zone = '{{ zone }}';

DELETE example

Deletes the specified autoscalers resource.

/*+ delete */
DELETE FROM google.compute.autoscalers
WHERE autoscaler = '{{ autoscaler }}'
AND project = '{{ project }}'
AND zone = '{{ zone }}';