Skip to content

autoscaling.oracle.com/v1beta1

Back to API Reference

APIVersion: autoscaling.oracle.com/v1beta1

This content is generated from the checked-in CRD schemas in config/crd/bases/. If a description is missing or incorrect, fix the source comments or generator inputs and rerun make generate manifests; do not hand-edit config/crd/bases/*.yaml.

Packages

No customer-visible package currently exposes autoscaling.oracle.com/v1beta1.

Resources

Kind Scope Sample Packages
AutoScalingConfiguration Namespaced Sample -
AutoScalingPolicy Namespaced Sample -

AutoScalingConfiguration

AutoScalingConfiguration is the Schema for the autoscalingconfigurations API.

  • Plural: autoscalingconfigurations
  • Scope: Namespaced
  • APIVersion: autoscaling.oracle.com/v1beta1
  • Sample: Sample (config/samples/autoscaling_v1beta1_autoscalingconfiguration.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

AutoScalingConfigurationSpec defines the desired state of AutoScalingConfiguration.

Field Description Type Required Default Enum
compartmentId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the autoscaling configuration. string Yes - -
coolDownInSeconds For threshold-based autoscaling policies, this value is the minimum period of time to wait between scaling actions. The cooldown period gives the system time to stabilize before rescaling. The minimum value is 300 seconds, which is also the default. The cooldown period starts when the instance pool reaches the running state. For schedule-based autoscaling policies, this value is not used. integer No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} map[string, map[string, string]] No - -
displayName A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. string No - -
freeformTags Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} map[string, string] No - -
isEnabled Whether the autoscaling configuration is enabled. boolean No - -
policies - list[object] Yes - -
resource AutoScalingConfigurationResource defines nested fields for AutoScalingConfiguration.Resource. object Yes - -

Spec.policies[]

Back to AutoScalingConfiguration spec

AutoScalingConfigurationPolicy defines nested fields for AutoScalingConfiguration.Policy.

Field Description Type Required Default Enum
capacity The capacity requirements of the autoscaling policy. object No - -
displayName A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. string No - -
executionSchedule AutoScalingConfigurationPolicyExecutionSchedule defines nested fields for AutoScalingConfiguration.Policy.ExecutionSchedule. object No - -
isEnabled Whether the autoscaling policy is enabled. boolean No - -
jsonData - string No - -
policyType - string No - -
resourceAction AutoScalingConfigurationPolicyResourceAction defines nested fields for AutoScalingConfiguration.Policy.ResourceAction. object No - -
rules - list[object] No - -

Spec.policies[].capacity

Back to AutoScalingConfiguration spec

The capacity requirements of the autoscaling policy.

Field Description Type Required Default Enum
initial For a threshold-based autoscaling policy, this value is the initial number of instances to launch in the instance pool immediately after autoscaling is enabled. After autoscaling retrieves performance metrics, the number of instances is automatically adjusted from this initial number to a number that is based on the limits that you set. For a schedule-based autoscaling policy, this value is the target pool size to scale to when executing the schedule that's defined in the autoscaling policy. integer No - -
max For a threshold-based autoscaling policy, this value is the maximum number of instances the instance pool is allowed to increase to (scale out). For a schedule-based autoscaling policy, this value is not used. integer No - -
min For a threshold-based autoscaling policy, this value is the minimum number of instances the instance pool is allowed to decrease to (scale in). For a schedule-based autoscaling policy, this value is not used. integer No - -

Spec.policies[].executionSchedule

Back to AutoScalingConfiguration spec

AutoScalingConfigurationPolicyExecutionSchedule defines nested fields for AutoScalingConfiguration.Policy.ExecutionSchedule.

Field Description Type Required Default Enum
expression A cron expression that represents the time at which to execute the autoscaling policy. Cron expressions have this format: <second> <minute> <hour> <day of month> <month> <day of week> <year> You can use special characters that are supported with the Quartz cron implementation. You must specify 0 as the value for seconds. Example: 0 15 10 ? * * string No - -
jsonData - string No - -
timezone The time zone for the execution schedule. string Yes - -
type - string No - -

Spec.policies[].resourceAction

Back to AutoScalingConfiguration spec

AutoScalingConfigurationPolicyResourceAction defines nested fields for AutoScalingConfiguration.Policy.ResourceAction.

Field Description Type Required Default Enum
action - string No - -
actionType - string No - -
jsonData - string No - -

Spec.policies[].rules[]

Back to AutoScalingConfiguration spec

AutoScalingConfigurationPolicyRule defines nested fields for AutoScalingConfiguration.Policy.Rule.

Field Description Type Required Default Enum
action AutoScalingConfigurationPolicyRuleAction defines nested fields for AutoScalingConfiguration.Policy.Rule.Action. object Yes - -
displayName A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. string No - -
metric AutoScalingConfigurationPolicyRuleMetric defines nested fields for AutoScalingConfiguration.Policy.Rule.Metric. object Yes - -

Spec.policies[].rules[].action

Back to AutoScalingConfiguration spec

AutoScalingConfigurationPolicyRuleAction defines nested fields for AutoScalingConfiguration.Policy.Rule.Action.

Field Description Type Required Default Enum
type The type of action to take. string Yes - -
value To scale out (increase the number of instances), provide a positive value. To scale in (decrease the number of instances), provide a negative value. integer Yes - -

Spec.policies[].rules[].metric

Back to AutoScalingConfiguration spec

AutoScalingConfigurationPolicyRuleMetric defines nested fields for AutoScalingConfiguration.Policy.Rule.Metric.

Field Description Type Required Default Enum
jsonData - string No - -
metricCompartmentId The OCID of the compartment containing the metrics. string No - -
metricSource - string No - -
metricType - string No - -
namespace The namespace for the query. string No - -
pendingDuration The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING" or vice versa. For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to "FIRING"; likewise, the alarm must persist in not breaching the condition for five minutes before the alarm updates its state to "OK." The duration is specified as a string in ISO 8601 format (PT10M for ten minutes or PT1H for one hour). Minimum: PT3M. Maximum: PT1H. Default: PT3M. string No - -
query The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval: 1m-60m (also 1h). You can optionally specify dimensions and grouping functions. Supported grouping functions: grouping(), groupBy(). Example of threshold alarm: ----- CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.groupBy(availabilityDomain).percentile(0.9) > 85 ----- string No - -
resourceGroup The resource group for the query. string No - -
threshold AutoScalingConfigurationPolicyRuleMetricThreshold defines nested fields for AutoScalingConfiguration.Policy.Rule.Metric.Threshold. object No - -

Spec.policies[].rules[].metric.threshold

Back to AutoScalingConfiguration spec

AutoScalingConfigurationPolicyRuleMetricThreshold defines nested fields for AutoScalingConfiguration.Policy.Rule.Metric.Threshold.

Field Description Type Required Default Enum
operator The comparison operator to use. Options are greater than (GT), greater than or equal to (GTE), less than (LT), and less than or equal to (LTE). string Yes - -
value - integer Yes - -

Spec.resource

Back to AutoScalingConfiguration spec

AutoScalingConfigurationResource defines nested fields for AutoScalingConfiguration.Resource.

Field Description Type Required Default Enum
id The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource that is managed by the autoscaling configuration. string Yes - -
jsonData - string No - -
type - string No - -

Status

AutoScalingConfigurationStatus defines the observed state of AutoScalingConfiguration.

Field Description Type Required Default Enum
compartmentId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the autoscaling configuration. string No - -
coolDownInSeconds For threshold-based autoscaling policies, this value is the minimum period of time to wait between scaling actions. The cooldown period gives the system time to stabilize before rescaling. The minimum value is 300 seconds, which is also the default. The cooldown period starts when the instance pool reaches the running state. For schedule-based autoscaling policies, this value is not used. integer No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} map[string, map[string, string]] No - -
displayName A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. string No - -
freeformTags Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} map[string, string] No - -
id The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the autoscaling configuration. string No - -
isEnabled Whether the autoscaling configuration is enabled. boolean No - -
maxResourceCount The maximum number of resources to scale out to. integer No - -
minResourceCount The minimum number of resources to scale in to. integer No - -
policies Autoscaling policy definitions for the autoscaling configuration. An autoscaling policy defines the criteria that trigger autoscaling actions and the actions to take. list[object] No - -
resource AutoScalingConfigurationResource defines nested fields for AutoScalingConfiguration.Resource. object No - -
status - object Yes - -
timeCreated The date and time the autoscaling configuration was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z string No - -

Status.policies[]

Back to AutoScalingConfiguration status

AutoScalingConfigurationPolicy defines nested fields for AutoScalingConfiguration.Policy.

Field Description Type Required Default Enum
capacity The capacity requirements of the autoscaling policy. object No - -
displayName A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. string No - -
executionSchedule AutoScalingConfigurationPolicyExecutionSchedule defines nested fields for AutoScalingConfiguration.Policy.ExecutionSchedule. object No - -
isEnabled Whether the autoscaling policy is enabled. boolean No - -
jsonData - string No - -
policyType - string No - -
resourceAction AutoScalingConfigurationPolicyResourceAction defines nested fields for AutoScalingConfiguration.Policy.ResourceAction. object No - -
rules - list[object] No - -

Status.policies[].capacity

Back to AutoScalingConfiguration status

The capacity requirements of the autoscaling policy.

Field Description Type Required Default Enum
initial For a threshold-based autoscaling policy, this value is the initial number of instances to launch in the instance pool immediately after autoscaling is enabled. After autoscaling retrieves performance metrics, the number of instances is automatically adjusted from this initial number to a number that is based on the limits that you set. For a schedule-based autoscaling policy, this value is the target pool size to scale to when executing the schedule that's defined in the autoscaling policy. integer No - -
max For a threshold-based autoscaling policy, this value is the maximum number of instances the instance pool is allowed to increase to (scale out). For a schedule-based autoscaling policy, this value is not used. integer No - -
min For a threshold-based autoscaling policy, this value is the minimum number of instances the instance pool is allowed to decrease to (scale in). For a schedule-based autoscaling policy, this value is not used. integer No - -

Status.policies[].executionSchedule

Back to AutoScalingConfiguration status

AutoScalingConfigurationPolicyExecutionSchedule defines nested fields for AutoScalingConfiguration.Policy.ExecutionSchedule.

Field Description Type Required Default Enum
expression A cron expression that represents the time at which to execute the autoscaling policy. Cron expressions have this format: <second> <minute> <hour> <day of month> <month> <day of week> <year> You can use special characters that are supported with the Quartz cron implementation. You must specify 0 as the value for seconds. Example: 0 15 10 ? * * string No - -
jsonData - string No - -
timezone The time zone for the execution schedule. string Yes - -
type - string No - -

Status.policies[].resourceAction

Back to AutoScalingConfiguration status

AutoScalingConfigurationPolicyResourceAction defines nested fields for AutoScalingConfiguration.Policy.ResourceAction.

Field Description Type Required Default Enum
action - string No - -
actionType - string No - -
jsonData - string No - -

Status.policies[].rules[]

Back to AutoScalingConfiguration status

AutoScalingConfigurationPolicyRule defines nested fields for AutoScalingConfiguration.Policy.Rule.

Field Description Type Required Default Enum
action AutoScalingConfigurationPolicyRuleAction defines nested fields for AutoScalingConfiguration.Policy.Rule.Action. object Yes - -
displayName A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. string No - -
metric AutoScalingConfigurationPolicyRuleMetric defines nested fields for AutoScalingConfiguration.Policy.Rule.Metric. object Yes - -

Status.policies[].rules[].action

Back to AutoScalingConfiguration status

AutoScalingConfigurationPolicyRuleAction defines nested fields for AutoScalingConfiguration.Policy.Rule.Action.

Field Description Type Required Default Enum
type The type of action to take. string Yes - -
value To scale out (increase the number of instances), provide a positive value. To scale in (decrease the number of instances), provide a negative value. integer Yes - -

Status.policies[].rules[].metric

Back to AutoScalingConfiguration status

AutoScalingConfigurationPolicyRuleMetric defines nested fields for AutoScalingConfiguration.Policy.Rule.Metric.

Field Description Type Required Default Enum
jsonData - string No - -
metricCompartmentId The OCID of the compartment containing the metrics. string No - -
metricSource - string No - -
metricType - string No - -
namespace The namespace for the query. string No - -
pendingDuration The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING" or vice versa. For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to "FIRING"; likewise, the alarm must persist in not breaching the condition for five minutes before the alarm updates its state to "OK." The duration is specified as a string in ISO 8601 format (PT10M for ten minutes or PT1H for one hour). Minimum: PT3M. Maximum: PT1H. Default: PT3M. string No - -
query The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval: 1m-60m (also 1h). You can optionally specify dimensions and grouping functions. Supported grouping functions: grouping(), groupBy(). Example of threshold alarm: ----- CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.groupBy(availabilityDomain).percentile(0.9) > 85 ----- string No - -
resourceGroup The resource group for the query. string No - -
threshold AutoScalingConfigurationPolicyRuleMetricThreshold defines nested fields for AutoScalingConfiguration.Policy.Rule.Metric.Threshold. object No - -

Status.policies[].rules[].metric.threshold

Back to AutoScalingConfiguration status

AutoScalingConfigurationPolicyRuleMetricThreshold defines nested fields for AutoScalingConfiguration.Policy.Rule.Metric.Threshold.

Field Description Type Required Default Enum
operator The comparison operator to use. Options are greater than (GT), greater than or equal to (GTE), less than (LT), and less than or equal to (LTE). string Yes - -
value - integer Yes - -

Status.resource

Back to AutoScalingConfiguration status

AutoScalingConfigurationResource defines nested fields for AutoScalingConfiguration.Resource.

Field Description Type Required Default Enum
id The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource that is managed by the autoscaling configuration. string Yes - -
jsonData - string No - -
type - string No - -

Status.status

Back to AutoScalingConfiguration status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to AutoScalingConfiguration status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to AutoScalingConfiguration status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to AutoScalingConfiguration status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

AutoScalingPolicy

AutoScalingPolicy is the Schema for the autoscalingpolicies API.

  • Plural: autoscalingpolicies
  • Scope: Namespaced
  • APIVersion: autoscaling.oracle.com/v1beta1
  • Sample: Sample (config/samples/autoscaling_v1beta1_autoscalingpolicy.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

AutoScalingPolicySpec defines the desired state of AutoScalingPolicy.

Field Description Type Required Default Enum
capacity The capacity requirements of the autoscaling policy. object No - -
displayName A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. string No - -
executionSchedule AutoScalingPolicyExecutionSchedule defines nested fields for AutoScalingPolicy.ExecutionSchedule. object No - -
isEnabled Whether the autoscaling policy is enabled. boolean No - -
jsonData - string No - -
policyType - string No - -
resourceAction AutoScalingPolicyResourceAction defines nested fields for AutoScalingPolicy.ResourceAction. object No - -
rules - list[object] No - -

Spec.capacity

Back to AutoScalingPolicy spec

The capacity requirements of the autoscaling policy.

Field Description Type Required Default Enum
initial For a threshold-based autoscaling policy, this value is the initial number of instances to launch in the instance pool immediately after autoscaling is enabled. After autoscaling retrieves performance metrics, the number of instances is automatically adjusted from this initial number to a number that is based on the limits that you set. For a schedule-based autoscaling policy, this value is the target pool size to scale to when executing the schedule that's defined in the autoscaling policy. integer No - -
max For a threshold-based autoscaling policy, this value is the maximum number of instances the instance pool is allowed to increase to (scale out). For a schedule-based autoscaling policy, this value is not used. integer No - -
min For a threshold-based autoscaling policy, this value is the minimum number of instances the instance pool is allowed to decrease to (scale in). For a schedule-based autoscaling policy, this value is not used. integer No - -

Spec.executionSchedule

Back to AutoScalingPolicy spec

AutoScalingPolicyExecutionSchedule defines nested fields for AutoScalingPolicy.ExecutionSchedule.

Field Description Type Required Default Enum
expression A cron expression that represents the time at which to execute the autoscaling policy. Cron expressions have this format: <second> <minute> <hour> <day of month> <month> <day of week> <year> You can use special characters that are supported with the Quartz cron implementation. You must specify 0 as the value for seconds. Example: 0 15 10 ? * * string No - -
jsonData - string No - -
timezone The time zone for the execution schedule. string Yes - -
type - string No - -

Spec.resourceAction

Back to AutoScalingPolicy spec

AutoScalingPolicyResourceAction defines nested fields for AutoScalingPolicy.ResourceAction.

Field Description Type Required Default Enum
action - string No - -
actionType - string No - -
jsonData - string No - -

Spec.rules[]

Back to AutoScalingPolicy spec

AutoScalingPolicyRule defines nested fields for AutoScalingPolicy.Rule.

Field Description Type Required Default Enum
action AutoScalingPolicyRuleAction defines nested fields for AutoScalingPolicy.Rule.Action. object Yes - -
displayName A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. string No - -
metric AutoScalingPolicyRuleMetric defines nested fields for AutoScalingPolicy.Rule.Metric. object Yes - -

Spec.rules[].action

Back to AutoScalingPolicy spec

AutoScalingPolicyRuleAction defines nested fields for AutoScalingPolicy.Rule.Action.

Field Description Type Required Default Enum
type The type of action to take. string Yes - -
value To scale out (increase the number of instances), provide a positive value. To scale in (decrease the number of instances), provide a negative value. integer Yes - -

Spec.rules[].metric

Back to AutoScalingPolicy spec

AutoScalingPolicyRuleMetric defines nested fields for AutoScalingPolicy.Rule.Metric.

Field Description Type Required Default Enum
jsonData - string No - -
metricCompartmentId The OCID of the compartment containing the metrics. string No - -
metricSource - string No - -
metricType - string No - -
namespace The namespace for the query. string No - -
pendingDuration The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING" or vice versa. For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to "FIRING"; likewise, the alarm must persist in not breaching the condition for five minutes before the alarm updates its state to "OK." The duration is specified as a string in ISO 8601 format (PT10M for ten minutes or PT1H for one hour). Minimum: PT3M. Maximum: PT1H. Default: PT3M. string No - -
query The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval: 1m-60m (also 1h). You can optionally specify dimensions and grouping functions. Supported grouping functions: grouping(), groupBy(). Example of threshold alarm: ----- CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.groupBy(availabilityDomain).percentile(0.9) > 85 ----- string No - -
resourceGroup The resource group for the query. string No - -
threshold AutoScalingPolicyRuleMetricThreshold defines nested fields for AutoScalingPolicy.Rule.Metric.Threshold. object No - -

Spec.rules[].metric.threshold

Back to AutoScalingPolicy spec

AutoScalingPolicyRuleMetricThreshold defines nested fields for AutoScalingPolicy.Rule.Metric.Threshold.

Field Description Type Required Default Enum
operator The comparison operator to use. Options are greater than (GT), greater than or equal to (GTE), less than (LT), and less than or equal to (LTE). string Yes - -
value - integer Yes - -

Status

AutoScalingPolicyStatus defines the observed state of AutoScalingPolicy.

Field Description Type Required Default Enum
capacity The capacity requirements of the autoscaling policy. object No - -
displayName A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. string No - -
executionSchedule The schedule for executing the autoscaling policy. object No - -
id The ID of the autoscaling policy that is assigned after creation. string No - -
isEnabled Whether the autoscaling policy is enabled. boolean No - -
jsonData - string No - -
policyType - string No - -
resourceAction AutoScalingPolicyResourceAction defines nested fields for AutoScalingPolicy.ResourceAction. object No - -
rules - list[object] No - -
status - object Yes - -
timeCreated The date and time the autoscaling configuration was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z string No - -

Status.capacity

Back to AutoScalingPolicy status

The capacity requirements of the autoscaling policy.

Field Description Type Required Default Enum
initial For a threshold-based autoscaling policy, this value is the initial number of instances to launch in the instance pool immediately after autoscaling is enabled. After autoscaling retrieves performance metrics, the number of instances is automatically adjusted from this initial number to a number that is based on the limits that you set. For a schedule-based autoscaling policy, this value is the target pool size to scale to when executing the schedule that's defined in the autoscaling policy. integer No - -
max For a threshold-based autoscaling policy, this value is the maximum number of instances the instance pool is allowed to increase to (scale out). For a schedule-based autoscaling policy, this value is not used. integer No - -
min For a threshold-based autoscaling policy, this value is the minimum number of instances the instance pool is allowed to decrease to (scale in). For a schedule-based autoscaling policy, this value is not used. integer No - -

Status.executionSchedule

Back to AutoScalingPolicy status

The schedule for executing the autoscaling policy.

Field Description Type Required Default Enum
expression A cron expression that represents the time at which to execute the autoscaling policy. Cron expressions have this format: <second> <minute> <hour> <day of month> <month> <day of week> <year> You can use special characters that are supported with the Quartz cron implementation. You must specify 0 as the value for seconds. Example: 0 15 10 ? * * string No - -
jsonData - string No - -
timezone The time zone for the execution schedule. string Yes - -
type - string No - -

Status.resourceAction

Back to AutoScalingPolicy status

AutoScalingPolicyResourceAction defines nested fields for AutoScalingPolicy.ResourceAction.

Field Description Type Required Default Enum
action - string No - -
actionType - string No - -
jsonData - string No - -

Status.rules[]

Back to AutoScalingPolicy status

AutoScalingPolicyRule defines nested fields for AutoScalingPolicy.Rule.

Field Description Type Required Default Enum
action AutoScalingPolicyRuleAction defines nested fields for AutoScalingPolicy.Rule.Action. object Yes - -
displayName A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. string No - -
metric AutoScalingPolicyRuleMetric defines nested fields for AutoScalingPolicy.Rule.Metric. object Yes - -

Status.rules[].action

Back to AutoScalingPolicy status

AutoScalingPolicyRuleAction defines nested fields for AutoScalingPolicy.Rule.Action.

Field Description Type Required Default Enum
type The type of action to take. string Yes - -
value To scale out (increase the number of instances), provide a positive value. To scale in (decrease the number of instances), provide a negative value. integer Yes - -

Status.rules[].metric

Back to AutoScalingPolicy status

AutoScalingPolicyRuleMetric defines nested fields for AutoScalingPolicy.Rule.Metric.

Field Description Type Required Default Enum
jsonData - string No - -
metricCompartmentId The OCID of the compartment containing the metrics. string No - -
metricSource - string No - -
metricType - string No - -
namespace The namespace for the query. string No - -
pendingDuration The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING" or vice versa. For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to "FIRING"; likewise, the alarm must persist in not breaching the condition for five minutes before the alarm updates its state to "OK." The duration is specified as a string in ISO 8601 format (PT10M for ten minutes or PT1H for one hour). Minimum: PT3M. Maximum: PT1H. Default: PT3M. string No - -
query The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval: 1m-60m (also 1h). You can optionally specify dimensions and grouping functions. Supported grouping functions: grouping(), groupBy(). Example of threshold alarm: ----- CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.groupBy(availabilityDomain).percentile(0.9) > 85 ----- string No - -
resourceGroup The resource group for the query. string No - -
threshold AutoScalingPolicyRuleMetricThreshold defines nested fields for AutoScalingPolicy.Rule.Metric.Threshold. object No - -

Status.rules[].metric.threshold

Back to AutoScalingPolicy status

AutoScalingPolicyRuleMetricThreshold defines nested fields for AutoScalingPolicy.Rule.Metric.Threshold.

Field Description Type Required Default Enum
operator The comparison operator to use. Options are greater than (GT), greater than or equal to (GTE), less than (LT), and less than or equal to (LTE). string Yes - -
value - integer Yes - -

Status.status

Back to AutoScalingPolicy status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to AutoScalingPolicy status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to AutoScalingPolicy status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to AutoScalingPolicy status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -