otcextensions.sdk.auto_scaling.v1.group

The AS Group Class

The Group class inherits from Resource.

class otcextensions.sdk.auto_scaling.v1.group.Group(_synchronized=False, connection=None, **attrs)

The base resource

Parameters:
  • _synchronized (bool) – This is not intended to be used directly. See new() and existing().

  • connection (openstack.connection.Connection) – Reference to the Connection being used. Defaults to None to allow Resource objects to be used without an active Connection, such as in unit tests. Use of self._connection in Resource code should protect itself with a check for None.

resource_key: ty.Optional[str] = 'scaling_group'

Singular form of key for resource.

resources_key: ty.Optional[str] = 'scaling_groups'

Plural form of key for resource.

base_path: str = '/scaling_group'

The base part of the URI for this resource.

allow_create = True

Allow create operation for this resource.

allow_list = True

Allow list operation for this resource.

allow_fetch = True

Allow get operation for this resource.

allow_delete = True

Allow delete operation for this resource.

allow_commit = True

Allow update operation for this resource.

id

Properties AutoScaling group ID

name: ty.Union[Body, URI]

AutoScaling group name

status

AutoScaling group status, valid valus includes: INSERVICE, PAUSED, ERROR

is_scaling

AutoScaling group scaling status, Type: bool

detail

AutoScaling group detail

router_id

VPC id - (Router Id)

networks

network id list - (Subnet)

security_groups

security group id list

scaling_configuration_id

Auto Scaling Config ID reference, used for creating instance

scaling_configuration_name

Auto Scaling Config name

current_instance_number

Current alive instance number

desire_instance_number

Desire alive instance number

min_instance_number

min alive instance number

max_instance_number

max alive instance number

cool_down_time

CoolDown time, only work with ALARM policy. default is 900, valid range is 0-86400

lb_listener_id

load balancer listener id reference

lbaas_listeners

list of enhanced load balancers

health_periodic_audit_method

Health periodic audit method, Valid values include: ELB_AUDIT, NOVA_AUDIT, ELB_AUDIT and lb_listener_id are used in pairs.

health_periodic_audit_time

Health periodic audit time, valid values include: 5, 15, 60, 180, default is 5 minutes

health_periodic_audit_grace_period

Grace period for instance health check, valid if audit method is ELB_AUDIT, value range is 0-86400, default value is 600

instance_terminate_policy

Instance terminate policy, valid values include: OLD_CONFIG_OLD_INSTANCE (default), OLD_CONFIG_NEW_INSTANCE, OLD_INSTANCE, NEW_INSTANCE

notifications

Notification methods, EMAIL

delete_publicip

Should delete public ip when terminate instance, default false

delete_volume

Should delete data disks when deleting the ECS, default false

availability_zones

Availability zones

create_time

Create time of the group

multi_az_priority_policy

The priority policy used to select target AZs, valid values include: EQUILIBRIUM_DISTRIBUTE (default), PICK_FIRST

resume(session)

resume group

pause(session)

pause group

delete(session, error_message=None, force_delete=False)

Delete the remote resource based on this instance.

This function overrides default Resource.delete to enable params

Parameters:

session (Adapter) – The session to use for making this request.

Returns:

This Group instance.