Autoscaling Functions

CHANGE_AUTO_SCALING_CONFIGURATION_COMPARTMENT Function

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. When you move an autoscaling configuration to a different compartment, associated resources such as instance pools are not moved.

Syntax

FUNCTION change_auto_scaling_configuration_compartment (
  auto_scaling_configuration_id varchar2,
  change_compartment_details dbms_cloud_oci_autoscaling_change_auto_scaling_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_asc_auto_scaling_change_auto_scaling_configuration_compartment_response_t;

Parameters

Parameter	Description
`auto_scaling_configuration_id`	(required) The OCID of the autoscaling configuration.
`change_compartment_details`	(required) Request to change the compartment of given autoscaling configuration.
`opc_request_id`	(optional)
`if_match`	(optional) 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.
`opc_retry_token`	(optional) 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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://autoscaling.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_AUTO_SCALING_CONFIGURATION Function

Creates an autoscaling configuration.

Syntax

FUNCTION create_auto_scaling_configuration (
  create_auto_scaling_configuration_details dbms_cloud_oci_autoscaling_create_auto_scaling_configuration_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_asc_auto_scaling_create_auto_scaling_configuration_response_t;

Parameters

Parameter	Description
`create_auto_scaling_configuration_details`	(required) Creation details for an autoscaling configuration.
`opc_request_id`	(optional)
`opc_retry_token`	(optional) 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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://autoscaling.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_AUTO_SCALING_POLICY Function

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.

Syntax

FUNCTION create_auto_scaling_policy (
  auto_scaling_configuration_id varchar2,
  create_auto_scaling_policy_details dbms_cloud_oci_autoscaling_create_auto_scaling_policy_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_asc_auto_scaling_create_auto_scaling_policy_response_t;

Parameters

Parameter	Description
`auto_scaling_configuration_id`	(required) The OCID of the autoscaling configuration.
`create_auto_scaling_policy_details`	(required) Creation details for an autoscaling policy.
`opc_request_id`	(optional)
`opc_retry_token`	(optional) 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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://autoscaling.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_AUTO_SCALING_CONFIGURATION Function

Deletes an autoscaling configuration.

Syntax

FUNCTION delete_auto_scaling_configuration (
  auto_scaling_configuration_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_asc_auto_scaling_delete_auto_scaling_configuration_response_t;

Parameters

Parameter	Description
`auto_scaling_configuration_id`	(required) The OCID of the autoscaling configuration.
`if_match`	(optional) 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.
`opc_request_id`	(optional)
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://autoscaling.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_AUTO_SCALING_POLICY Function

Deletes an autoscaling policy for the specified autoscaling configuration.

Syntax

FUNCTION delete_auto_scaling_policy (
  auto_scaling_configuration_id varchar2,
  auto_scaling_policy_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_asc_auto_scaling_delete_auto_scaling_policy_response_t;

Parameters

Parameter	Description
`auto_scaling_configuration_id`	(required) The OCID of the autoscaling configuration.
`auto_scaling_policy_id`	(required) The ID of the autoscaling policy.
`if_match`	(optional) 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.
`opc_request_id`	(optional)
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://autoscaling.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_AUTO_SCALING_CONFIGURATION Function

Gets information about the specified autoscaling configuration.

Syntax

FUNCTION get_auto_scaling_configuration (
  auto_scaling_configuration_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_asc_auto_scaling_get_auto_scaling_configuration_response_t;

Parameters

Parameter	Description
`auto_scaling_configuration_id`	(required) The OCID of the autoscaling configuration.
`opc_request_id`	(optional)
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://autoscaling.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_AUTO_SCALING_POLICY Function

Gets information about the specified autoscaling policy in the specified autoscaling configuration.

Syntax

FUNCTION get_auto_scaling_policy (
  auto_scaling_configuration_id varchar2,
  auto_scaling_policy_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_asc_auto_scaling_get_auto_scaling_policy_response_t;

Parameters

Parameter	Description
`auto_scaling_configuration_id`	(required) The OCID of the autoscaling configuration.
`auto_scaling_policy_id`	(required) The ID of the autoscaling policy.
`opc_request_id`	(optional)
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://autoscaling.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_AUTO_SCALING_CONFIGURATIONS Function

Lists autoscaling configurations in the specifed compartment.

Syntax

FUNCTION list_auto_scaling_configurations (
  compartment_id varchar2,
  display_name varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_asc_auto_scaling_list_auto_scaling_configurations_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment containing the resource. Use tenancyId to search in the root compartment.
`display_name`	(optional) A filter to return only resources that match the given display name exactly.
`opc_request_id`	(optional)
`limit`	(optional) 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.
`page`	(optional) 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.
`sort_by`	(optional) 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. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. Allowed values are: 'ASC', 'DESC'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://autoscaling.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_AUTO_SCALING_POLICIES Function

Lists the autoscaling policies in the specified autoscaling configuration.

Syntax

FUNCTION list_auto_scaling_policies (
  auto_scaling_configuration_id varchar2,
  display_name varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_asc_auto_scaling_list_auto_scaling_policies_response_t;

Parameters

Parameter	Description
`auto_scaling_configuration_id`	(required) The OCID of the autoscaling configuration.
`display_name`	(optional) A filter to return only resources that match the given display name exactly.
`opc_request_id`	(optional)
`limit`	(optional) 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.
`page`	(optional) 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.
`sort_by`	(optional) 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. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. Allowed values are: 'ASC', 'DESC'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://autoscaling.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_AUTO_SCALING_CONFIGURATION Function

Updates certain fields on the specified autoscaling configuration, such as the name, the cooldown period, and whether the autoscaling configuration is enabled.

Syntax

FUNCTION update_auto_scaling_configuration (
  auto_scaling_configuration_id varchar2,
  update_auto_scaling_configuration_details dbms_cloud_oci_autoscaling_update_auto_scaling_configuration_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_asc_auto_scaling_update_auto_scaling_configuration_response_t;

Parameters

Parameter	Description
`auto_scaling_configuration_id`	(required) The OCID of the autoscaling configuration.
`update_auto_scaling_configuration_details`	(required) Update details for an autoscaling configuration.
`if_match`	(optional) 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.
`opc_request_id`	(optional)
`opc_retry_token`	(optional) 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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://autoscaling.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_AUTO_SCALING_POLICY Function

Updates an autoscaling policy in the specified autoscaling configuration.

Syntax

FUNCTION update_auto_scaling_policy (
  auto_scaling_configuration_id varchar2,
  auto_scaling_policy_id varchar2,
  update_auto_scaling_policy_details dbms_cloud_oci_autoscaling_update_auto_scaling_policy_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_asc_auto_scaling_update_auto_scaling_policy_response_t;

Parameters

Parameter	Description
`auto_scaling_configuration_id`	(required) The OCID of the autoscaling configuration.
`auto_scaling_policy_id`	(required) The ID of the autoscaling policy.
`update_auto_scaling_policy_details`	(required) Update details for an autoscaling policy.
`if_match`	(optional) 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.
`opc_request_id`	(optional)
`opc_retry_token`	(optional) 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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://autoscaling.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

Oracle Cloud Infrastructure Documentation Try Free Tier

CHANGE_AUTO_SCALING_CONFIGURATION_COMPARTMENT Function 🔗

CREATE_AUTO_SCALING_CONFIGURATION Function 🔗

CREATE_AUTO_SCALING_POLICY Function 🔗

DELETE_AUTO_SCALING_CONFIGURATION Function 🔗

DELETE_AUTO_SCALING_POLICY Function 🔗

GET_AUTO_SCALING_CONFIGURATION Function 🔗

GET_AUTO_SCALING_POLICY Function 🔗

LIST_AUTO_SCALING_CONFIGURATIONS Function 🔗

LIST_AUTO_SCALING_POLICIES Function 🔗

UPDATE_AUTO_SCALING_CONFIGURATION Function 🔗

UPDATE_AUTO_SCALING_POLICY Function 🔗

Oracle Cloud Infrastructure Documentation
Try Free Tier

CHANGE_AUTO_SCALING_CONFIGURATION_COMPARTMENT Function

CREATE_AUTO_SCALING_CONFIGURATION Function

CREATE_AUTO_SCALING_POLICY Function

DELETE_AUTO_SCALING_CONFIGURATION Function

DELETE_AUTO_SCALING_POLICY Function

GET_AUTO_SCALING_CONFIGURATION Function

GET_AUTO_SCALING_POLICY Function

LIST_AUTO_SCALING_CONFIGURATIONS Function

LIST_AUTO_SCALING_POLICIES Function

UPDATE_AUTO_SCALING_CONFIGURATION Function

UPDATE_AUTO_SCALING_POLICY Function