Jump to

• Request
• Response

CreateAutoScalingConfiguration

post

/20181001/autoScalingConfigurations

Creates an autoscaling configuration.

Request

Supported Media Types

• application/json

Header Parameters

• opc-request-id: string
  Pattern: [A-Za-z0-9\-_\.]+

  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
• opc-retry-token: string
  Minimum Length: 1

  Maximum Length: 64

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Body ()

Creation details for an autoscaling configuration.

Root Schema : CreateAutoScalingConfigurationDetails

Type: object

Creation details for an autoscaling configuration.

Show Source

• compartmentId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the compartment containing the autoscaling configuration.
• coolDownInSeconds: integer
  Minimum Value: 0

  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.
• definedTags: object definedTags
  Additional Properties Allowed: additionalProperties

  Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}
• displayName: string
  Minimum Length: 1

  Maximum Length: 255

  A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.
• freeformTags: object freeformTags
  Additional Properties Allowed: additionalProperties

  Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
• isEnabled: boolean
  Whether the autoscaling configuration is enabled.
• policies(required): array policies
• resource(required): object Resource
  Discriminator: type

  A resource that is managed by an autoscaling configuration. The only supported type is instancePool. Each instance pool can have one autoscaling configuration.

{
    "description":"Creation details for an autoscaling configuration.",
    "type":"object",
    "properties":{
        "compartmentId":{
            "description":"The OCID of the compartment containing the autoscaling configuration.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "definedTags":{
            "additionalProperties":{
                "additionalProperties":{
                    "description":"The value of the tag. Only the String type is supported.",
                    "type":"object"
                },
                "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {\"CostCenter\": \"42\"} ",
                "type":"object"
            },
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"Operations\": {\"CostCenter\": \"42\"}} ",
            "type":"object"
        },
        "displayName":{
            "description":"A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "freeformTags":{
            "additionalProperties":{
                "type":"string"
            },
            "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
            "type":"object"
        },
        "coolDownInSeconds":{
            "description":"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.",
            "type":"integer",
            "minimum":"0"
        },
        "isEnabled":{
            "description":"Whether the autoscaling configuration is enabled.",
            "type":"boolean"
        },
        "policies":{
            "items":{
                "$ref":"#/definitions/CreateAutoScalingPolicyDetails"
            },
            "type":"array"
        },
        "resource":{
            "$ref":"#/definitions/Resource"
        }
    },
    "required":[
        "compartmentId",
        "policies",
        "resource"
    ]
}

Nested Schema : definedTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {"CostCenter": "42"}

{
    "additionalProperties":{
        "additionalProperties":{
            "description":"The value of the tag. Only the String type is supported.",
            "type":"object"
        },
        "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {\"CostCenter\": \"42\"} ",
        "type":"object"
    },
    "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"Operations\": {\"CostCenter\": \"42\"}} ",
    "type":"object"
}

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}

Nested Schema : freeformTags

Type: object

Additional Properties Allowed

Show Source

• string

{
    "additionalProperties":{
        "type":"string"
    },
    "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
    "type":"object"
}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}

Nested Schema : policies

Type: array

Show Source

