diff --git a/docs/as/api-ref/as_06_0101.html b/docs/as/api-ref/as_06_0101.html index 8e54c856..7f86cbb4 100644 --- a/docs/as/api-ref/as_06_0101.html +++ b/docs/as/api-ref/as_06_0101.html @@ -1,8 +1,9 @@
Creating an AS Group
-Function
An AS group consists of a collection of instances that apply to the same scenario. It is the basis for enabling or disabling AS policies and performing scaling actions. An AS group specifies parameters, such as the maximum number of instances, expected number of instances, minimum number of instances, VPC, subnet, and load balancing.
-- Each user can create a maximum of 25 AS groups by default.
- If ELB is configured, AS automatically binds or unbinds a load balancer to or from an instance when the instance is added to or removed from the AS group.
- If an AS group uses ELB health check, the listening ports on the load balancers must be enabled for the instances in the AS group. Enable the listening ports in security groups.
Function
An AS group is a collection of instances that are used in the same scenario. It is the basis for enabling or disabling AS policies and performing scaling actions. An AS group specifies parameters, such as the maximum number of instances, expected number of instances, minimum number of instances, VPC, subnet, and load balance settings.
+- Each account can create a maximum of 25 AS groups by default.
- If a load balancer is associated with an AS group, AS automatically associates the load balancer with or dissociates the load balancer from instances when the instances are added to or removed from the AS group.
- If ELB health check is enabled for an AS group, the instances in the AS group must use all the listening ports of each load balancer for health check. You can configure these ports in the security group of the instances. +
URI
POST /autoscaling-api/v1/{project_id}/scaling_group
@@ -29,293 +30,338 @@Request Message
- Request parameters
-
Table 2 Request parameters Parameter
+Request
+-Table 2 Request parameters Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
scaling_group_name
+scaling_group_name
Yes
+Yes
String
+String
Specifies the AS group name. The name contains only letters, digits, underscores (_), and hyphens (-), and cannot exceed 64 characters.
+Specifies the AS group name. The name contains only letters, digits, underscores (_), and hyphens (-), and cannot exceed 64 characters.
scaling_configuration_id
+scaling_configuration_id
Yes
+Yes
String
+String
Specifies the AS configuration ID, which can be obtained using the API for querying AS configurations. For details, see Querying AS configurations.
+Specifies the AS configuration ID, which can be obtained using the API for querying AS configurations. For details, see Querying AS configurations.
desire_instance_number
+desire_instance_number
No
+No
Integer
+Integer
Specifies the expected number of instances. The default value is the minimum number of instances.
+Specifies the expected number of instances. The default value is the minimum number of instances.
The value ranges from the minimum number of instances to the maximum number of instances.
min_instance_number
+min_instance_number
No
+No
Integer
+Integer
Specifies the minimum number of instances. The default value is 0.
+Specifies the minimum number of instances. The default value is 0.
max_instance_number
+max_instance_number
No
+No
Integer
+Integer
Specifies the maximum number of instances. The default value is 0.
+Specifies the maximum number of instances. The default value is 1. The value is an integer ranging from 0 to 300.
cool_down_time
+cool_down_time
No
+No
Integer
+Integer
Specifies the cooldown period (in seconds). The value ranges from 0 to 86400 and is 300 by default.
-After a scaling action is triggered, the system starts the cooldown period. During the cooldown period, scaling actions triggered by alarms will be denied. Scheduled, periodic, and manual scaling actions are not affected.
+Specifies the cooldown period (in seconds). The value ranges from 0 to 86400 and defaults to 300.
+After a scaling action is complete, the cooldown period starts. 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.
+NOTE:- When an AS group scales out, scale-in requests triggered manually or by scheduled and periodic policies will be executed immediately after the scale-out is complete, without being affected by the cooldown period.
- When an AS group scales in, scale-out requests triggered manually or by scheduled and periodic policies will be executed immediately after the scale-in is complete, without being affected by the cooldown period.
lb_listener_id
+lb_listener_id
No
+No
String
+String
Specifies the ID of a classic load balancer listener. You can add up to six load balancer listeners. Separate listener IDs with commas (,).
+Specifies the ID of a listener added to a load balancer. You can add up to six listeners. Separate listener IDs with commas (,).
This parameter is alternative to lbaas_listeners.
lbaas_listeners
+lbaas_listeners
No
+No
Array of lbaas_listeners objects
+Array of lbaas_listeners objects
Specifies information about an enhanced 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.
+Specifies information about a 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.
available_zones
+available_zones
No
+No
Array of strings
+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.
+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.
networks
+networks
Yes
+Yes
Array of networks objects
+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.
+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.
security_groups
+security_groups
No
+No
Array of security_groups objects
+Array of security_groups objects
Specifies the security group. A maximum of one security group can be selected. For the information about the data structure, see Table 5.
-If the 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 the 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.
+Specifies the security group information. Only one security group can be selected. For the information about the data structure, see Table 6.
+If a security group is specified both in the AS configuration and the AS group, scaled-out 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-out instances will be added to the default security group. For your convenience, specify a security group in the AS configuration.
vpc_id
+vpc_id
Yes
+Yes
String
+String
Specifies the VPC ID, which can be obtained using the API for querying VPCs. For details, see "Querying VPCs" in Virtual Private Network API Reference.
+Specifies the VPC ID, which can be obtained using the API for querying VPCs. For details, see "Querying VPCs" in Virtual Private Network API Reference.
health_periodic_audit_method
+health_periodic_audit_method
No
+No
String
+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 instance health check, which is the health check method delivered with AS.
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 instance health check, which is the health check method that comes with AS.
health_periodic_audit_time
+health_periodic_audit_time
No
+No
Integer
+Integer
Specifies the instance health check period. The value can be 1, 5, 15, 60, or 180 in the unit of minutes. If this parameter is not specified, the default value is 5.
+Specifies the health check interval. The value can be 1, 5, 15, 60, or 180 in the unit of minutes. If this parameter is not specified, the default value is 5.
If the value is set to 0, health check is performed every 10 seconds.
health_periodic_audit_grace_period
+health_periodic_audit_grace_period
No
+No
Integer
+Integer
Specifies the grace period for instance health check. The unit is second and the value ranges from 0 to 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.
+Specifies the grace period for instance health check. The unit is second and the value ranges from 0 to 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 health only after the grace period ends.
This parameter is valid only when the instance health check method of the AS group is ELB_AUDIT.
instance_terminate_policy
+instance_terminate_policy
No
+No
String
+String
Specifies the instance removal policy.
+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.
notifications
+notifications
No
+No
Array of strings
+Array of strings
Specifies the notification mode.
+Specifies the notification mode.
EMAIL refers to notification by email.
delete_publicip
+delete_publicip
No
+No
Boolean
+Boolean
Specifies whether to delete the EIP bound to the ECS when deleting the ECS. The value can be true or false. The default value is false.- 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.
Specifies whether to delete the EIPs bound to ECS instances when the instances are removed from the AS group during scale-in actions. The value can be true or false. The default value is false.- true: The EIPs bound to ECSs will be released when the ECSs are removed.
- false: The EIPs bound to ECSs will be unbound but will not be released when the ECSs are removed.
delete_volume
+delete_volume
No
+No
Boolean
+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.
Specifies whether to delete the data disks attached to ECS instances when the instances are removed from the AS group during scale-in actions. The value can be true or false. The default value is false.- true: The data disks attached to ECSs will be released when the ECSs are removed.
- false: The data disks attached to ECSs will be detached but will not be released when the ECSs are removed.
enterprise_project_id
+enterprise_project_id
No
+No
String
+String
Specifies the enterprise project ID, which is used to specify the enterprise project to which the AS group belongs.
+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
+multi_az_priority_policy
No
+No
String
+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.
Specifies the priority policy used to select target AZs when adjusting the number of instances in an AS group.
+- EQUILIBRIUM_DISTRIBUTE (default): When AS scales out the AS group, it preferentially distributes instances evenly across AZs in the available_zones list. If it fails in the target AZ, it selects another AZ based on the PICK_FIRST policy.
- PICK_FIRST: When AS scales out the AS group, the target AZ is determined in the order in the available_zones list.
description
+description
No
+No
String
+String
Specifies the description of the AS group. The value can contain 1 to 256 characters.
+Specifies the description of the AS group. The value can contain 1 to 256 characters.
Table 3 lbaas_listeners field description Parameter
+-Table 3 lbaas_listeners field description Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
pool_id
+pool_id
Yes
+Yes
String
+String
Specifies the backend ECS group ID.
+Specifies the backend server group ID.
protocol_port
+protocol_port
Yes
+Yes
Integer
+Integer
Specifies the backend protocol ID, which is the port on which a backend ECS listens for traffic. The port ID ranges from 1 to 65535.
+Specifies the port configured for the backend server group, which is the port on which a backend server listens for traffic. The port ranges from 1 to 65535.
weight
+weight
Yes
+Yes
Integer
+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.
+Specifies the weight, which determines the percentage of requests a backend server processes. The value of this parameter ranges from 0 to 100.
Table 4 networks field description Parameter
++ +
+Table 4 networks field description Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
id
+id
Yes
+Yes
String
+String
Specifies the subnet ID.
+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 ipv6_bandwidth field description Parameter
+Mandatory
+Type
+Description
+id
+Yes
+String
+Specifies the ID of the shared bandwidth of an IPv6 address.
Table 5 security_groups field description Parameter
+- -Table 6 security_groups field description Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
id
+id
Yes
+Yes
String
+String
Specifies the security group ID.
+Specifies the security group ID.
- Example request
The following example shows how to create an AS group:
-- The AS group is named GroupNameTest.
- The AS configuration ID is 47683a91-93ee-462a-a7d7-484c006f4440.
- The VPC ID is a8327883-6b07-4497-9c61-68d03ee193a, and the network ID is 3cd35bca-5a10-416f-8994-f79169559870.
- The maximum number of instances is 10, the expected number of instances is 0, and the minimum number of instances is 0.
- The health check method is ECS health check.
- When adjusting the number of instances, select target AZ based on the PICK FIRST policy.
The request example is as follows:
+Example Request
This example creates an AS group with the name GroupNameTest, the AS configuration ID 47683a91-93ee-462a-a7d7-484c006f4440, the VPC ID a8327883-6b07-4497-9c61-68d03ee193a, the NIC ID 3cd35bca-5a10-416f-8994-f79169559870, the maximum number of instances of 10, the expected number of instances of 0, the minimum number of instances of 0, and the health check method of ECS health check, and the multi-AZ scaling policy of PICK_FIRST.
+{ "scaling_group_name": "GroupNameTest", "scaling_configuration_id": "47683a91-93ee-462a-a7d7-484c006f4440", @@ -364,112 +408,109 @@ "id": "3cd35bca-5a10-416f-8994-f79169559870" } ], - "enterprise_project_id": "c92b1a5d-6f20-43f2-b1b7-7ce35e58e413", - "multi_az_priority_policy": "PICK_FIRST", - + "enterprise_project_id":"c92b1a5d-6f20-43f2-b1b7-7ce35e58e413", + "multi_az_priority_policy":"PICK_FIRST" }-
Response Message
- Response parameters
-
Table 6 Response parameter Parameter
++Response
+- -Table 7 Response parameters Parameter
Type
+Type
Description
+Description
scaling_group_id
+scaling_group_id
String
+String
Specifies the AS group ID.
+Specifies the AS group ID.
- Example response
{ +
Example Response
{ "scaling_group_id": "a8327883-6b07-4497-9c61-68d03ee193a1" }-Returned Values
- Normal
- Abnormal
-
Returned Value
+-Returned Value
Description
+Description
400 Bad Request
+400 Bad Request
The server failed to process the request.
+The server failed to process the request.
401 Unauthorized
+401 Unauthorized
You must enter the username and password to access the requested page.
+You must enter the username and password to access the requested page.
403 Forbidden
+403 Forbidden
You are forbidden to access the requested page.
+You are forbidden to access the requested page.
404 Not Found
+404 Not Found
The server could not find the requested page.
+The server could not find the requested page.
405 Method Not Allowed
+405 Method Not Allowed
You are not allowed to use the method specified in the request.
+You are not allowed to use the method specified in the request.
406 Not Acceptable
+406 Not Acceptable
The response generated by the server could not be accepted by the client.
+The response generated by the server could not be accepted by the client.
407 Proxy Authentication Required
+407 Proxy Authentication Required
You must use the proxy server for authentication to process the request.
+You must use the proxy server for authentication to process the request.
408 Request Timeout
+408 Request Timeout
The request timed out.
+The request timed out.
409 Conflict
+409 Conflict
The request could not be processed due to a conflict.
+The request could not be processed due to a conflict.
500 Internal Server Error
+500 Internal Server Error
Failed to complete the request because of an internal service error.
+Failed to complete the request because of an internal service error.
501 Not Implemented
+501 Not Implemented
Failed to complete the request because the server does not support the requested function.
+Failed to complete the request because the server does not support the requested function.
502 Bad Gateway
+502 Bad Gateway
Failed to complete the request because the request is invalid.
+Failed to complete the request because the request is invalid.
503 Service Unavailable
+503 Service Unavailable
Failed to complete the request because the system is unavailable.
+Failed to complete the request because the system is unavailable.
504 Gateway Timeout
+504 Gateway Timeout
A gateway timeout error occurred.
+A gateway timeout error occurred.
Request Message
- Request parameters -
- Example requestThis example shows how to query AS groups with name as-group-test and AS configuration ID 1d281494-6085-4579-b817-c1f813be835f.
GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group?scaling_group_name=as-group-test&scaling_configuration_id=1d281494-6085-4579-b817-c1f813be835f+- +Request
None
Example Request
This example queries AS groups with name as-group-test and AS configuration ID 1d281494-6085-4579-b817-c1f813be835f.-GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group?scaling_group_name=as-group-test&scaling_configuration_id=1d281494-6085-4579-b817-c1f813be835fResponse Message
- Response parameters
-
Table 2 Response parameters Parameter
+ +Response
+-Table 2 Response parameters Parameter
Type
+Type
Description
+Description
total_number
+total_number
Integer
+Integer
Specifies the total number of query records.
+Specifies the total number of query records.
start_number
+start_number
Integer
+Integer
Specifies the start number of query records.
+Specifies the start number of query records.
limit
+limit
Integer
+Integer
Specifies the number of query records.
+Specifies the number of query records.
scaling_groups
+scaling_groups
Array of scaling_groups objects
+Array of scaling_groups objects
Specifies the AS group list.
+Specifies the AS group list.
Table 3 scaling_groups field description Parameter
+-Table 3 scaling_groups field description Parameter
Type
+Type
Description
+Description
scaling_group_name
+scaling_group_name
String
+String
Specifies the name of the AS group.
+Specifies the name of the AS group.
scaling_group_id
+scaling_group_id
String
+String
Specifies the AS group ID.
+Specifies the AS group ID.
scaling_group_status
+scaling_group_status
String
+String
Specifies the AS group status.
+Specifies the AS group status.
scaling_configuration_id
+scaling_configuration_id
String
+String
Specifies the AS configuration ID.
+Specifies the AS configuration ID.
scaling_configuration_name
+scaling_configuration_name
String
+String
Specifies the AS configuration name.
+Specifies the AS configuration name.
current_instance_number
+current_instance_number
Integer
+Integer
Specifies the number of current instances in the AS group.
+Specifies the number of current instances in the AS group.
desire_instance_number
+desire_instance_number
Integer
+Integer
Specifies the expected number of instances in the AS group.
+Specifies the expected number of instances in the AS group.
min_instance_number
+min_instance_number
Integer
+Integer
Specifies the minimum number of instances in the AS group.
+Specifies the minimum number of instances in the AS group.
max_instance_number
+max_instance_number
Integer
+Integer
Specifies the maximum number of instances in the AS group.
+Specifies the maximum number of instances in the AS group.
cool_down_time
+cool_down_time
Integer
+Integer
Specifies the cooldown period (s).
+Specifies the cooldown period (s).
lb_listener_id
+lb_listener_id
String
+String
Specifies the ID of a typical ELB listener. ELB listener IDs are separated using a comma (,).
+Specifies the ID of a typical ELB listener. ELB listener IDs are separated using a comma (,).
lbaas_listeners
+lbaas_listeners
Array of lbaas_listeners objects
+Array of lbaas_listeners objects
Specifies enhanced load balancers. For details, see Table 4.
+Specifies enhanced load balancers. For details, see Table 4.
available_zones
+available_zones
Array of strings
+Array of strings
Specifies the AZ information.
+Specifies the AZ information.
networks
+networks
Array of networks objects
+Array of networks objects
Specifies the network information. For details, see Table 5.
+Specifies the network information. For details, see Table 5.
security_groups
+security_groups
Array of security_groups objects
+Array of security_groups objects
Specifies the security group information. For details, see Table 6.
+Specifies the security group information. For details, see Table 7.
create_time
+create_time
String
+String
Specifies the time when an AS group was created. The time format complies with UTC.
+Specifies the time when an AS group was created. The time format complies with UTC.
vpc_id
+vpc_id
String
+String
Specifies the ID of the VPC to which the AS group belongs.
+Specifies the ID of the VPC to which the AS group belongs.
detail
+detail
String
+String
Specifies details about the AS group. If a scaling action fails, this parameter is used to record errors.
+Specifies details about the AS group. If a scaling action fails, this parameter is used to record errors.
is_scaling
+is_scaling
Boolean
+Boolean
Specifies the scaling flag of the AS group.
+Specifies the scaling flag of the AS group.
health_periodic_audit_method
+health_periodic_audit_method
String
+String
Specifies the health check method.
+Specifies the health check method.
health_periodic_audit_time
+health_periodic_audit_time
Integer
+Integer
Specifies the health check interval.
+Specifies the health check interval.
health_periodic_audit_grace_period
+health_periodic_audit_grace_period
Integer
+Integer
Specifies the grace period for health check.
+Specifies the grace period for health check.
instance_terminate_policy
+instance_terminate_policy
String
+String
Specifies the instance removal policy.
+Specifies the instance removal policy.
notifications
+notifications
Array of strings
+Array of strings
Specifies the notification mode.
+Specifies the notification mode.
EMAIL refers to notification by email.
delete_publicip
+delete_publicip
Boolean
+Boolean
Specifies whether to delete the EIP bound to the ECS when deleting the ECS.
+Specifies whether to delete the EIP bound to the ECS when deleting the ECS.
delete_volume
+delete_volume
Boolean
+Boolean
Specifies whether to delete the data disks attached to the ECS when deleting the ECS.
+Specifies whether to delete the data disks attached to the ECS when deleting the ECS.
cloud_location_id
+cloud_location_id
String
+String
This parameter is reserved.
+This parameter is reserved.
enterprise_project_id
+enterprise_project_id
String
+String
Specifies the enterprise project ID.
+Specifies the enterprise project ID.
activity_type
+activity_type
String
+String
Specifies the type of the AS action.
+Specifies the type of the AS action.
multi_az_priority_policy
+multi_az_priority_policy
String
+String
Specifies the priority policy used to select target AZs when adjusting the number of instances in an AS group.
+Specifies the priority policy used to select target AZs when adjusting the number of instances in an AS group.
description
+description
String
+String
Specifies the description of the AS group.
+Specifies the description of the AS group.
Table 4 lbaas_listeners field description Parameter
+-Table 4 lbaas_listeners field description Parameter
Type
+Type
Description
+Description
listener_id
+listener_id
String
+String
Specifies the listener ID.
+Specifies the listener ID.
pool_id
+pool_id
String
+String
Specifies the backend ECS group ID.
+Specifies the backend ECS group ID.
protocol_port
+protocol_port
Integer
+Integer
Specifies the backend protocol ID, which is the port on which a backend ECS listens for traffic.
+Specifies the backend protocol port, which is the port on which a backend ECS listens for traffic.
weight
+weight
Integer
+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.
+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.
Table 5 networks field description Parameter
++ +
+Table 5 networks field description Parameter
Type
+Type
Description
+Description
id
+id
String
+String
Specifies the subnet ID.
+Specifies the subnet ID.
+ipv6_enable
+Boolean
+Specifies whether to support IPv6 addresses. If this parameter is set to true, the NIC supports IPv6 addresses. The default value is false. This parameter is reserved.
+ipv6_bandwidth
+ipv6_bandwidth object
+Specifies the shared bandwidth of an IPv6 address. This parameter is left blank by default, indicating that no IPv6 shared bandwidth is bound. This parameter is reserved.
+Table 6 ipv6_bandwidth field description Parameter
+Type
+Description
+id
+String
+Specifies the ID of the shared bandwidth of an IPv6 address. This parameter is reserved.
Table 6 security_groups field description Parameter
+- -Table 7 security_groups field description Parameter
Type
+Type
Description
+Description
id
+id
String
+String
Specifies the security group ID.
+Specifies the security group ID.
- Example response
{ + +Example Response
{ "limit": 20, "scaling_groups": [ { "networks": [ { "id": "a8327883-6b07-4497-9c61-68d03ee193a", - "ipv6_enable": false, - "ipv6_bandwidth": null + "ipv6_enable": true, + "ipv6_bandwidth": + { + "id": "076ee2ff-f23e-4338-b8ac-1bc7278532d5" + } } ], "available_zones": [ @@ -485,91 +521,90 @@ "notifications": [ "EMAIL" ], - "enterprise_project_id": "c92b1a5d-6f20-43f2-b1b7-7ce35e58e413", + "enterprise_project_id": "c92b1a5d-6f20-43f2-b1b7-7ce35e58e413", "multi_az_priority_policy": "PICK_FIRST" } ], "total_number": 1, "start_number": 0 }-Returned Values
- Normal
- Abnormal
-
Returned Value
+-Returned Value
Description
+Description
400 Bad Request
+400 Bad Request
The server failed to process the request.
+The server failed to process the request.
401 Unauthorized
+401 Unauthorized
You must enter the username and password to access the requested page.
+You must enter the username and password to access the requested page.
403 Forbidden
+403 Forbidden
You are forbidden to access the requested page.
+You are forbidden to access the requested page.
404 Not Found
+404 Not Found
The server could not find the requested page.
+The server could not find the requested page.
405 Method Not Allowed
+405 Method Not Allowed
You are not allowed to use the method specified in the request.
+You are not allowed to use the method specified in the request.
406 Not Acceptable
+406 Not Acceptable
The response generated by the server could not be accepted by the client.
+The response generated by the server could not be accepted by the client.
407 Proxy Authentication Required
+407 Proxy Authentication Required
You must use the proxy server for authentication to process the request.
+You must use the proxy server for authentication to process the request.
408 Request Timeout
+408 Request Timeout
The request timed out.
+The request timed out.
409 Conflict
+409 Conflict
The request could not be processed due to a conflict.
+The request could not be processed due to a conflict.
500 Internal Server Error
+500 Internal Server Error
Failed to complete the request because of an internal service error.
+Failed to complete the request because of an internal service error.
501 Not Implemented
+501 Not Implemented
Failed to complete the request because the server does not support the requested function.
+Failed to complete the request because the server does not support the requested function.
502 Bad Gateway
+502 Bad Gateway
Failed to complete the request because the request is invalid.
+Failed to complete the request because the request is invalid.
503 Service Unavailable
+503 Service Unavailable
Failed to complete the request because the system is unavailable.
+Failed to complete the request because the system is unavailable.
504 Gateway Timeout
+504 Gateway Timeout
A gateway timeout error occurred.
+A gateway timeout error occurred.
Request Message
- Request parameters -
- Example request
This example shows how to query details about the AS group with ID d4e50321-3777-4135-97f8-9f5e9714a4b0.
-GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group/d4e50321-3777-4135-97f8-9f5e9714a4b0-
-Request
None
Response Message
- Response parameters
-
Table 2 Response parameters Parameter
++Example Request
This example queries the details about the AS group with ID d4e50321-3777-4135-97f8-9f5e9714a4b0.
+GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group/d4e50321-3777-4135-97f8-9f5e9714a4b0+Response
+-Table 2 Response parameters Parameter
Type
+Type
Description
+Description
scaling_group
+scaling_group
scaling_groups object
+scaling_groups object
Specifies details about the AS group.
+Specifies details about the AS group.
Table 3 scaling_groups field description Parameter
+-Table 3 scaling_groups field description Parameter
Type
+Type
Description
+Description
scaling_group_name
+scaling_group_name
String
+String
Specifies the name of the AS group.
+Specifies the name of the AS group.
scaling_group_id
+scaling_group_id
String
+String
Specifies the AS group ID.
+Specifies the AS group ID.
scaling_group_status
+scaling_group_status
String
+String
Specifies the AS group status.
+Specifies the AS group status.
scaling_configuration_id
+scaling_configuration_id
String
+String
Specifies the AS configuration ID.
+Specifies the AS configuration ID.
scaling_configuration_name
+scaling_configuration_name
String
+String
Specifies the AS configuration name.
+Specifies the AS configuration name.
current_instance_number
+current_instance_number
Integer
+Integer
Specifies the number of current instances in the AS group.
+Specifies the number of current instances in the AS group.
desire_instance_number
+desire_instance_number
Integer
+Integer
Specifies the expected number of instances in the AS group.
+Specifies the expected number of instances in the AS group.
min_instance_number
+min_instance_number
Integer
+Integer
Specifies the minimum number of instances in the AS group.
+Specifies the minimum number of instances in the AS group.
max_instance_number
+max_instance_number
Integer
+Integer
Specifies the maximum number of instances in the AS group.
+Specifies the maximum number of instances in the AS group.
cool_down_time
+cool_down_time
Integer
+Integer
Specifies the cooldown period (s).
+Specifies the cooldown period (s).
lb_listener_id
+lb_listener_id
String
+String
Specifies the ID of a typical ELB listener. ELB listener IDs are separated using a comma (,).
+Specifies the ID of a typical ELB listener. ELB listener IDs are separated using a comma (,).
lbaas_listeners
+lbaas_listeners
Array of lbaas_listeners objects
+Array of lbaas_listeners objects
Specifies enhanced load balancers. For details, see Table 4.
+Specifies enhanced load balancers. For details, see Table 4.
available_zones
+available_zones
Array of strings
+Array of strings
Specifies the AZ information.
+Specifies the AZ information.
networks
+networks
Array of networks objects
+Array of networks objects
Specifies the network information. For details, see Table 5.
+Specifies the network information. For details, see Table 5.
security_groups
+security_groups
Array of security_groups objects
+Array of security_groups objects
Specifies the security group information. For details, see Table 6.
+Specifies the security group information. For details, see Table 7.
create_time
+create_time
String
+String
Specifies the time when an AS group was created. The time format complies with UTC.
+Specifies the time when an AS group was created. The time format complies with UTC.
vpc_id
+vpc_id
String
+String
Specifies the ID of the VPC to which the AS group belongs.
+Specifies the ID of the VPC to which the AS group belongs.
detail
+detail
String
+String
Specifies details about the AS group. If a scaling action fails, this parameter is used to record errors.
+Specifies details about the AS group. If a scaling action fails, this parameter is used to record errors.
is_scaling
+is_scaling
Boolean
+Boolean
Specifies the scaling flag of the AS group.
+Specifies the scaling flag of the AS group.
health_periodic_audit_method
+health_periodic_audit_method
String
+String
Specifies the health check method.
+Specifies the health check method.
health_periodic_audit_time
+health_periodic_audit_time
Integer
+Integer
Specifies the health check interval.
+Specifies the health check interval.
health_periodic_audit_grace_period
+health_periodic_audit_grace_period
Integer
+Integer
Specifies the grace period for health check.
+Specifies the grace period for health check.
instance_terminate_policy
+instance_terminate_policy
String
+String
Specifies the instance removal policy.
+Specifies the instance removal policy.
notifications
+notifications
Array of strings
+Array of strings
Specifies the notification mode.
+Specifies the notification mode.
EMAIL refers to notification by email.
delete_publicip
+delete_publicip
Boolean
+Boolean
Specifies whether to delete the EIP bound to the ECS when deleting the ECS.
+Specifies whether to delete the EIP bound to the ECS when deleting the ECS.
delete_volume
+delete_volume
Boolean
+Boolean
Specifies whether to delete the data disks attached to the ECS when deleting the ECS.
+Specifies whether to delete the data disks attached to the ECS when deleting the ECS.
cloud_location_id
+cloud_location_id
String
+String
This parameter is reserved.
+This parameter is reserved.
enterprise_project_id
+enterprise_project_id
String
+String
Specifies the enterprise project ID.
+Specifies the enterprise project ID.
activity_type
+activity_type
String
+String
Specifies the type of the AS action.
+Specifies the type of the AS action.
multi_az_priority_policy
+multi_az_priority_policy
String
+String
Specifies the priority policy used to select target AZs when adjusting the number of instances in an AS group.
+Specifies the priority policy used to select target AZs when adjusting the number of instances in an AS group.
description
+description
String
+String
Specifies the description of the AS group.
+Specifies the description of the AS group.
Table 4 lbaas_listeners field description Parameter
+-Table 4 lbaas_listeners field description Parameter
Type
+Type
Description
+Description
listener_id
+listener_id
String
+String
Specifies the listener ID.
+Specifies the listener ID.
pool_id
+pool_id
String
+String
Specifies the backend ECS group ID.
+Specifies the backend ECS group ID.
protocol_port
+protocol_port
Integer
+Integer
Specifies the backend protocol ID, which is the port on which a backend ECS listens for traffic.
+Specifies the backend protocol port, which is the port on which a backend ECS listens for traffic.
weight
+weight
Integer
+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.
+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.
Table 5 networks field description Parameter
+- -Table 5 networks field description Parameter
Type
+Type
Description
+Description
id
+id
String
+String
Specifies the subnet ID.
+Specifies the subnet ID.
+ipv6_enable
+Boolean
+Specifies whether to support IPv6 addresses. If this parameter is set to true, the NIC supports IPv6 addresses. The default value is false. This parameter is reserved.
+ipv6_bandwidth
+ipv6_bandwidth object
+Specifies the shared bandwidth of an IPv6 address. This parameter is left blank by default, indicating that no IPv6 shared bandwidth is bound. This parameter is reserved.
- Example response
{ + ++ +
+Table 6 ipv6_bandwidth field description Parameter
+Type
+Description
+id
+String
+Specifies the ID of the shared bandwidth of an IPv6 address. This parameter is reserved.
+Example Response
{ "scaling_group": { "networks": [ { "id": " a8327883-6b07-4497-9c61-68d03ee193a ", - "ipv6_enable": false, - "ipv6_bandwidth": null, + "ipv6_enable": true, + "ipv6_bandwidth": + { + "id": "076ee2ff-f23e-4338-b8ac-1bc7278532d5" + } } ], "available_zones": [ @@ -390,90 +426,88 @@ "is_scaling": true, "delete_publicip": false, "notifications": null, - "enterprise_project_id": "c92b1a5d-6f20-43f2-b1b7-7ce35e58e413", - "activity_type": "MODIFY_ELB", - "multi_az_priority_policy": "PICK_FIRST" - + "enterprise_project_id":"c92b1a5d-6f20-43f2-b1b7-7ce35e58e413", + "activity_type":"MODIFY_ELB", + "multi_az_priority_policy":"PICK_FIRST" } }-Returned Values
- Normal
- Abnormal
-
Returned Value
+-Returned Value
Description
+Description
400 Bad Request
+400 Bad Request
The server failed to process the request.
+The server failed to process the request.
401 Unauthorized
+401 Unauthorized
You must enter the username and password to access the requested page.
+You must enter the username and password to access the requested page.
403 Forbidden
+403 Forbidden
You are forbidden to access the requested page.
+You are forbidden to access the requested page.
404 Not Found
+404 Not Found
The server could not find the requested page.
+The server could not find the requested page.
405 Method Not Allowed
+405 Method Not Allowed
You are not allowed to use the method specified in the request.
+You are not allowed to use the method specified in the request.
406 Not Acceptable
+406 Not Acceptable
The response generated by the server could not be accepted by the client.
+The response generated by the server could not be accepted by the client.
407 Proxy Authentication Required
+407 Proxy Authentication Required
You must use the proxy server for authentication to process the request.
+You must use the proxy server for authentication to process the request.
408 Request Timeout
+408 Request Timeout
The request timed out.
+The request timed out.
409 Conflict
+409 Conflict
The request could not be processed due to a conflict.
+The request could not be processed due to a conflict.
500 Internal Server Error
+500 Internal Server Error
Failed to complete the request because of an internal service error.
+Failed to complete the request because of an internal service error.
501 Not Implemented
+501 Not Implemented
Failed to complete the request because the server does not support the requested function.
+Failed to complete the request because the server does not support the requested function.
502 Bad Gateway
+502 Bad Gateway
Failed to complete the request because the request is invalid.
+Failed to complete the request because the request is invalid.
503 Service Unavailable
+503 Service Unavailable
Failed to complete the request because the system is unavailable.
+Failed to complete the request because the system is unavailable.
504 Gateway Timeout
+504 Gateway Timeout
A gateway timeout error occurred.
+A gateway timeout error occurred.
Request Message
- Request parameters
-
Table 2 Request parameters Parameter
+Request Parameters
+-Table 2 Request parameters Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
scaling_group_name
+scaling_group_name
No
+No
String
+String
Specifies the AS group name. The name contains only letters, digits, underscores (_), and hyphens (-), and cannot exceed 64 characters.
+Specifies the AS group name. The name contains only letters, digits, underscores (_), and hyphens (-), and cannot exceed 64 characters.
desire_instance_number
+desire_instance_number
No
+No
Integer
+Integer
Specifies the expected number of instances.
+Specifies the expected number of instances.
The value ranges from the minimum number of instances to the maximum number of instances.
min_instance_number
+min_instance_number
No
+No
Integer
+Integer
Specifies the minimum number of instances.
+Specifies the minimum number of instances.
max_instance_number
+max_instance_number
No
+No
Integer
+Integer
Specifies the maximum number of instances, which is greater than or equal to the minimum number of instances.
+Specifies the maximum number of instances, which is greater than or equal to the minimum number of instances.
cool_down_time
+cool_down_time
No
+No
Integer
+Integer
Specifies the cooldown period (in seconds). The value ranges from 0 to 86400 and is 300 by default.
+Specifies the cooldown period (in seconds). The value ranges from 0 to 86400 and is 300 by default.
available_zones
+available_zones
No
+No
Array of strings
+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.
+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
+networks
No
+No
Array of networks objects
+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.
+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
+security_groups
No
+No
Array of security_groups objects
+Array of security_groups objects
Specifies the security group. A maximum of one security group can be selected. For information about the data structure, see Table 5.
-If the 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 the 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:
+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
+lb_listener_id
No
+No
String
+String
Specifies the ID of a classic load balancer listener. The system supports the binding of up to six load balancer listeners, the IDs of which are separated using a comma (,).
+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
+lbaas_listeners
No
+No
Array of lbaas_listeners objects
+Array of lbaas_listeners objects
Specifies information about an enhanced load balancer. The system supports the binding of up to six load balancers. This parameter is in list data structure. For details, see Table 3.
+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
+health_periodic_audit_method
No
+No
String
+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.
+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
+health_periodic_audit_time
No
+No
Integer
+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.
+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
+instance_terminate_policy
No
+No
String
+String
Specifies the instance removal policy.
+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
+health_periodic_audit_grace_period
No
+No
Integer
+Integer
Specifies the grace period for instance health check. The unit is second and value range is 0-86400. The default value is 600.
+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
+scaling_configuration_id
No
+No
String
+String
Specifies the AS configuration ID, which can be obtained using the API for querying AS configurations. For details, see Querying AS configurations.
+Specifies the AS configuration ID, which can be obtained using the API for querying AS configurations. For details, see Querying AS configurations.
notifications
+notifications
No
+No
Array of strings
+Array of strings
Specifies the notification mode.
+Specifies the notification mode.
EMAIL refers to notification by email.
delete_publicip
+delete_publicip
No
+No
Boolean
+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.
+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
+delete_volume
No
+No
Boolean
+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.
+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
+enterprise_project_id
No
+No
String
+String
Specifies the enterprise project ID, which is used to specify the enterprise project to which the AS group belongs.
+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
+multi_az_priority_policy
No
+No
String
+String
Specifies the priority policy used to select target AZs when adjusting the number of instances in an AS group.
+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
+description
No
+No
String
+String
Specifies the description of the AS group. The value can contain 1 to 256 characters.
+Specifies the description of the AS group. The value can contain 1 to 256 characters.
Table 3 lbaas_listeners field description Parameter
+-Table 3 lbaas_listeners field description Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
pool_id
+pool_id
Yes
+Yes
String
+String
Specifies the backend ECS group ID.
+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
+protocol_port
Yes
+Yes
Integer
+Integer
Specifies the backend protocol ID, which is the port on which a backend ECS listens for traffic. The port ID ranges from 1 to 65535.
+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
+weight
Yes
+Yes
Integer
+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.
+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
+-Table 4 networks field description Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
id
+id
Yes
+Yes
String
+String
Specifies the subnet ID.
+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
+- -Table 5 security_groups field description Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
id
+id
Yes
+Yes
String
+String
Specifies the ID of the security group.
+Specifies the ID of the security group.
- Example requestThis example shows how to change 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 +-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", @@ -363,112 +383,110 @@ "max_instance_number": 3, "cool_down_time": 200, "multi_az_priority_policy": "PICK_FIRST" - + }Response Message
- Response parameters
-
Table 6 Response parameters Parameter
++Response parameters
+- -Table 6 Response parameters Parameter
Type
+Type
Description
+Description
scaling_group_id
+scaling_group_id
String
+String
Specifies the AS group ID.
+Specifies the AS group ID.
- Example response
{ +
Example Response
{ "scaling_group_id": "a8327883-6b07-4497-9c61-68d03ee193a1" }-Returned Values
- Normal
- Abnormal
-
Returned Value
+-Returned Value
Description
+Description
400 Bad Request
+400 Bad Request
The server failed to process the request.
+The server failed to process the request.
401 Unauthorized
+401 Unauthorized
You must enter the username and password to access the requested page.
+You must enter the username and password to access the requested page.
403 Forbidden
+403 Forbidden
You are forbidden to access the requested page.
+You are forbidden to access the requested page.
404 Not Found
+404 Not Found
The server could not find the requested page.
+The server could not find the requested page.
405 Method Not Allowed
+405 Method Not Allowed
You are not allowed to use the method specified in the request.
+You are not allowed to use the method specified in the request.
406 Not Acceptable
+406 Not Acceptable
The response generated by the server could not be accepted by the client.
+The response generated by the server could not be accepted by the client.
407 Proxy Authentication Required
+407 Proxy Authentication Required
You must use the proxy server for authentication to process the request.
+You must use the proxy server for authentication to process the request.
408 Request Timeout
+408 Request Timeout
The request timed out.
+The request timed out.
409 Conflict
+409 Conflict
The request could not be processed due to a conflict.
+The request could not be processed due to a conflict.
500 Internal Server Error
+500 Internal Server Error
Failed to complete the request because of an internal service error.
+Failed to complete the request because of an internal service error.
501 Not Implemented
+501 Not Implemented
Failed to complete the request because the server does not support the requested function.
+Failed to complete the request because the server does not support the requested function.
502 Bad Gateway
+502 Bad Gateway
Failed to complete the request because the request is invalid.
+Failed to complete the request because the request is invalid.
503 Service Unavailable
+503 Service Unavailable
Failed to complete the request because the system is unavailable.
+Failed to complete the request because the system is unavailable.
504 Gateway Timeout
+504 Gateway Timeout
A gateway timeout error occurred.
+A gateway timeout error occurred.
Function
This interface is used to delete a specified AS group.
- force_delete specifies whether to forcibly delete an AS group, remove the ECS instances and release them when the AS group is running instances or performing scaling actions. By default, its value is no, which means not to forcibly delete the AS group.
- If the value of force_delete is set to no, the AS group can be deleted only when both the following conditions are met:
- The AS group is performing no scaling action.
- The number of running ECS instances (current_instance_number) is 0.
- If the value of force_delete is set to yes, the AS group enters the DELETING state, rejecting new requests for scaling actions while completing the existing scaling actions. Then, all ECS instances are removed from the AS group and the AS group is deleted. Note that the manually added ECS instances will be removed from the AS group and the ECS instances automatically created by AS will be automatically deleted.
- If the value of force_delete is set to yes, the AS group enters the DELETING state, rejecting new requests for scaling actions while completing the existing scaling actions. Then, all ECS instances are removed from the AS group and the AS group is deleted. Note that the manually added ECS instances will be removed from the AS group and the ECS instances automatically created by AS will be automatically deleted.+
Forcibly deleting an AS group may not delete ECS instances in the group.
+
URI
DELETE /autoscaling-api/v1/{project_id}/scaling_group/{scaling_group_id}
@@ -50,91 +52,91 @@Request Message
- Request parameters -
- Example request
This example shows how to forcibly delete the AS group with ID a8327883-6b07-4497-9c61-68d03ee193a1.
-DELETE https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group/a8327883-6b07-4497-9c61-68d03ee193a1?force_delete=yes-
-Request
None
Response Message
++Example Request
This example deletes the AS group with ID a8327883-6b07-4497-9c61-68d03ee193a1.
+DELETE https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group/a8327883-6b07-4497-9c61-68d03ee193a1?force_delete=yes++Response
None
+Example Response
None
Returned Values
- Normal
- Abnormal
-
Returned Value
+-Returned Value
Description
+Description
400 Bad Request
+400 Bad Request
The server failed to process the request.
+The server failed to process the request.
401 Unauthorized
+401 Unauthorized
You must enter the username and password to access the requested page.
+You must enter the username and password to access the requested page.
403 Forbidden
+403 Forbidden
You are forbidden to access the requested page.
+You are forbidden to access the requested page.
404 Not Found
+404 Not Found
The server could not find the requested page.
+The server could not find the requested page.
405 Method Not Allowed
+405 Method Not Allowed
You are not allowed to use the method specified in the request.
+You are not allowed to use the method specified in the request.
406 Not Acceptable
+406 Not Acceptable
The response generated by the server could not be accepted by the client.
+The response generated by the server could not be accepted by the client.
407 Proxy Authentication Required
+407 Proxy Authentication Required
You must use the proxy server for authentication to process the request.
+You must use the proxy server for authentication to process the request.
408 Request Timeout
+408 Request Timeout
The request timed out.
+The request timed out.
409 Conflict
+409 Conflict
The request could not be processed due to a conflict.
+The request could not be processed due to a conflict.
500 Internal Server Error
+500 Internal Server Error
Failed to complete the request because of an internal service error.
+Failed to complete the request because of an internal service error.
501 Not Implemented
+501 Not Implemented
Failed to complete the request because the server does not support the requested function.
+Failed to complete the request because the server does not support the requested function.
502 Bad Gateway
+502 Bad Gateway
Failed to complete the request because the request is invalid.
+Failed to complete the request because the request is invalid.
503 Service Unavailable
+503 Service Unavailable
Failed to complete the request because the system is unavailable.
+Failed to complete the request because the system is unavailable.
504 Gateway Timeout
+504 Gateway Timeout
A gateway timeout error occurred.
+A gateway timeout error occurred.
Request Message
- Request parameters
-
Table 2 Request parameters Parameter
+-Request
+- -Table 2 Request parameters Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
action
+action
Yes
+Yes
String
+String
Specifies a flag for enabling or disabling an AS group.
+Specifies a flag for enabling or disabling an AS group.
- resume: enables the AS group.
- pause: disables the AS group.
- Example requestThis example shows how to enable the AS group with ID a8327883-6b07-4497-9c61-68d03ee193a1.+
POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group/a8327883-6b07-4497-9c61-68d03ee193a1/action ++Example Request
- This example enables the AS group with ID a8327883-6b07-4497-9c61-68d03ee193a1.
POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group/a8327883-6b07-4497-9c61-68d03ee193a1/action { "action": "resume" }-
- This example enables the AS group with ID a8327883-6b07-4497-9c61-68d03ee193a1.
- This example disables the AS group with ID a8327883-6b07-4497-9c61-68d03ee193a1.
POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group/a8327883-6b07-4497-9c61-68d03ee193a1/action + +{ + "action": "pause" +}
Response Message
++Response
None
+Example Response
None
Returned Values
- Normal
- Abnormal
-
Returned Value
+-Returned Value
Description
+Description
400 Bad Request
+400 Bad Request
The server failed to process the request.
+The server failed to process the request.
401 Unauthorized
+401 Unauthorized
You must enter the username and password to access the requested page.
+You must enter the username and password to access the requested page.
403 Forbidden
+403 Forbidden
You are forbidden to access the requested page.
+You are forbidden to access the requested page.
404 Not Found
+404 Not Found
The server could not find the requested page.
+The server could not find the requested page.
405 Method Not Allowed
+405 Method Not Allowed
You are not allowed to use the method specified in the request.
+You are not allowed to use the method specified in the request.
406 Not Acceptable
+406 Not Acceptable
The response generated by the server could not be accepted by the client.
+The response generated by the server could not be accepted by the client.
407 Proxy Authentication Required
+407 Proxy Authentication Required
You must use the proxy server for authentication to process the request.
+You must use the proxy server for authentication to process the request.
408 Request Timeout
+408 Request Timeout
The request timed out.
+The request timed out.
409 Conflict
+409 Conflict
The request could not be processed due to a conflict.
+The request could not be processed due to a conflict.
500 Internal Server Error
+500 Internal Server Error
Failed to complete the request because of an internal service error.
+Failed to complete the request because of an internal service error.
501 Not Implemented
+501 Not Implemented
Failed to complete the request because the server does not support the requested function.
+Failed to complete the request because the server does not support the requested function.
502 Bad Gateway
+502 Bad Gateway
Failed to complete the request because the request is invalid.
+Failed to complete the request because the request is invalid.
503 Service Unavailable
+503 Service Unavailable
Failed to complete the request because the system is unavailable.
+Failed to complete the request because the system is unavailable.
504 Gateway Timeout
+504 Gateway Timeout
A gateway timeout error occurred.
+A gateway timeout error occurred.
Request Message
- Request parameters
-
Table 2 Request parameters Parameter
+Request
+- -Table 2 Request parameters Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
scaling_configuration_name
+scaling_configuration_name
Yes
+No
String
+String
Specifies the AS configuration name. The name contains only letters, digits, underscores (_), and hyphens (-), and cannot exceed 64 characters.
+Specifies the AS configuration name. The name contains only letters, digits, underscores (_), and hyphens (-), and cannot exceed 64 characters.
instance_config
+instance_config
Yes
+No
Object
+Object
Specifies the ECS configuration. For details, see Table 3.
+Specifies the ECS configuration. For details, see Table 3.
+source_scaling_configuration_id
+No
+String
+Specifies the ID of the source AS configuration, which will be used together with instance_config to create a new AS configuration.
+NOTE:- If instance_id is specified in instance_config, instance_id is preferentially used to create the new AS configuration, and source_scaling_configuration_id does not take effect.
- If instance_id is not specified in instance_config, source_scaling_configuration_id and instance_config are used together to create the new AS configuration.
- If a parameter in instance_config is set to null, the corresponding setting of the source AS configuration takes effect.
- If a parameter in instance_config is not set to null or left empty, this parameter overwrites the corresponding setting of the source AS configuration.
- If source_scaling_configuration_id is not specified, scaling_configuration_name and instance_config are mandatory.
Table 3 instance_config field description Parameter
++-+Table 3 instance_config field description Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
instance_id
+instance_id
No
+No
String
+String
Specifies the ECS ID. When you want to create an AS configuration from an ECS, specify this parameter. In this case, the flavorRef, imageRef, disk, and security_groups fields do not take effect.
+Specifies the ECS ID. When you want to create an AS configuration from an ECS, specify this parameter. In this case, the flavorRef, imageRef, disk, and security_groups fields do not take effect.
If the instance_id field is not specified, flavorRef, imageRef, and disk fields are mandatory.
flavorRef
+flavorRef
No
+No
String
+String
Specifies the ECS flavor ID. A maximum of 10 flavors can be selected. Use a comma (,) to separate multiple flavor IDs. You can obtain an ECS flavor ID from the API for querying details about flavors and extended flavor information.
+Specifies the ECS flavor ID. A maximum of 10 flavors can be selected. Use a comma (,) to separate multiple flavor IDs. You can obtain an ECS flavor ID from the API for querying details about flavors and extended flavor information.
imageRef
+imageRef
No
+No
String
+String
Specifies the image ID. Its value is the same as that of image_id for specifying the image selected during ECS creation. You can obtain an image ID by calling the IMS API for querying images.
+Specifies the image ID. Its value is the same as that of image_id for specifying the image selected during ECS creation. You can obtain an image ID by calling the IMS API for querying images.
disk
+disk
No
+No
Array of disk objects
+Array of disk objects
Specifies the disk group information. System disks are mandatory and data disks are optional. For details, see Table 4.
+Specifies the disk group information. System disks are mandatory and data disks are optional. For details, see Table 4.
key_name
+key_name
Yes
+Yes
String
+String
Specifies the name of the SSH key pair used to log in to the ECS.
+Specifies the name of the SSH key pair used to log in to the ECS.
personality
+personality
No
+No
Array of personality objects
+Array of personality objects
Specifies information about the injected file. Only text files can be injected. A maximum of five files can be injected at a time and the maximum size of each file is 1 KB. For details, see Table 6.
+Specifies information about the injected file. Only text files can be injected. A maximum of five files can be injected at a time and the maximum size of each file is 1 KB. For details, see Table 6.
public_ip
+public_ip
No
+No
public_ip object
+public_ip object
Specifies the EIP of the ECS. The EIP can be configured in two ways. For details, see Table 7.
+Specifies the EIP of the ECS. The EIP can be configured in two ways. For details, see Table 7.
- Do not use an EIP. In this case, this parameter is unavailable.
- Automatically assign an EIP. You need to specify the information about the new EIP.
user_data
+user_data
No
+No
String
+String
Specifies the user data to be injected during the ECS creation process. Text, text files, and gzip files can be injected.
+Specifies the user data to be injected during the ECS creation process. Text, text files, and gzip files can be injected.
Constraints:
- The content to be injected must be encoded with base64. The maximum size of the content to be injected (before encoding) is 32 KB.
Examples:
@@ -154,158 +166,151 @@ echo 111 > c:\aaa.txtmetadata
+metadata
No
+No
metadata object
+metadata object
Specifies the ECS metadata. For details, see Table 10.
+Specifies the ECS metadata. For details, see Table 10.
security_groups
+security_groups
No
+No
Array of security_groups objects
+Array of security_groups objects
Specifies security groups. For details, see Table 11.
-If the 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 the 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.
+Specifies security groups. For details, see Table 11.
+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.
market_type
+market_type
No
+No
String
+String
This parameter is reserved.
+This parameter is reserved.
Table 4 disk field description Parameter
+-Table 4 disk field description Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
size
+size
Yes
+Yes
Integer
+Integer
Specifies the disk size. The unit is GB.
+Specifies the disk size. The unit is GB.
The system disk size ranges from 1 to 1024 and must be greater than or equal to the minimum size (min_disk value) of the system disk specified in the image.
The data disk size ranges from 10 to 32768.
volume_type
+volume_type
Yes
+Yes
String
+String
Specifies the ECS system disk type. The disk type must match the available disk type.
-- SATA: common I/O disk type
- SAS: high I/O disk type
- SSD: ultra-high I/O disk type
- co-p1: high I/O (performance-optimized I) disk type
- uh-l1: ultra-high I/O (latency-optimized) disk type
Specifies the ECS system disk type. The disk type must match the available disk type.
+The value can be SSD, SAS, SATA, or ESSD.- SSD: the ultra-high I/O type
- SAS: the high I/O type
- SATA: the common I/O type
- co-p1: the high I/O (performance-optimized I) type
- uh-l1: the ultra-high I/O (latency-optimized) type
- ESSD: the extreme SSD type
If the specified disk type is not available in the AZ, the disk will fail to create.
-NOTE:For HANA, HL1, and HL2 ECSs, use co-p1 and uh-l1 disks. For other ECSs, do not use co-p1 or uh-l1 disks.
- +NOTE:- When the disk is created from a backup:
If the type of the backup's source disk is SSD, SAS, or SATA, you can create any types of disks.
+If the type of the backup's source disk is co-p1 or uh-l1, you can create disks of any of the two types.
+ - For details about disk types, see Disk Types and Performance in the Elastic Volume Service User Guide.
disk_type
++ -disk_type
Yes
+Yes
String
+String
Specifies a disk type. The options are as follows:
+Specifies a disk type. The options are as follows:
- DATA: indicates a data disk.
- SYS: indicates a system disk.NOTE:
System disk encryption is not supported.
dedicated_storage_id
+data_disk_image_id
No
+No
String
+String
Specifies a DSS device ID for creating an ECS disk.
-NOTE:+Specify DSS devices for all disks in an AS configuration or not. If DSS devices are specified, all the data stores must belong to the same AZ, and the disk types supported by a DSS device for a disk must be the same as the volume_type value.
-Specifies the ID of a data disk image used to export data disks of an ECS.
data_disk_image_id
+snapshot_id
No
+No
String
+String
Specifies the ID of a data disk image used to export data disks of an ECS.
-snapshot_id
-No
-String
-Specifies the disk backup snapshot ID for restoring the system disk and data disks using a full-ECS backup when a full-ECS image is used.
+Specifies the disk backup snapshot ID for restoring the system disk and data disks using a full-ECS backup when a full-ECS image is used.
NOTE:Each disk in an AS configuration must correspond to a disk backup in the full-ECS backup by snapshot_id.
metadata
+metadata
No
+No
metadata object
+metadata object
Specifies the metadata for creating disks. For details, see Table 5.
+Specifies the metadata for creating disks. For details, see Table 5.
Table 5 metadata Field Description for Creating Disks Parameter
+-Table 5 metadata Field Description for Creating Disks Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
__system__encrypted
+__system__encrypted
No
+No
String
+String
Specifies encryption in metadata. The value can be 0 (encryption disabled) or 1 (encryption enabled).
+Specifies encryption in metadata. The value can be 0 (encryption disabled) or 1 (encryption enabled).
If this parameter does not exist, the disk will not be encrypted by default.
NOTE:System disk encryption is not supported.
__system__cmkid
+__system__cmkid
No
+No
String
+String
Specifies the CMK ID, which indicates encryption in metadata. This parameter is used with __system__encrypted.
+Specifies the CMK ID, which indicates encryption in metadata. This parameter is used with __system__encrypted.
NOTE:- For details about how to obtain the CMK ID, see "Querying the List of CMKs" in Key Management Service API Reference.
- System disk encryption is not supported.
Table 6 personality field description Parameter
+-Table 6 personality field description Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
path
+path
Yes
+Yes
String
+String
Specifies the path of the injected file.
+Specifies the path of the injected file.
- For Linux OSs, specify the path, for example, /etc/foo.txt, for storing the injected file.
- For Windows, the injected file is automatically stored in the root directory of drive C. You only need to specify the file name, for example, foo. The file name contains only letters and digits.
content
+content
Yes
+Yes
String
+String
Specifies the content of the injected file.
+Specifies the content of the injected file.
The value must be the information after the content of the injected file is encoded using Base64.
Table 7 public_ip field description Parameter
+-Table 7 public_ip field description Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
eip
+eip
Yes
+Yes
eip object
+eip object
Specifies the EIP automatically assigned to the ECS. For details, see Table 8.
+Specifies the EIP automatically assigned to the ECS. For details, see Table 8.
Table 8 eip field description Parameter
+-Table 8 eip field description Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
ip_type
+ip_type
Yes
+Yes
String
+String
Specifies the EIP type.
+Specifies the EIP type.
Enumerated value of the IP address type: 5_bgp (indicates dynamic BGP)
bandwidth
+bandwidth
Yes
+Yes
bandwidth object
+bandwidth object
Specifies the bandwidth of an IP address. For details, see Table 9.
+Specifies the bandwidth of an IP address. For details, see Table 9.
- Request parameters
-
- Request parameters
-
- Example response
- Response parameters
-
- Request parameters
-
- Example response
- Example response
- Response parameters
-
- Example response