openapi: 3.2.0 info: description: 'Use the Autoscaling API to dynamically scale compute resources to meet application requirements. For more information about autoscaling, see [Autoscaling](/Content/Compute/Tasks/autoscalinginstancepools.htm). For information about the Compute service, see [Compute](/Content/Compute/home.htm). ' title: Auto Scaling API version: '20181001' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/413902c2f198bba0a2c9aad62a4454040fa6d057036747336477142eadcf1214.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Autoscaling API OCI service and stored verbatim; API Evangelist added only this provenance block. x-evidence: - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json what: Oracle's own index of every OCI service specification - url: https://docs.oracle.com/en-us/iaas/api/specs/413902c2f198bba0a2c9aad62a4454040fa6d057036747336477142eadcf1214.yaml what: the harvested document for Autoscaling API servers: - url: /20181001 tags: - description: Autoscaling Service name: autoScaling paths: /autoScalingConfigurations: get: description: 'Lists autoscaling configurations in the specifed compartment. ' operationId: ListAutoScalingConfigurations parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/AutoScalingConfigurationSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListAutoScalingConfigurations tags: - autoScaling x-example: 'GET /20181001/autoScalingConfigurations?compartmentId=<compartment_OCID> Host: autoscaling.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' post: description: Creates an autoscaling configuration. operationId: CreateAutoScalingConfiguration parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The created object is returned. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AutoScalingConfiguration' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateAutoScalingConfiguration tags: - autoScaling x-example: "Example: Create a threshold-based autoscaling configuration\nPOST /20181001/autoScalingConfigurations\nHost: autoscaling.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\": \"example_threshold_autoscaling_configuration\",\n \"coolDownInSeconds\": 300,\n \"isEnabled\": true,\n \"policies\": [\n {\n \"capacity\": {\n \"max\": 50,\n \"min\": 10,\n \"initial\": 15\n },\n \"displayName\": \"example_autoscaling_policy\",\n \"policyType\": \"threshold\",\n \"rules\": [\n {\n \"action\": {\n \"type\": \"CHANGE_COUNT_BY\",\n \"value\": 5\n },\n \"displayName\": \"example_scale_out_condition\",\n \"metric\": {\n \"metricType\": \"CPU_UTILIZATION\",\n \"threshold\": {\n \"operator\": \"GTE\",\n \"value\": 90\n }\n }\n },\n {\n \"action\": {\n \"type\": \"CHANGE_COUNT_BY\",\n \"value\": -5\n },\n \"displayName\": \"example_scale_in_condition\",\n \"metric\": {\n \"metricType\": \"CPU_UTILIZATION\",\n \"threshold\": {\n \"operator\": \"LTE\",\n \"value\": 25\n }\n }\n }\n ]\n }\n ],\n \"resource\": {\n \"type\": \"instancePool\",\n \"id\": \"ocid1.instancepool.oc1..<unique_ID>\"\n }\n}\n\nExample: Create a schedule-based autoscaling configuration\nPOST /20181001/autoScalingConfigurations\nHost: autoscaling.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\": \"example_scheduled_autoscaling_configuration\",\n \"isEnabled\": true,\n \"policies\": [\n {\n \"policyType\": \"scheduled\",\n \"capacity\": {\n \"initial\": \"100\"\n },\n \"displayName\": \"example_scale_out_schedule\",\n \"isEnabled\": true,\n \"executionSchedule\": {\n \"type\": \"cron\",\n \"expression\": \"0 0 8 ? * MON-FRI *\",\n \"timezone\": \"UTC\"\n }\n },\n {\n \"policyType\": \"scheduled\",\n \"capacity\": {\n \"initial\": \"20\"\n },\n \"displayName\": \"example_scale_in_schedule\",\n \"isEnabled\": true,\n \"executionSchedule\": {\n \"type\": \"cron\",\n \"expression\": \"0 0 18 ? * MON-FRI *\",\n \"timezone\": \"UTC\"\n }\n }\n ],\n \"resource\": {\n \"type\": \"instancePool\",\n \"id\": \"ocid1.instancepool.oc1.iad.<unique_ID>\"\n }\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAutoScalingConfigurationDetails' description: Creation details for an autoscaling configuration. required: true /autoScalingConfigurations/{autoScalingConfigurationId}: delete: description: Deletes an autoscaling configuration. operationId: DeleteAutoScalingConfiguration parameters: - $ref: '#/components/parameters/AutoScalingConfigurationIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' responses: 204: description: The autoscaling configuration is being deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteAutoScalingConfiguration tags: - autoScaling x-example: 'DELETE /20181001/autoScalingConfigurations/<autoscaling_configuration_ID> Host: autoscaling.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutoScalingConfiguration' get: description: Gets information about the specified autoscaling configuration. operationId: GetAutoScalingConfiguration parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/AutoScalingConfigurationIdPathParam' responses: 200: description: The autoscaling configuration was retrieved. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AutoScalingConfiguration' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetAutoScalingConfiguration tags: - autoScaling x-example: 'GET /20181001/autoScalingConfigurations/<autoscaling_configuration_ID> Host: autoscaling.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' put: description: 'Updates certain fields on the specified autoscaling configuration, such as the name, the cooldown period, and whether the autoscaling configuration is enabled. ' operationId: UpdateAutoScalingConfiguration parameters: - $ref: '#/components/parameters/AutoScalingConfigurationIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The updated autoscaling configuration. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AutoScalingConfiguration' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateAutoScalingConfiguration tags: - autoScaling x-example: "PUT /20181001/autoScalingConfigurations/<autoscaling_configuration_ID>\nHost: autoscaling.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"example_autoscaling_configuration\",\n \"isEnabled\": false,\n \"coolDownInSeconds\": 600\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAutoScalingConfigurationDetails' description: Update details for an autoscaling configuration. required: true /autoScalingConfigurations/{autoScalingConfigurationId}/actions/changeCompartment: post: description: 'Moves an autoscaling configuration into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). When you move an autoscaling configuration to a different compartment, associated resources such as instance pools are not moved. ' operationId: ChangeAutoScalingConfigurationCompartment parameters: - $ref: '#/components/parameters/AutoScalingConfigurationIdPathParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: The resource was moved. headers: etag: description: 'The resulting etag of the autoscaling configuration affected by this operation. For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeAutoScalingConfigurationCompartment tags: - autoScaling x-example: "POST /20181001/autoScalingConfigurations/<autoscaling_configuration_OCID>/actions/changeCompartment\nHost: autoscaling.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\"\n}\n" x-related-resource: '#/definitions/AutoScalingConfiguration' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeAutoScalingCompartmentDetails' description: Request to change the compartment of given autoscaling configuration. required: true /autoScalingConfigurations/{autoScalingConfigurationId}/policies: get: description: 'Lists the autoscaling policies in the specified autoscaling configuration. ' operationId: ListAutoScalingPolicies parameters: - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/AutoScalingConfigurationIdPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/AutoScalingPolicySummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListAutoScalingPolicies tags: - autoScaling x-example: 'GET /20181001/autoScalingConfigurations/<autoscaling_configuration_ID>/policies Host: autoscaling.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutoScalingPolicySummary' post: description: 'Creates an autoscaling policy for the specified autoscaling configuration. You can create the following types of autoscaling policies: - **Schedule-based:** Autoscaling events take place at the specific times that you schedule. - **Threshold-based:** An autoscaling action is triggered when a performance metric meets or exceeds a threshold. An autoscaling configuration can either have multiple schedule-based autoscaling policies, or one threshold-based autoscaling policy. ' operationId: CreateAutoScalingPolicy parameters: - $ref: '#/components/parameters/AutoScalingConfigurationIdPathParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: Returns the created policy. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AutoScalingPolicy' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateAutoScalingPolicy tags: - autoScaling x-example: "Example: Create a threshold-based autoscaling policy\nPOST /20181001/autoScalingConfigurations/<autoscalingConfigurationId>/policies\nHost: autoscaling.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"capacity\": {\n \"max\": 50,\n \"min\": 10,\n \"initial\": 15\n },\n \"displayName\": \"example_threshold_autoscaling_policy\",\n \"policyType\": \"threshold\",\n \"isEnabled\": true,\n \"rules\": [\n {\n \"action\": {\n \"type\": \"CHANGE_COUNT_BY\",\n \"value\": 5\n },\n \"displayName\": \"example_scale_out_condition\",\n \"metric\": {\n \"metricType\": \"CPU_UTILIZATION\",\n \"threshold\": {\n \"operator\": \"GTE\",\n \"value\": 90\n }\n }\n },\n {\n \"action\": {\n \"type\": \"CHANGE_COUNT_BY\",\n \"value\": -5\n },\n \"displayName\": \"example_scale_in_condition\",\n \"metric\": {\n \"metricType\": \"CPU_UTILIZATION\",\n \"threshold\": {\n \"operator\": \"LTE\",\n \"value\": 25\n }\n }\n }\n ]\n}\n\nExample: Create a schedule-based autoscaling policy\nPOST /20181001/autoScalingConfigurations/<autoscalingConfigurationId>/policies\nHost: autoscaling.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"capacity\": {\n \"initial\": 25\n },\n \"displayName\": \"example_scheduled_autoscaling_policy\",\n \"policyType\": \"scheduled\",\n \"isEnabled\": true,\n \"executionSchedule\": {\n \"type\": \"cron\",\n \"timezone\": \"UTC\",\n \"expression\": \"0 15 10 ? * *\"\n }\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAutoScalingPolicyDetails' description: Creation details for an autoscaling policy. required: true /autoScalingConfigurations/{autoScalingConfigurationId}/policies/{autoScalingPolicyId}: delete: description: Deletes an autoscaling policy for the specified autoscaling configuration. operationId: DeleteAutoScalingPolicy parameters: - $ref: '#/components/parameters/AutoScalingConfigurationIdPathParam' - $ref: '#/components/parameters/AutoScalingPolicyIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' responses: 204: description: The autoscaling policy is being deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteAutoScalingPolicy tags: - autoScaling x-example: 'DELETE /20181001/autoScalingConfigurations/<autoscaling_configuration_ID>/policies/<autoscaling_policy_ID> Host: autoscaling.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AutoScalingPolicy' get: description: Gets information about the specified autoscaling policy in the specified autoscaling configuration. operationId: GetAutoScalingPolicy parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/AutoScalingConfigurationIdPathParam' - $ref: '#/components/parameters/AutoScalingPolicyIdPathParam' responses: 200: description: The autoscaling policy was retrieved. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AutoScalingPolicy' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetAutoScalingPolicy tags: - autoScaling x-example: 'GET /20181001/autoScalingConfigurations/<autoscaling_configuration_ID>/policies/<autoscaling_policy_ID> Host: autoscaling.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' put: description: Updates an autoscaling policy in the specified autoscaling configuration. operationId: UpdateAutoScalingPolicy parameters: - $ref: '#/components/parameters/AutoScalingConfigurationIdPathParam' - $ref: '#/components/parameters/AutoScalingPolicyIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The updated autoscaling policy. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AutoScalingPolicy' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateAutoScalingPolicy tags: - autoScaling x-example: "PUT /20181001/autoScalingConfigurations/<autoscaling_configuration_ID>/policies/<autoscaling_policy_ID>\nHost: autoscaling.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"example_threshold_autoscaling_policy\",\n \"capacity\": {\n \"max\": 50,\n \"min\": 10,\n \"initial\": 15\n },\n \"policyType\": \"threshold\",\n \"rules\": [\n {\n \"action\": {\n \"type\": \"CHANGE_COUNT_BY\",\n \"value\": 5\n },\n \"displayName\": \"example_scale_out_condition\",\n \"metric\": {\n \"metricType\": \"CPU_UTILIZATION\",\n \"threshold\": {\n \"operator\": \"GTE\",\n \"value\": 90\n }\n }\n },\n {\n \"action\": {\n \"type\": \"CHANGE_COUNT_BY\",\n \"value\": -5\n },\n \"displayName\": \"example_scale_in_condition\",\n \"metric\": {\n \"metricType\": \"CPU_UTILIZATION\",\n \"threshold\": {\n \"operator\": \"LTE\",\n \"value\": 25\n }\n }\n }\n ]\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAutoScalingPolicyDetails' description: Update details for an autoscaling policy. required: true components: schemas: Capacity: description: 'Capacity limits for the instance pool. ' properties: 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. ' minimum: 0 type: integer 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. ' minimum: 0 type: integer 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. ' minimum: 0 type: integer type: object AutoScalingConfiguration: description: 'An autoscaling configuration lets you dynamically scale the resources in a Compute instance pool. For more information, see [Autoscaling](/iaas/Content/Compute/Tasks/autoscalinginstancepools.htm). ' properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing 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. ' minimum: 0 type: integer 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. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s 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. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the autoscaling configuration. maxLength: 255 minLength: 1 type: string isEnabled: description: Whether the autoscaling configuration is enabled. type: boolean maxResourceCount: description: The maximum number of resources to scale out to. minimum: 0 type: integer minResourceCount: description: The minimum number of resources to scale in to. minimum: 0 type: integer 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: '#/components/schemas/AutoScalingPolicy' type: array resource: $ref: '#/components/schemas/Resource' 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 required: - compartmentId - id - policies - resource - timeCreated type: object x-example: "{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\": \"example_autoscaling_configuration\",\n \"id\": \"ocid1.autoscalingconfiguration.oc1..<unique_ID>\",\n \"coolDownInSeconds\": 300,\n \"isEnabled\": true,\n \"resource\": {\n \"type\": \"instancePool\",\n \"id\": \"ocid1.instancepool.oc1..<unique_ID>\"\n },\n \"policies\": [\n {\n \"capacity\": {\n \"max\": 50,\n \"min\": 10,\n \"initial\": 15\n },\n \"id\": \"<unique_ID>\",\n \"displayName\": \"example_autoscaling_policy\",\n \"policyType\": \"threshold\",\n \"timeCreated\": \"2019-01-18T18:30:09.438Z\",\n \"rules\": [\n {\n \"action\": {\n \"type\": \"CHANGE_COUNT_BY\",\n \"value\": 5\n }\n \"displayName\": \"example_scale_out_condition\",\n \"id\": \"<unique_ID>\",\n \"metric\": {\n \"metricType\": \"CPU_UTILIZATION\",\n \"threshold\": {\n \"operator\": \"GTE\",\n \"value\": 90\n }\n }\n },\n {\n \"action\": {\n \"type\": \"CHANGE_COUNT_BY\",\n \"value\": -5\n }\n \"displayName\": \"example_scale_in_condition\",\n \"id\": \"<unique_ID>\",\n \"metric\": {\n \"metricType\": \"CPU_UTILIZATION\",\n \"threshold\": {\n \"operator\": \"LTE\",\n \"value\": 25\n }\n }\n }\n ]\n }\n ],\n \"timeCreated\": \"2019-01-18T18:30:09.438Z\"\n}\n" AutoScalingConfigurationSummary: description: 'Summary information for an autoscaling configuration. ' properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing 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. ' minimum: 0 type: integer 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. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s 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. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the autoscaling configuration. maxLength: 255 minLength: 1 type: string isEnabled: description: Whether the autoscaling configuration is enabled. type: boolean resource: $ref: '#/components/schemas/Resource' 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 required: - compartmentId - id - resource - timeCreated type: object x-example: "{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\": \"example_autoscaling_configuration\",\n \"id\": \"ocid1.autoscalingconfiguration.oc1..<unique_ID>\",\n \"coolDownInSeconds\": 300,\n \"isEnabled\": true,\n \"resource\": {\n \"type\": \"instancePool\",\n \"id\": \"ocid1.instancepool.oc1..<unique_ID>\"\n },\n \"timeCreated\": \"2019-01-18T18:44:45.285Z\"\n}\n" Error: properties: code: description: 'A short error code that defines the error, meant for programmatic parsing. See [API Errors](/Content/API/References/apierrors.htm). ' type: string message: description: A human-readable error string. type: string required: - code - message 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: propertyName: type properties: id: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the resource that is managed by the autoscaling configuration. ' maxLength: 255 minLength: 1 type: string type: description: The type of resource. maxLength: 100 minLength: 1 type: string required: - type - id UpdateAutoScalingPolicyDetails: discriminator: propertyName: policyType properties: capacity: $ref: '#/components/schemas/Capacity' description: The capacity requirements of the autoscaling policy. displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string isEnabled: default: true description: Whether the autoscaling policy is enabled. type: boolean policyType: description: Indicates the type of autoscaling policy. maxLength: 100 minLength: 1 type: string required: - policyType AutoScalingPolicy: description: "Autoscaling policies define the criteria that trigger autoscaling actions and the actions to take.\n\nAn autoscaling policy is part of an autoscaling configuration. For more information, see\n[Autoscaling](/iaas/Content/Compute/Tasks/autoscalinginstancepools.htm).\n\nYou can create the following types of autoscaling policies:\n \n - **Schedule-based:** Autoscaling events take place at the specific times that you schedule.\n - **Threshold-based:** An autoscaling action is triggered when a performance metric meets or exceeds a threshold.\n" discriminator: propertyName: policyType properties: capacity: $ref: '#/components/schemas/Capacity' description: The capacity requirements of the autoscaling policy. displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string id: description: The ID of the autoscaling policy that is assigned after creation. maxLength: 255 minLength: 1 type: string isEnabled: description: Whether the autoscaling policy is enabled. type: boolean 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 required: - policyType - timeCreated x-example: "{\n \"capacity\": {\n \"max\": 50,\n \"min\": 10,\n \"initial\": 15\n },\n \"id\": \"<unique_ID>\",\n \"displayName\": \"example_autoscaling_policy\",\n \"policyType\": \"threshold\",\n \"timeCreated\": \"2019-01-18T18:51:25.337Z\",\n \"rules\": [\n {\n \"action\": {\n \"type\": \"CHANGE_COUNT_BY\",\n \"value\": 5\n }\n \"displayName\": \"example_scale_out_condition\",\n \"id\": \"<unique_ID>\",\n \"metric\": {\n \"metricType\": \"CPU_UTILIZATION\",\n \"threshold\": {\n \"operator\": \"GTE\",\n \"value\": 90\n }\n }\n },\n {\n \"action\": {\n \"type\": \"CHANGE_COUNT_BY\",\n \"value\": -5\n }\n \"displayName\": \"example_scale_in_condition\",\n \"id\": \"<unique_ID>\",\n \"metric\": {\n \"metricType\": \"CPU_UTILIZATION\",\n \"threshold\": {\n \"operator\": \"LTE\",\n \"value\": 25\n }\n }\n }\n ]\n}\n" ChangeAutoScalingCompartmentDetails: description: The configuration details for the move operation. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the autoscaling configuration to. ' maxLength: 255 minLength: 1 type: string required: - compartmentId UpdateAutoScalingConfigurationDetails: properties: alarmStreamId: type: string coolDownInSeconds: minimum: 0 type: integer 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. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s 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. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isEnabled: description: Whether the autoscaling configuration is enabled. type: boolean CreateAutoScalingConfigurationDetails: description: 'Creation details for an autoscaling configuration. ' properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing 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. ' minimum: 0 type: integer 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. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s 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. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isEnabled: description: Whether the autoscaling configuration is enabled. type: boolean policies: items: $ref: '#/components/schemas/CreateAutoScalingPolicyDetails' type: array resource: $ref: '#/components/schemas/Resource' required: - compartmentId - policies - resource type: object CreateAutoScalingPolicyDetails: description: 'Creation details for an autoscaling policy. You can create the following types of autoscaling policies: - **Schedule-based:** Autoscaling events take place at the specific times that you schedule. - **Threshold-based:** An autoscaling action is triggered when a performance metric meets or exceeds a threshold. An autoscaling configuration can either have multiple schedule-based autoscaling policies, or one threshold-based autoscaling policy. ' discriminator: propertyName: policyType properties: capacity: $ref: '#/components/schemas/Capacity' description: The capacity requirements of the autoscaling policy. displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string isEnabled: default: true description: Whether the autoscaling policy is enabled. type: boolean policyType: description: The type of autoscaling policy. maxLength: 100 minLength: 1 type: string required: - policyType type: object AutoScalingPolicySummary: description: 'Summary information for an autoscaling policy. ' properties: displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string id: description: The ID of the autoscaling policy that is assigned after creation. maxLength: 255 minLength: 1 type: string isEnabled: description: Whether the autoscaling policy is enabled. type: boolean policyType: description: The type of autoscaling policy. maxLength: 100 minLength: 1 type: string required: - id - policyType x-example: "{\n \"id\": \"<unique_ID>\",\n \"displayName\": \"example_autoscaling_policy\",\n \"policyType\": \"threshold\",\n \"isEnabled\": true\n}\n" parameters: SortByQueryParam: description: 'The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. **Note:** In general, some "List" operations (for example, `ListInstances`) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted. ' in: query name: sortBy required: false x-default-description: The default field to sort by varies by API. schema: type: string enum: - TIMECREATED - DISPLAYNAME PaginationTokenQueryParam: description: 'For list pagination. The value of the `opc-next-page` response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' in: query name: page schema: type: string default: 'null' maxLength: 512 minLength: 1 AutoScalingConfigurationIdPathParam: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the autoscaling configuration. in: path name: autoScalingConfigurationId required: true schema: type: string CompartmentIdQueryParam: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the resource. Use tenancyId to search in the root compartment. ' in: query name: compartmentId required: true x-example: ocid1.compartment.oc1..exampleaozhsmynlmeeqbo6iiq4dwjghobpkodzxab5pwezb3vny4bntc5yq schema: type: string maxLength: 255 minLength: 1 IfMatchHeader: description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match schema: type: string AutoScalingPolicyIdPathParam: description: The ID of the autoscaling policy. in: path name: autoScalingPolicyId required: true schema: type: string FilterByDisplayNameQueryParam: description: 'A filter to return only resources that match the given display name exactly. ' in: query name: displayName required: false schema: type: string default: 'null' maxLength: 255 minLength: 1 PaginationLimitQueryParam: description: 'For list pagination. The maximum number of items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' in: query name: limit schema: type: integer default: 15 maximum: 1000 minimum: 1 SortOrderQueryParam: description: 'The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. ' in: query name: sortOrder required: false x-default-description: The default sort order varies by API. schema: type: string enum: - ASC - DESC RetryTokenHeader: description: '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). ' in: header name: opc-retry-token schema: type: string maxLength: 64 minLength: 1 OpcRequestIdHeaderParam: in: header name: opc-request-id required: false schema: type: string pattern: ^[A-Za-z0-9\-_\.]+$ responses: DefaultError: description: An error has occurred. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' x-anchors: x-properties: 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. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object 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. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object x-obmcs-client-retries-enabled: true x-oracle-package: com.oracle.pic.autoscaling