Help Center/ Auto Scaling/ API Reference/ APIs/ AS Groups/ Modifying an AS Group
Updated on 2026-10-15 GMT+08:00
View PDF
Share

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, ELB, 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.

Authorization

Each account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned.

URI

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

Table 1 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Specifies the project ID. For details, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

scaling_group_id

Yes

String

Definition

Specifies the AS group ID. For details about how to obtain it, see Querying AS Groups.

Constraints

N/A

Range

N/A

Default Value

N/A

Request

Table 2 Request parameters

Parameter

Mandatory

Type

Description

scaling_group_name

No

String

Definition

Specifies the AS group name.

Constraints

N/A

Range

It contains 1 to 64 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

Default Value

N/A

desire_instance_number

No

Integer

Definition

Specifies the expected number of instances.

Constraints

Minimum number of instances ≤ Expected number of instances ≤ Maximum number of instances

Range

N/A

Default Value

N/A

min_instance_number

No

Integer

Definition

Specifies the minimum number of instances.

Constraints

N/A

Range

N/A

Default Value

N/A

max_instance_number

No

Integer

Definition

Specifies the maximum number of instances.

Constraints

The value must be greater than or equal to the minimum number of instances.

Range

An integer from 0 to 300

Default Value

1

cool_down_time

No

Integer

Definition

Specifies the cooldown period, in seconds.

Constraints

During the cooldown period, AS denies all scaling requests triggered by alarm-based policies. Scaling requests triggered manually or by scheduled or periodic policies are not affected.

Range

0s to 86,400s

Default Value

300

available_zones

No

Array of strings

Definition

Specifies the AZ ID. The ECSs 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.

Constraints

AZ information can be modified only when all the following conditions are met:

  • No scaling actions are being performed in the AS group.
  • The number of instances in the AS group is 0.
  • The AS group is not in service.

networks

No

Array of networks objects

Definition

Specifies network information. The first subnet you specify is where ECS primary NICs are created by default. That is, the NIC associated with the first subnet is the primary NIC. Other subnets are for ECS extended NICs. For details about how to obtain subnet information, see Querying Subnets. For details about the data structure, see Table 4.

Constraints

  • A maximum of five subnets can be selected.
  • 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

Definition

Specifies security group information. A maximum of one security group can be selected. For how to obtain security group information, see Querying Security Groups. For information about the data structure, see Table 7.

Constraints

  • 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

Definition

Specifies the load balancer listener ID. For details about how to obtain the listener ID, see Querying Load Balancers.

Constraints

  • A maximum of six load balancer listeners can be added. Multiple listener IDs are separated by 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.

Range

N/A

Default Value

N/A

lbaas_listeners

No

Array of lbaas_listeners objects

Definition

Specifies load balancers. This parameter is in list data structure. For details, see Table 3. For how to obtain information about an enhanced load balancer, see Querying Backend Server Groups.

Constraints

A maximum of six load balancers can be added.

health_periodic_audit_method

No

String

Definition

Specifies the health check method for instances in the AS group.

Constraints

If ELB is not configured for an AS group, the ELB_AUDIT method cannot be used.

Range

  • 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 that comes with AS.

Default Value

When load balancing is configured for an AS group, the default value is ELB_AUDIT. Otherwise, the default value is NOVA_AUDIT.

health_periodic_audit_time

No

Integer

Definition

Specifies the health check interval, in minutes.

Constraints

N/A

Range

The value can be 1, 5, 15, 60, or 180 minutes. If the value is set to 0, health check can be performed every 10 seconds.

Default Value

5 minutes

instance_terminate_policy

No

String

Definition

Specifies the instance removal policy.

Constraints

N/A

Range

  • OLD_CONFIG_OLD_INSTANCE: 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.

Default Value

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

health_periodic_audit_grace_period

No

Integer

Definition

Specifies the health check grace period, in seconds.

Constraints

  • 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.

Range

0s to 86,400s

Default Value

600

scaling_configuration_id

No

String

Definition

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

Constraints

N/A

Range

N/A

Default Value

N/A

delete_publicip

No

Boolean

Definition

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.

Constraints

If an EIP is billed on a yearly/monthly basis, it will not be deleted when an ECS is removed.

Range

  • true: The EIPs bound to ECSs will be deleted when the ECSs are removed.
  • false: The EIPs bound to ECSs will be unbound but will not be deleted when the ECSs are removed.

Default Value

false

delete_volume

No

Boolean

Definition

Specifies whether to delete the data disks attached to the ECS when deleting the ECS.

Constraints

If a data disk is billed on a yearly/monthly basis, it will not be deleted when an ECS is removed.

Range

  • true: The data disks attached to ECSs will be deleted when the ECSs are removed. If a data disk is billed on a yearly/monthly basis, it will not be deleted when an ECS is removed.
  • false: The data disks attached to the ECSs will be detached but will not be deleted when the ECSs are removed.

Default Value

false

enterprise_project_id

No

String

Definition

