Modifying an AS Group

Function

This API is used to modify a specified AS group.

  • When the AS configuration of an AS group is changed, the existing instances created using the original AS configuration are not affected.

  • If no scaling action is being performed, you can modify its subnet and AZ configurations.

  • Changing the number of expected instances in an AS group will trigger a scaling action to add or remove instances to or from the AS group. The number of expected instances must be greater than or equal to the minimum number of instances and less than or equal to the maximum number of instances.

URI

PUT /autoscaling-api/v1/{project_id}/scaling_group/{scaling_group_id}

Table 1 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.

scaling_group_id

Yes

String

Specifies the AS group ID.

Request Parameters

Table 2 Request parameters

Parameter

Mandatory

Type

Description

scaling_group_name

No

String

Specifies the AS group name. The name contains only letters, digits, underscores (_), and hyphens (-), and cannot exceed 64 characters.

desire_instance_number

No

Integer

Specifies the expected number of instances.

The value ranges from the minimum number of instances to the maximum number of instances.

min_instance_number

No

Integer

Specifies the minimum number of instances.

max_instance_number

No

Integer

Specifies the maximum number of instances, which is greater than or equal to the minimum number of instances.

cool_down_time

No

Integer

Specifies the cooldown period (in seconds). The value ranges from 0 to 86400 and is 300 by default.

available_zones

No

Array of strings

Specifies the AZ information. The instances added in a scaling action will be created in a specified AZ. If you do not specify an AZ, the system automatically specifies one.

For details, see Regions and Endpoints.

You can change the AZ of an AS group only when no scaling action is being performed in the group.

networks

No

Array of networks objects

Specifies network information. You can select up to five subnets. The first subnet you select is used by the primary NICs of ECSs by default. For the information about the data structure, see Table 4.

The value of this parameter can be changed only when all the following conditions are met:

  • No scaling actions are triggered in the AS group.

  • The number of instances in the AS group is 0.

  • The AS group is not in service.

security_groups

No

Array of security_groups objects

Specifies the security group information. A maximum of one security group can be selected. For information about the data structure, see Table 5.

If a security group is specified both in the AS configuration and AS group, scaled ECS instances will be added to the security group specified in the AS configuration. If a security group is not specified in either of them, scaled ECS instances will be added to the default security group. For your convenience, you are advised to specify the security group in the AS configuration. The value of this parameter can be changed only when all the following conditions are met:

  • No scaling actions are triggered in the AS group.

  • The number of instances in the AS group is 0.

  • The AS group is not in service.

lb_listener_id

No

String

Specifies the ELB listener ID. You can add up to six load balancer listeners. Separate listener IDs with commas (,).

The value of this parameter can be changed only when all the following conditions are met:

  • No scaling actions are triggered in the AS group.

  • The number of instances in the AS group is 0.

  • The AS group is not in service.

lbaas_listeners

No

Array of lbaas_listeners objects

Specifies information about an ELB load balancer. You can add up to six load balancers. This parameter is in list data structure. For details, see Table 3.

This parameter is alternative to lb_listener_id.

health_periodic_audit_method

No

String

Specifies the health check method for instances in the AS group. The health check methods include ELB_AUDIT and NOVA_AUDIT. When load balancing is configured for an AS group, the default value is ELB_AUDIT. Otherwise, the default value is NOVA_AUDIT.

  • ELB_AUDIT: indicates the ELB health check, which takes effect in an AS group with a listener.

  • NOVA_AUDIT: indicates the ECS health check, which is the health check method delivered with AS.

health_periodic_audit_time

No

Integer

Specifies the health check period for the instances in the AS group. The value can be 1, 5, 15, 60, or 180 in the unit of minutes.

If the value is set to 0, health check is performed every 10 seconds.

instance_terminate_policy

No

String

Specifies the instance removal policy.

  • OLD_CONFIG_OLD_INSTANCE (default): The earlier-created instances based on the earlier-created AS configurations are removed first.

  • OLD_CONFIG_NEW_INSTANCE: The later-created instances based on the earlier-created AS configurations are removed first.

  • OLD_INSTANCE: The earlier-created instances are removed first.

  • NEW_INSTANCE: The later-created instances are removed first.

health_periodic_audit_grace_period

No

Integer

Specifies the grace period for instance health check. The unit is second and value range is 0-86400. The default value is 600.

The health check grace period starts after an instance is added to an AS group and is enabled. The AS group will start checking the instance status only after the grace period ends.

This parameter is valid only when the instance health check method of the AS group is ELB_AUDIT.

scaling_configuration_id

No

String

Specifies the AS configuration ID, which can be obtained using the API for querying AS configurations. For details, see Querying AS configurations.

notifications

No

Array of strings

Specifies the notification mode.

EMAIL refers to notification by email.

delete_publicip

No

Boolean

