AutoScalingClient

class oci.autoscaling.AutoScalingClient(config, **kwargs)

APIs for dynamically scaling 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 [Overview of the Compute Service](/Content/Compute/Concepts/computeoverview.htm).

Note: Autoscaling is not available in US Government Cloud tenancies. For more information, see [Oracle Cloud Infrastructure US Government Cloud](/Content/General/Concepts/govoverview.htm).

Methods

__init__(config, **kwargs) Creates a new service client
change_auto_scaling_configuration_compartment(…) Moves an autoscaling configuration into a different compartment within the same tenancy.
create_auto_scaling_configuration(…) Creates an autoscaling configuration.
create_auto_scaling_policy(…) Creates an autoscaling policy for the specified autoscaling configuration.
delete_auto_scaling_configuration(…) Deletes an autoscaling configuration.
delete_auto_scaling_policy(…) Deletes an autoscaling policy for the specified autoscaling configuration.
get_auto_scaling_configuration(…) Gets information about the specified autoscaling configuration.
get_auto_scaling_policy(…) Gets information about the specified autoscaling policy in the specified autoscaling configuration.
list_auto_scaling_configurations(…) Lists autoscaling configurations in the specifed compartment.
list_auto_scaling_policies(…) Lists the autoscaling policies in the specified autoscaling configuration.
update_auto_scaling_configuration(…) Updates certain fields on the specified autoscaling configuration, such as the name, the cooldown period, and whether the autoscaling configuration is enabled.
update_auto_scaling_policy(…) Updates an autoscaling policy in the specified autoscaling configuration.
__init__(config, **kwargs)

Creates a new service client