Specifies the enterprise project ID, which is used to specify the enterprise project to which the AS group belongs. For details about enterprise project features, see Enterprise Project Management Service.

Constraints

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 is used.

Range

  • 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. For how to obtain an enterprise project ID, see Listing Enterprise Projects.

Default Value

N/A

multi_az_priority_policy

No

String

Definition

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

Constraints

This parameter is required only when two or more AZs are selected.

Range

  • EQUILIBRIUM_DISTRIBUTE: During a scaling action, the system preferentially distributes instances evenly across AZs listed in available_zones. If it fails in the target AZ, it selects another AZ based on the PICK_FIRST policy.
  • PICK_FIRST: During a scaling action, target AZs are determined in the order in the available_zones list.

Default Value

EQUILIBRIUM_DISTRIBUTE

description

No

String

Definition

Specifies the description of the AS group.

Constraints

N/A

Range

1 to 256 characters, with no restrictions on character types

Default Value

N/A

iam_agency_name

No

String

Definition

Specifies the agency name. An agency is created by a tenant administrator in Identity and Access Management (IAM) to provide temporary credentials for the ECS service to access other cloud services.

Constraints

  • If iam_agency_name is not specified, no modification is required.
  • If iam_agency_name is an empty string or any other value, you can modify it.

Range

1 to 64 characters, with no restrictions on character types

Default Value

N/A
Table 3 lbaas_listeners field description

Parameter

Mandatory

Type

Description

pool_id

Yes

String

Definition

Specifies the backend server group ID. For details about how to obtain it, see Querying Backend Server Groups.

Constraints

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.

Range

N/A

Default Value

N/A

protocol_port

Yes

Integer

Definition

Specifies the backend protocol port, that is, the port that backend ECSs listen on.

Constraints

N/A

Range

[1, 65535]

Default Value

N/A

weight

Yes

Integer

Definition

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.

Constraints

If lb_algorithm is set to SOURCE_IP or QUIC_CID, this field is invalid.

Range

[0, 100]

Default Value

N/A

protocol_version

No

String

Definition

Specifies the version of IP addresses used by the backend server group with load balancing configured.

Constraints

  • Instances in an AS group do not support IPv4/IPv6 dual-stack on multiple NICs. IPv4/IPv6 dual-stack is only available for the first NIC that supports both IPv4 and IPv6. The NIC may be a primary NIC or an extension NIC.
  • Only ECSs with flavors that support IPv6 addresses can use IPv4/IPv6 dual-stack networks. If you want to select IPv6 for this parameter, make sure that you have selected such ECS flavors in a supported region.
  • If you add two or more load balancers whose pool_id, protocol_port, and protocol_version settings are totally the same, deduplication will be performed.

Range

  • ipv4: IPv4 addresses are used.
  • ipv6: IPv6 addresses are used.

Default Value

ipv4
Table 4 networks field description

Parameter

Mandatory

Type

Description

id

Yes

String

Definition

Specifies the subnet ID. For details about how to obtain it, see Querying Subnets.

Constraints

N/A

Range

N/A

Default Value

N/A

ipv6_enable

No

Boolean

Definition

Whether to enable IPv6.

Constraints

The subnet must support IPv6.

Range

  • true: IPv6 is enabled for the NIC.
  • false: IPv6 is not enabled for the NIC.

Default Value

false

ipv6_bandwidth

No

ipv6_bandwidth object

Definition

Specifies the IPv6 shared bandwidth. This parameter is left blank by default, indicating that no shared IPv6 bandwidth is bound. For details, see Table 5.

Constraints

N/A

allowed_address_pairs

No

Array of allowed_address_pairs objects

Definition

Specifies whether to enable source/destination check. For details, see Table 6.

Constraints

N/A
Table 5 ipv6_bandwidth field description

Parameter

Mandatory

Type

Description

id

Yes

String

Definition

Specifies the ID of the IPv6 shared bandwidth. For details about how to obtain it, see Querying Shared Bandwidth Types of a Specified Tenant.

Constraints

N/A

Range

N/A

Default Value

N/A
Table 6 allowed_address_pairs field description

Parameter

Type

Description

ip_address

String

Definition

Specifies whether to enable source/destination check for IP addresses.

Constraints

N/A

Range

  • To disable this function, set the value to 1.1.1.1/0.
  • To enable this function, set a value other than 1.1.1.1/0.

Default Value

This function is enabled by default. This parameter cannot be left blank.
Table 7 security_groups field description

Parameter

Mandatory

Type

Description

id

Yes

String

Definition

Specifies the security group ID. For details about how to obtain it, see Querying Security Groups.

Constraints

N/A

Range

N/A

Default Value

N/A

Example Request

This example changes the name, AS configuration, enterprise project, 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,   
    "iam_agency_name": "test",
    "multi_az_priority_policy": "PICK_FIRST"
}

Response

Table 8 Response parameters

Parameter

Type

Description

scaling_group_id

String

Definition

Specifies the AS group ID.

Range

N/A

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.

Parent topic: AS Groups