Specifies whether to delete the EIP bound to the ECS when deleting the ECS. If you do not want to delete the EIP, set this parameter to false. Then, the system only unbinds the EIP from the ECS and reserves the EIP.

  • true: deletes the EIP bound to the ECS when deleting the ECS.

  • false: only unbinds the EIP bound to the ECS when deleting the ECS.

delete_volume

No

Boolean

Specifies whether to delete the data disks attached to the ECS when deleting the ECS. The value can be true or false. The default value is false.

  • true: deletes the data disks attached to the ECS when deleting the ECS.

  • false: only detaches the data disks attached to the ECS when deleting the ECS.

enterprise_project_id

No

String

Specifies the enterprise project ID, which is used to specify the enterprise project to which the AS group belongs.

  • If the value is 0 or left blank, the AS group belongs to the default enterprise project.

  • If the value is a UUID, the AS group belongs to the enterprise project corresponding to the UUID..

If an enterprise project is configured for an AS group, ECSs created in this AS group also belong to this enterprise project. Otherwise, the default enterprise project will be used.

multi_az_priority_policy

No

String

Specifies the priority policy used to select target AZs when adjusting the number of instances in an AS group.

  • EQUILIBRIUM_DISTRIBUTE (default): When adjusting the number of instances, ensure that instances in each AZ in the available_zones list is evenly distributed. If instances cannot be added in the target AZ, select another AZ based on the PICK_FIRST policy.

  • PICK_FIRST: When adjusting the number of instances, target AZs are determined in the order in the available_zones list.

description

No

String

Specifies the description of the AS group. The value can contain 1 to 256 characters.

Table 3 lbaas_listeners field description

Parameter

Mandatory

Type

Description

pool_id

Yes

String

Specifies the backend ECS group ID.

The value of this parameter can be changed only when all the following conditions are met:

  • No scaling actions are triggered in the AS group.

  • The number of instances in the AS group is 0.

  • The AS group is not in service.

protocol_port

Yes

Integer

Specifies the backend protocol port, which is the port on which a backend ECS listens for traffic. The port ranges from 1 to 65535.

weight

Yes

Integer

Specifies the weight, which determines the portion of requests a backend ECS processes when being compared to other backend ECSs added to the same listener. The value of this parameter ranges from 0 to 100.

Table 4 networks field description

Parameter

Mandatory

Type

Description

id

Yes

String

Specifies the subnet ID.

ipv6_enable

No

Boolean

Specifies whether to support IPv6 addresses.

true: indicates that the NIC supports IPv6 addresses.

false: indicates that the NIC does not support IPv6 addresses. The default value is false.

ipv6_bandwidth

No

ipv6_bandwidth object

Specifies the shared bandwidth of an IPv6 address. This parameter is left blank by default, indicating that no shared IPv6 bandwidth is bound.

Table 5 security_groups field description

Parameter

Mandatory

Type

Description

id

Yes

String

Specifies the ID of the security group.

Example Request

This example changes the name, AS configuration, expected number of instances, minimum number of instances, maximum number of instances, and cooldown period of the AS group with ID a8327883-6b07-4497-9c61-68d03ee193a1.

PUT https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group/a8327883-6b07-4497-9c61-68d03ee193a1

{
    "scaling_group_name": "group_1",
    "scaling_configuration_id": "f8327883-6a07-4497-9a61-68c03e8e72a2",
    "enterprise_project_id": "c92b1a5d-6f20-43f2-b1b7-7ce35e58e413",
    "desire_instance_number": 1,
    "min_instance_number": 1,
    "max_instance_number": 3,
    "cool_down_time": 200,
    "multi_az_priority_policy": "PICK_FIRST"

}

Response parameters

Table 6 Response parameters

Parameter

Type

Description

scaling_group_id

String

Specifies the AS group ID.

Example Response

{
    "scaling_group_id": "a8327883-6b07-4497-9c61-68d03ee193a1"
}

Returned Values

  • Normal

    200

  • Abnormal

    Returned Value

    Description

    400 Bad Request

    The server failed to process the request.

    401 Unauthorized

    You must enter the username and password to access the requested page.

    403 Forbidden

    You are forbidden to access the requested page.

    404 Not Found

    The server could not find the requested page.

    405 Method Not Allowed

    You are not allowed to use the method specified in the request.

    406 Not Acceptable

    The response generated by the server could not be accepted by the client.

    407 Proxy Authentication Required

    You must use the proxy server for authentication to process the request.

    408 Request Timeout

    The request timed out.

    409 Conflict

    The request could not be processed due to a conflict.

    500 Internal Server Error

    Failed to complete the request because of an internal service error.

    501 Not Implemented

    Failed to complete the request because the server does not support the requested function.

    502 Bad Gateway

    Failed to complete the request because the request is invalid.

    503 Service Unavailable

    Failed to complete the request because the system is unavailable.

    504 Gateway Timeout

    A gateway timeout error occurred.

Error Codes

See Error Codes.

last updated: 2024-11-13 13:44 UTC - commit: 90734a801640ff4923d58ef70d4df9c8a041cfd1