Parameters:
  • config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
  • service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
  • timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
  • signer (AbstractBaseSigner) –

    (optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

    One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

  • circuit_breaker_strategy (obj) – (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client uses DEFAULT_CIRCUIT_BREAKER_STRATEGY as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described here.
  • circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
  • allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.
change_auto_scaling_configuration_compartment(auto_scaling_configuration_id, change_compartment_details, **kwargs)

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.

Parameters:
  • auto_scaling_configuration_id (str) –

    (required) The OCID of the autoscaling configuration.

  • change_compartment_details (oci.autoscaling.models.ChangeAutoScalingCompartmentDetails) – (required) Request to change the compartment of given autoscaling configuration.
  • opc_request_id (str) – (optional)
  • if_match (str) – (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 (str) – (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).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None
Return type:

Response
Example:

Click here to see an example of how to use change_auto_scaling_configuration_compartment API.

create_auto_scaling_configuration(create_auto_scaling_configuration_details, **kwargs)

Creates an autoscaling configuration.

Parameters:
  • create_auto_scaling_configuration_details (oci.autoscaling.models.CreateAutoScalingConfigurationDetails) – (required) Creation details for an autoscaling configuration.
  • opc_request_id (str) – (optional)
  • opc_retry_token (str) – (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).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type AutoScalingConfiguration
Return type:

Response
Example:

Click here to see an example of how to use create_auto_scaling_configuration API.

create_auto_scaling_policy(auto_scaling_configuration_id, create_auto_scaling_policy_details, **kwargs)

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.

Parameters:
  • auto_scaling_configuration_id (str) –

    (required) The OCID of the autoscaling configuration.

  • create_auto_scaling_policy_details (oci.autoscaling.models.CreateAutoScalingPolicyDetails) – (required) Creation details for an autoscaling policy.
  • opc_request_id (str) – (optional)
  • opc_retry_token (str) – (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).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type AutoScalingPolicy
Return type:

Response
Example:

Click here to see an example of how to use create_auto_scaling_policy API.

delete_auto_scaling_configuration(auto_scaling_configuration_id, **kwargs)

Deletes an autoscaling configuration.

Parameters:
  • auto_scaling_configuration_id (str) –

    (required) The OCID of the autoscaling configuration.

  • if_match (str) – (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 (str) – (optional)
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None
Return type:

Response
Example:

Click here to see an example of how to use delete_auto_scaling_configuration API.

delete_auto_scaling_policy(auto_scaling_configuration_id, auto_scaling_policy_id, **kwargs)

Deletes an autoscaling policy for the specified autoscaling configuration.

Parameters:
  • auto_scaling_configuration_id (str) –

    (required) The OCID of the autoscaling configuration.

  • auto_scaling_policy_id (str) – (required) The ID of the autoscaling policy.
  • if_match (str) – (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 (str) – (optional)
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None
Return type:

Response
Example:

Click here to see an example of how to use delete_auto_scaling_policy API.

get_auto_scaling_configuration(auto_scaling_configuration_id, **kwargs)

Gets information about the specified autoscaling configuration.

Parameters:
  • auto_scaling_configuration_id (str) –

    (required) The OCID of the autoscaling configuration.

  • opc_request_id (str) – (optional)
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type AutoScalingConfiguration
Return type:

Response
Example:

Click here to see an example of how to use get_auto_scaling_configuration API.

get_auto_scaling_policy(auto_scaling_configuration_id, auto_scaling_policy_id, **kwargs)

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

Parameters:
  • auto_scaling_configuration_id (str) –

    (required) The OCID of the autoscaling configuration.

  • auto_scaling_policy_id (str) – (required) The ID of the autoscaling policy.
  • opc_request_id (str) – (optional)
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type AutoScalingPolicy
Return type:

Response
Example:

Click here to see an example of how to use get_auto_scaling_policy API.

list_auto_scaling_configurations(compartment_id, **kwargs)

Lists autoscaling configurations in the specifed compartment.

Parameters:
  • compartment_id (str) –

    (required) The OCID of the compartment containing the resource. Use tenancyId to search in the root compartment.

  • display_name (str) – (optional) A filter to return only resources that match the given display name exactly.
  • opc_request_id (str) – (optional)
  • limit (int) –

    (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 (str) –

    (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 (str) –

    (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 (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “ASC”, “DESC”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type list of AutoScalingConfigurationSummary
Return type:

Response
Example:

Click here to see an example of how to use list_auto_scaling_configurations API.

list_auto_scaling_policies(auto_scaling_configuration_id, **kwargs)

Lists the autoscaling policies in the specified autoscaling configuration.

Parameters:
  • auto_scaling_configuration_id (str) –

    (required) The OCID of the autoscaling configuration.

  • display_name (str) – (optional) A filter to return only resources that match the given display name exactly.
  • opc_request_id (str) – (optional)
  • limit (int) –

    (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 (str) –

    (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 (str) –

    (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 (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “ASC”, “DESC”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type list of AutoScalingPolicySummary
Return type:

Response
Example:

Click here to see an example of how to use list_auto_scaling_policies API.

update_auto_scaling_configuration(auto_scaling_configuration_id, update_auto_scaling_configuration_details, **kwargs)

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

Parameters:
  • auto_scaling_configuration_id (str) –

    (required) The OCID of the autoscaling configuration.

  • update_auto_scaling_configuration_details (oci.autoscaling.models.UpdateAutoScalingConfigurationDetails) – (required) Update details for an autoscaling configuration.
  • if_match (str) – (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 (str) – (optional)
  • opc_retry_token (str) – (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).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type AutoScalingConfiguration
Return type:

Response
Example:

Click here to see an example of how to use update_auto_scaling_configuration API.

update_auto_scaling_policy(auto_scaling_configuration_id, auto_scaling_policy_id, update_auto_scaling_policy_details, **kwargs)

Updates an autoscaling policy in the specified autoscaling configuration.

Parameters:
  • auto_scaling_configuration_id (str) –

    (required) The OCID of the autoscaling configuration.

  • auto_scaling_policy_id (str) – (required) The ID of the autoscaling policy.
  • update_auto_scaling_policy_details (oci.autoscaling.models.UpdateAutoScalingPolicyDetails) – (required) Update details for an autoscaling policy.
  • if_match (str) – (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 (str) – (optional)
  • opc_retry_token (str) – (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).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type AutoScalingPolicy
Return type:

Response
Example:

Click here to see an example of how to use update_auto_scaling_policy API.