• Array of: object CreateAutoScalingPolicyDetails
  Discriminator: policyType

  Creation details for an autoscaling policy. For more information, see "Using Schedule-Based Autoscaling" (https://docs.oracle.com/en/engineered-systems/private-cloud-appliance/3.0-latest/user/user-usr-instance-pools.html#usr-autoscale-scheduled).

{
    "items":{
        "$ref":"#/definitions/CreateAutoScalingPolicyDetails"
    },
    "type":"array"
}

Nested Schema : Resource

Type: object

Discriminator: type

A resource that is managed by an autoscaling configuration. The only supported type is instancePool. Each instance pool can have one autoscaling configuration.

Show Source

• id(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the resource that is managed by the autoscaling configuration.
• type(required): string
  Minimum Length: 1

  Maximum Length: 100

  The type of resource.

{
    "description":"A resource that is managed by an autoscaling configuration. The only supported type is instancePool. Each instance pool can have one autoscaling configuration.",
    "discriminator":"type",
    "properties":{
        "type":{
            "type":"string",
            "maxLength":"100",
            "minLength":"1",
            "description":"The type of resource."
        },
        "id":{
            "description":"The OCID of the resource that is managed by the autoscaling configuration.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        }
    },
    "required":[
        "type",
        "id"
    ],
    "type":"object"
}

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  The value of the tag. Only the String type is supported.

{
    "additionalProperties":{
        "description":"The value of the tag. Only the String type is supported.",
        "type":"object"
    },
    "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {\"CostCenter\": \"42\"} ",
    "type":"object"
}

Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {"CostCenter": "42"}

Nested Schema : additionalProperties

Type: object

The value of the tag. Only the String type is supported.

Nested Schema : CreateAutoScalingPolicyDetails

Type: object

Discriminator: policyType

Creation details for an autoscaling policy. For more information, see "Using Schedule-Based Autoscaling" (https://docs.oracle.com/en/engineered-systems/private-cloud-appliance/3.0-latest/user/user-usr-instance-pools.html#usr-autoscale-scheduled).

Show Source

• capacity: object Capacity
  Capacity limits for the instance pool.
• displayName: string
  Minimum Length: 1

  Maximum Length: 255

  A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.
• isEnabled: boolean
  Default Value: true

  Whether the autoscaling policy is enabled.
• policyType(required): string
  Minimum Length: 1

  Maximum Length: 100

  The type of autoscaling policy.

{
    "description":"Creation details for an autoscaling policy. For more information, see \"Using Schedule-Based Autoscaling\" (https://docs.oracle.com/en/engineered-systems/private-cloud-appliance/3.0-latest/user/user-usr-instance-pools.html#usr-autoscale-scheduled).",
    "discriminator":"policyType",
    "type":"object",
    "properties":{
        "capacity":{
            "description":"The capacity requirements of the autoscaling policy.",
            "$ref":"#/definitions/Capacity"
        },
        "displayName":{
            "description":"A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "policyType":{
            "description":"The type of autoscaling policy.",
            "maxLength":"100",
            "minLength":"1",
            "type":"string"
        },
        "isEnabled":{
            "description":"Whether the autoscaling policy is enabled.",
            "type":"boolean",
            "default":true
        }
    },
    "required":[
        "policyType"
    ]
}

Nested Schema : Capacity

Type: object

Capacity limits for the instance pool.

Show Source

• initial: integer
  Minimum Value: 0

  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.
• max: integer
  Minimum Value: 0

  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.
• min: integer
  Minimum Value: 0

  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.

{
    "description":"Capacity limits for the instance pool.",
    "type":"object",
    "properties":{
        "max":{
            "description":"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.",
            "type":"integer",
            "minimum":"0"
        },
        "min":{
            "description":"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.",
            "type":"integer",
            "minimum":"0"
        },
        "initial":{
            "description":"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.",
            "type":"integer",
            "minimum":"0"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

The created object is returned.

Headers

• etag: string
  For optimistic concurrency control. See if-match.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : AutoScalingConfiguration

Type: object

An autoscaling configuration lets you dynamically scale the resources in a Compute instance pool. For more information, see "Using Schedule-Based AutoscalingUsing Schedule-Based Autoscaling" (https://docs.oracle.com/en/engineered-systems/private-cloud-appliance/3.0-latest/user/user-usr-instance-pools.html#usr-autoscale-scheduled).

Show Source

• compartmentId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the compartment containing the autoscaling configuration.
• coolDownInSeconds: integer
  Minimum Value: 0

  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.
• definedTags: object definedTags
  Additional Properties Allowed: additionalProperties

  Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}
• displayName: string
  Minimum Length: 1

  Maximum Length: 255

  A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.
• freeformTags: object freeformTags
  Additional Properties Allowed: additionalProperties

  Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
• id(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the autoscaling configuration.
• isEnabled: boolean
  Whether the autoscaling configuration is enabled.
• maxResourceCount: integer
  Minimum Value: 0

  The maximum number of resources to scale out to.
• minResourceCount: integer
  Minimum Value: 0

  The minimum number of resources to scale in to.
• policies(required): array policies
  Autoscaling policy definitions for the autoscaling configuration. An autoscaling policy defines the criteria that trigger autoscaling actions and the actions to take.
• resource(required): object Resource
  Discriminator: type

  A resource that is managed by an autoscaling configuration. The only supported type is instancePool. Each instance pool can have one autoscaling configuration.
• timeCreated(required): string(date-time)
  The date and time the autoscaling configuration was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

{
    "description":"An autoscaling configuration lets you dynamically scale the resources in a Compute instance pool. For more information, see \"Using Schedule-Based AutoscalingUsing Schedule-Based Autoscaling\" (https://docs.oracle.com/en/engineered-systems/private-cloud-appliance/3.0-latest/user/user-usr-instance-pools.html#usr-autoscale-scheduled).",
    "type":"object",
    "properties":{
        "compartmentId":{
            "description":"The OCID of the compartment containing the autoscaling configuration.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "definedTags":{
            "additionalProperties":{
                "additionalProperties":{
                    "description":"The value of the tag. Only the String type is supported.",
                    "type":"object"
                },
                "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.",
                "type":"object"
            },
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"Operations\": {\"CostCenter\": \"42\"}} ",
            "type":"object"
        },
        "displayName":{
            "description":"A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "freeformTags":{
            "additionalProperties":{
                "type":"string"
            },
            "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
            "type":"object"
        },
        "id":{
            "description":"The OCID of the autoscaling configuration.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "coolDownInSeconds":{
            "description":"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.",
            "type":"integer",
            "minimum":"0"
        },
        "isEnabled":{
            "description":"Whether the autoscaling configuration is enabled.",
            "type":"boolean"
        },
        "resource":{
            "$ref":"#/definitions/Resource"
        },
        "policies":{
            "description":"Autoscaling policy definitions for the autoscaling configuration. An autoscaling policy defines the criteria that trigger autoscaling actions and the actions to take.",
            "items":{
                "$ref":"#/definitions/AutoScalingPolicy"
            },
            "type":"array"
        },
        "timeCreated":{
            "description":"The date and time the autoscaling configuration was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z ",
            "format":"date-time",
            "type":"string"
        },
        "maxResourceCount":{
            "description":"The maximum number of resources to scale out to.",
            "type":"integer",
            "minimum":"0"
        },
        "minResourceCount":{
            "description":"The minimum number of resources to scale in to.",
            "type":"integer",
            "minimum":"0"
        }
    },
    "required":[
        "compartmentId",
        "id",
        "policies",
        "resource",
        "timeCreated"
    ],
    "x-example":"{   \"compartmentId\": \"ocid1.compartment.<var>unique_ID</var>\",   \"displayName\": \"example_autoscaling_configuration\",   \"id\": \"ocid1.autoscalingconfiguration.<var>unique_ID</var>\",   \"coolDownInSeconds\": 300,   \"isEnabled\": true,   \"resource\": {     \"type\": \"instancePool\",     \"id\": \"ocid1.instancepool.<var>unique_ID</var>\"   },   \"policies\": [     {       \"capacity\": {         \"max\": 50,         \"min\": 10,         \"initial\": 15       },       \"id\": \"<var>unique_ID</var>\",       \"displayName\": \"example_autoscaling_policy\",       \"policyType\": \"threshold\",       \"timeCreated\": \"2019-01-18T18:30:09.438Z\",       \"rules\": [         {           \"action\": {             \"type\": \"CHANGE_COUNT_BY\",             \"value\": 5           }           \"displayName\": \"example_scale_out_condition\",           \"id\": \"<var>unique_ID</var>\",           \"metric\": {             \"metricType\": \"CPU_UTILIZATION\",             \"threshold\": {               \"operator\": \"GTE\",               \"value\": 90             }           }         },         {           \"action\": {             \"type\": \"CHANGE_COUNT_BY\",             \"value\": -5           }           \"displayName\": \"example_scale_in_condition\",           \"id\": \"<var>unique_ID</var>\",           \"metric\": {             \"metricType\": \"CPU_UTILIZATION\",             \"threshold\": {               \"operator\": \"LTE\",               \"value\": 25             }           }         }       ]     }   ],   \"timeCreated\": \"2019-01-18T18:30:09.438Z\" } "
}

Nested Schema : definedTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing a defined tag key and value, scoped to a namespace.

{
    "additionalProperties":{
        "additionalProperties":{
            "description":"The value of the tag. Only the String type is supported.",
            "type":"object"
        },
        "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.",
        "type":"object"
    },
    "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"Operations\": {\"CostCenter\": \"42\"}} ",
    "type":"object"
}

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}

Nested Schema : freeformTags

Type: object

Additional Properties Allowed

Show Source

• string

{
    "additionalProperties":{
        "type":"string"
    },
    "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
    "type":"object"
}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}

Nested Schema : policies

Type: array

Autoscaling policy definitions for the autoscaling configuration. An autoscaling policy defines the criteria that trigger autoscaling actions and the actions to take.

Show Source

• Array of: object AutoScalingPolicy
  Discriminator: policyType

  Autoscaling policies define the criteria that trigger autoscaling actions and the actions to take. An autoscaling policy is part of an autoscaling configuration. For more information, see "Using Schedule-Based Autoscaling" (https://docs.oracle.com/en/engineered-systems/private-cloud-appliance/3.0-latest/user/user-usr-instance-pools.html#usr-autoscale-scheduled).

{
    "description":"Autoscaling policy definitions for the autoscaling configuration. An autoscaling policy defines the criteria that trigger autoscaling actions and the actions to take.",
    "items":{
        "$ref":"#/definitions/AutoScalingPolicy"
    },
    "type":"array"
}

Nested Schema : Resource

Type: object

Discriminator: type

A resource that is managed by an autoscaling configuration. The only supported type is instancePool. Each instance pool can have one autoscaling configuration.

Show Source

• id(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the resource that is managed by the autoscaling configuration.
• type(required): string
  Minimum Length: 1

  Maximum Length: 100

  The type of resource.

{
    "description":"A resource that is managed by an autoscaling configuration. The only supported type is instancePool. Each instance pool can have one autoscaling configuration.",
    "discriminator":"type",
    "properties":{
        "type":{
            "type":"string",
            "maxLength":"100",
            "minLength":"1",
            "description":"The type of resource."
        },
        "id":{
            "description":"The OCID of the resource that is managed by the autoscaling configuration.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        }
    },
    "required":[
        "type",
        "id"
    ],
    "type":"object"
}

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  The value of the tag. Only the String type is supported.

{
    "additionalProperties":{
        "description":"The value of the tag. Only the String type is supported.",
        "type":"object"
    },
    "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.",
    "type":"object"
}

Key-value pair representing a defined tag key and value, scoped to a namespace.

Nested Schema : additionalProperties

Type: object

The value of the tag. Only the String type is supported.

Nested Schema : AutoScalingPolicy

Type: object

Discriminator: policyType

Autoscaling policies define the criteria that trigger autoscaling actions and the actions to take. An autoscaling policy is part of an autoscaling configuration. For more information, see "Using Schedule-Based Autoscaling" (https://docs.oracle.com/en/engineered-systems/private-cloud-appliance/3.0-latest/user/user-usr-instance-pools.html#usr-autoscale-scheduled).

Show Source

• capacity: object Capacity
  Capacity limits for the instance pool.
• displayName: string
  Minimum Length: 1

  Maximum Length: 255

  A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.
• id: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the autoscaling policy that is assigned after creation.
• isEnabled: boolean
  Whether the autoscaling policy is enabled.
• policyType(required): string
  Minimum Length: 1

  Maximum Length: 100

  The type of autoscaling policy.
• timeCreated(required): string(date-time)
  The date and time the autoscaling configuration was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

{
    "description":"Autoscaling policies define the criteria that trigger autoscaling actions and the actions to take. An autoscaling policy is part of an autoscaling configuration. For more information, see \"Using Schedule-Based Autoscaling\" (https://docs.oracle.com/en/engineered-systems/private-cloud-appliance/3.0-latest/user/user-usr-instance-pools.html#usr-autoscale-scheduled).",
    "discriminator":"policyType",
    "properties":{
        "capacity":{
            "description":"The capacity requirements of the autoscaling policy.",
            "$ref":"#/definitions/Capacity"
        },
        "id":{
            "description":"The OCID of the autoscaling policy that is assigned after creation.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "displayName":{
            "description":"A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "policyType":{
            "description":"The type of autoscaling policy.",
            "maxLength":"100",
            "minLength":"1",
            "type":"string"
        },
        "timeCreated":{
            "description":"The date and time the autoscaling configuration was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z ",
            "format":"date-time",
            "type":"string"
        },
        "isEnabled":{
            "description":"Whether the autoscaling policy is enabled.",
            "type":"boolean"
        }
    },
    "required":[
        "policyType",
        "timeCreated"
    ],
    "x-example":"{   \"capacity\": {     \"max\": 50,     \"min\": 10,     \"initial\": 15   },   \"id\": \"<var>unique_ID</var>\",   \"displayName\": \"example_autoscaling_policy\",   \"policyType\": \"threshold\",   \"timeCreated\": \"2019-01-18T18:51:25.337Z\",   \"rules\": [     {       \"action\": {         \"type\": \"CHANGE_COUNT_BY\",         \"value\": 5       }       \"displayName\": \"example_scale_out_condition\",       \"id\": \"<var>unique_ID</var>\",       \"metric\": {         \"metricType\": \"CPU_UTILIZATION\",         \"threshold\": {           \"operator\": \"GTE\",           \"value\": 90         }       }     },     {       \"action\": {         \"type\": \"CHANGE_COUNT_BY\",         \"value\": -5       }       \"displayName\": \"example_scale_in_condition\",       \"id\": \"<var>unique_ID</var>\",       \"metric\": {         \"metricType\": \"CPU_UTILIZATION\",         \"threshold\": {           \"operator\": \"LTE\",           \"value\": 25         }       }     }   ] } ",
    "type":"object"
}

Nested Schema : Capacity

Type: object

Capacity limits for the instance pool.

Show Source

• initial: integer
  Minimum Value: 0

  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.
• max: integer
  Minimum Value: 0

  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.
• min: integer
  Minimum Value: 0

  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.

{
    "description":"Capacity limits for the instance pool.",
    "type":"object",
    "properties":{
        "max":{
            "description":"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.",
            "type":"integer",
            "minimum":"0"
        },
        "min":{
            "description":"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.",
            "type":"integer",
            "minimum":"0"
        },
        "initial":{
            "description":"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.",
            "type":"integer",
            "minimum":"0"
        }
    }
}

400 Response

Bad Request

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

401 Response

Unauthorized

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

404 Response

Not Found

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

409 Response

Conflict

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

500 Response

Internal Server Error

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

Default Response

An error has occurred.

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

Back to Top