Querying an AS Group

Function

This API is used to query details about a specified AS group by group ID.

Authorization

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

If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.

If you are using identity policy-based authorization, the permission listed below is required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
as:MaxInstanceSizeas:scalingGroup:get	read	scalingGroup*	g:EnterpriseProjectId g:ResourceTag/<tag-key>	as:groups:get	-

URI

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

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID.
scaling_group_id	Yes	String	Specifies the AS group ID.

Request

None

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	Description
scaling_group	scaling_groups object	Specifies details about the AS group.

**Table 3** **scaling_groups** field description
Parameter	Type	Description
scaling_group_name	String	Specifies the AS group name.
scaling_group_id	String	Specifies the AS group ID.
scaling_group_status	String	Specifies the AS group status. Valid values: INSERVICE: The AS group is normal. PAUSED: The AS group is paused. ERROR: The AS group is abnormal. DELETING: The AS group is being deleted. FREEZED: The AS group is frozen.
scaling_configuration_id	String	Specifies the AS configuration ID.
scaling_configuration_name	String	Specifies the AS configuration name.
current_instance_number	Integer	Specifies the number of current instances in the AS group.
desire_instance_number	Integer	Specifies the expected number of instances in the AS group.
min_instance_number	Integer	Specifies the minimum number of instances in the AS group.
max_instance_number	Integer	Specifies the maximum number of instances in the AS group.
cool_down_time	Integer	Specifies the cooldown period (s).
lb_listener_id	String	Specifies the ID of a typical ELB listener. ELB listener IDs are separated using a comma (,).
lbaas_listeners	Array of lbaas_listeners objects	Specifies enhanced load balancers. For details, see Table 4.
available_zones	Array of strings	Specifies the AZ information.
networks	Array of networks objects	Specifies the network information. For details, see Table 5.
security_groups	Array of security_groups objects	Specifies the security group information. For details, see Table 8.
create_time	String	Specifies the time when the AS group was created, in UTC format.
vpc_id	String	Specifies the ID of the VPC that the AS group belongs to.
detail	String	Specifies details about the AS group. If a scaling action fails, this parameter is used to record errors.
is_scaling	Boolean	Specifies the scaling flag of the AS group.
health_periodic_audit_method	String	Specifies the health check method.
health_periodic_audit_time	Integer	Specifies the health check interval.
health_periodic_audit_grace_period	Integer	Specifies the grace period for health check.
instance_terminate_policy	String	Specifies the instance removal policy.
delete_publicip	Boolean	Specifies whether to delete the EIP bound to an ECS when the ECS is deleted.
delete_volume	Boolean	Specifies whether to delete the data disks attached to an ECS when the ECS is deleted.
cloud_location_id	String	This parameter is reserved.
enterprise_project_id	String	Specifies the enterprise project ID.
activity_type	String	Specifies the type of the AS action. Valid values: NORMAL: common scaling action MANUAL_REMOVE: manually removing instances from an AS group MANUAL_DELETE: manually removing and deleting instances from an AS group MANUAL_ADD: manually adding instances to an AS group ELB_CHECK_DELETE: removing and deleting instances from an AS group based on ELB health check results AUDIT_CHECK_DELETE: removing and deleting instances from an AS group based on audits DIFF: scaling action triggered by inconsistency between the number of expected instances and the actual number of instances MODIFY_ELB: load balancer migration ENTER_STANDBY: setting instances to standby mode EXIT_STANDBY: canceling standby mode for instances
multi_az_priority_policy	String	Specifies the priority policy used to select target AZs when adjusting the number of instances in the AS group.
description	String	Specifies the description of the AS group.
iam_agency_name	String	Specifies the agency name.
tags	Array of tags objects	Specifies the tags added for the AS group. For details, see Table 9.

**Table 4** **lbaas_listeners** field description
Parameter	Type	Description
listener_id	String	Specifies the listener ID.
pool_id	String	Specifies the backend server group ID.
protocol_port	Integer	Specifies the backend protocol port, that is, the port backend ECSs listen on.
weight	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.
protocol_version	String	Specifies which version of IP addresses of backend servers will be bound with the load balancer. The value can be IPv4 or IPv6.

**Table 5** **networks** field description
Parameter	Type	Description
id	String	Specifies the subnet ID.
ipv6_enable	Boolean	Specifies whether to enable IPv6. true indicates IPv6 is enabled for the NIC. The default value is false.
ipv6_bandwidth	ipv6_bandwidth object	Specifies the IPv6 shared bandwidth. This parameter is left blank by default, indicating that no IPv6 shared bandwidth is bound.
allowed_address_pairs	Array of allowed_address_pairs objects	Specifies whether to enable source/destination check.

**Table 6** **ipv6_bandwidth** field description
Parameter	Type	Description
id	String	Specifies the ID of the IPv6 shared bandwidth.

**Table 7** **allowed_address_pairs** field description
Parameter	Type	Description
ip_address	String	Specifies whether to enable source/destination check. Source/destination check is enabled by default. This parameter cannot be left blank. 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.

**Table 8** **security_groups** field description
Parameter	Type	Description
id	String	Specifies the security group ID.

**Table 9** **tags** field description
Parameter	Mandatory	Type	Description
key	Yes	String	Specifies the tag key. It contains a maximum of 36 Unicode characters. It cannot be left blank. Tag keys of a resource must be unique. A tag key can contain only uppercase letters, lowercase letters, digits, underscores (_), and hyphens (-).
value	No	String	Specifies the tag value. A tag value contains a maximum of 43 Unicode characters and can be left blank. A tag value can contain only uppercase letters, lowercase letters, digits, underscores (_), hyphens (-), and periods (.).

Example Response

{
    "scaling_group": {
      "networks": [
                {
                    "id": " a8327883-6b07-4497-9c61-68d03ee193a ",
                    "ipv6_enable": true,
                    "ipv6_bandwidth": 
                        {         
                              "id": "076ee2ff-f23e-4338-b8ac-1bc7278532d5"
                        }
                }
        ],
        "available_zones": [
               "XXXa",
               "XXXb"
        ],
        "detail": null,
        "scaling_group_name": "api_gateway_modify",
        "scaling_group_id": "d4e50321-3777-4135-97f8-9f5e9714a4b0",
        "scaling_group_status": "INSERVICE",
        "scaling_configuration_id": "53579851-3841-418d-a97b-9cecdb663a90",
        "scaling_configuration_name": "press",
        "current_instance_number": 7,
        "desire_instance_number": 8,
        "min_instance_number": 0,
        "max_instance_number": 100,
        "cool_down_time": 900,
        "lb_listener_id": null,
        "security_groups": [
            {
                "id": "23b7b999-0a30-4b48-ae8f-ee201a88a6ab"
            }
        ],
        "create_time": "2015-09-01T08:36:10Z",
        "vpc_id": "3e22f934-800d-4bb4-a588-0b9a76108190",
        "health_periodic_audit_method": "NOVA_AUDIT",
        "health_periodic_audit_time": 5,
        "health_periodic_audit_grace_period": 600,
        "instance_terminate_policy": "OLD_CONFIG_OLD_INSTANCE",
        "is_scaling": true,
        "delete_publicip": false,
        "enterprise_project_id":"c92b1a5d-6f20-43f2-b1b7-7ce35e58e413",
        "activity_type":"MODIFY_ELB",
        "multi_az_priority_policy":"PICK_FIRST",
        "iam_agency_name":"test",
        "tags":[{"key":"1"}]
    }
}

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.