This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

List Auto-Scaling Groups

1: 1.3
2: 1.2
3: 1.1
4: 1.0

1 - 1.3

get /v1/auto-scaling-groups

Description

List Auto-Scaling Groups.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
query	name optional	Auto-Scaling Group name Example : `auto-scaling-group-name`	any of [string, null]	None
query	state optional	Auto-Scaling Group state Example : `IN_SERVICE`	any of [string, null]	None
query	launch_configuration_id optional	Launch Configuration ID Example : `b5aea5a675fc4f6b9e0fcd1288354c5f`	any of [string, null]	None
query	launch_configuration_name optional	Launch Configuration name Example : `launch-configuration-name`	any of [string, null]	None
query	lb_server_group_id optional	LB Server Group ID Example : `d06e87d3-ca9a-461b-8e88-077a542a7335`	any of [string, null]	None
query	security_group_id optional	Security Group ID Example : `c09c3f05-03d9-443f-b27a-40e0f973c75f`	any of [string, null]	None
query	subnet_id optional	Subnet ID Example : `78b2ee3f074145c580ab6abac4821f97`	any of [string, null]	None
query	vpc_id optional	VPC ID Example : `cc976b621087484ea5fd527f4b78708b`	any of [string, null]	None
query	created_by optional	Created by Example : `97e6b22c9a4143789ca522df7457a32f`	any of [string, null]	None
query	offset optional	Index of where to start in the list Example : `0`	any of [integer, null]	0
query	limit optional	Page size of items Example : `20`	any of [integer, null]	20
query	sort optional	Comma-separated list of sort keys and optional sort directions in the form of [:] Example : `created_at:desc`	any of [string, null]	created_at:desc,id:desc

Responses

HTTP Code	Description	Schema
200	OK	AutoScalingGroupListResponseV1Dot2
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/auto-scaling-groups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Example HTTP response

Response 200

{
    "auto_scaling_groups": [
        {
            "account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "desired_server_count": 1,
            "desired_server_count_editable": true,
            "drain_enabled": true,
            "drain_timeout": 300,
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
            "launch_configuration_name": "launch-configuration-name",
            "lb_server_groups": [],
            "max_server_count": 2,
            "min_server_count": 1,
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "auto-scaling-group-name",
            "security_group_ids": [
                "c09c3f05-03d9-443f-b27a-40e0f973c75f"
            ],
            "server_name_prefix": "server-name-prefix",
            "state": "IN_SERVICE",
            "state_check_delay_time": 300,
            "subnet_ids": [],
            "use_lb_state_check": true,
            "vpc_id": "cc976b621087484ea5fd527f4b78708b"
        }
    ],
    "count": 20
}

2 - 1.2

get /v1/auto-scaling-groups

Description

List Auto-Scaling Groups.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

Parameters

Type	Name	Description	Schema	Default
query	name optional	Auto-Scaling Group name Example : `auto-scaling-group-name`	any of [string, null]	None
query	state optional	Auto-Scaling Group state Example : `IN_SERVICE`	any of [string, null]	None
query	launch_configuration_id optional	Launch Configuration ID Example : `b5aea5a675fc4f6b9e0fcd1288354c5f`	any of [string, null]	None
query	launch_configuration_name optional	Launch Configuration name Example : `launch-configuration-name`	any of [string, null]	None
query	lb_server_group_id optional	LB Server Group ID Example : `d06e87d3-ca9a-461b-8e88-077a542a7335`	any of [string, null]	None
query	security_group_id optional	Security Group ID Example : `c09c3f05-03d9-443f-b27a-40e0f973c75f`	any of [string, null]	None
query	subnet_id optional	Subnet ID Example : `78b2ee3f074145c580ab6abac4821f97`	any of [string, null]	None
query	vpc_id optional	VPC ID Example : `cc976b621087484ea5fd527f4b78708b`	any of [string, null]	None
query	created_by optional	Created by Example : `97e6b22c9a4143789ca522df7457a32f`	any of [string, null]	None
query	offset optional	Index of where to start in the list Example : `0`	any of [integer, null]	0
query	limit optional	Page size of items Example : `20`	any of [integer, null]	20
query	sort optional	Comma-separated list of sort keys and optional sort directions in the form of [:] Example : `created_at:desc`	any of [string, null]	created_at:desc,id:desc

Responses

HTTP Code	Description	Schema
200	OK	AutoScalingGroupListResponseV1Dot2
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/auto-scaling-groups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"

Example HTTP response

Response 200

{
    "auto_scaling_groups": [
        {
            "account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "desired_server_count": 1,
            "desired_server_count_editable": true,
            "drain_enabled": true,
            "drain_timeout": 300,
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
            "launch_configuration_name": "launch-configuration-name",
            "lb_server_groups": [],
            "max_server_count": 2,
            "min_server_count": 1,
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "auto-scaling-group-name",
            "security_group_ids": [
                "c09c3f05-03d9-443f-b27a-40e0f973c75f"
            ],
            "server_name_prefix": "server-name-prefix",
            "state": "IN_SERVICE",
            "state_check_delay_time": 300,
            "subnet_ids": [],
            "use_lb_state_check": true,
            "vpc_id": "cc976b621087484ea5fd527f4b78708b"
        }
    ],
    "count": 20
}

3 - 1.1

get /v1/auto-scaling-groups

Description

List Auto-Scaling Groups.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.1	20260531

Parameters

Type	Name	Description	Schema	Default
query	name optional	Auto-Scaling Group name Example : `auto-scaling-group-name`	any of [string, null]	None
query	state optional	Auto-Scaling Group state Example : `IN_SERVICE`	any of [string, null]	None
query	launch_configuration_id optional	Launch Configuration ID Example : `b5aea5a675fc4f6b9e0fcd1288354c5f`	any of [string, null]	None
query	launch_configuration_name optional	Launch Configuration name Example : `launch-configuration-name`	any of [string, null]	None
query	lb_server_group_id optional	LB Server Group ID Example : `d06e87d3-ca9a-461b-8e88-077a542a7335`	any of [string, null]	None
query	security_group_id optional	Security Group ID Example : `c09c3f05-03d9-443f-b27a-40e0f973c75f`	any of [string, null]	None
query	subnet_id optional	Subnet ID Example : `78b2ee3f074145c580ab6abac4821f97`	any of [string, null]	None
query	vpc_id optional	VPC ID Example : `cc976b621087484ea5fd527f4b78708b`	any of [string, null]	None
query	created_by optional	Created by Example : `97e6b22c9a4143789ca522df7457a32f`	any of [string, null]	None
query	offset optional	Index of where to start in the list Example : `0`	any of [integer, null]	0
query	limit optional	Page size of items Example : `20`	any of [integer, null]	20
query	sort optional	Comma-separated list of sort keys and optional sort directions in the form of [:] Example : `created_at:desc`	any of [string, null]	created_at:desc,id:desc

Responses

HTTP Code	Description	Schema
200	OK	AutoScalingGroupListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/auto-scaling-groups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"

Example HTTP response

Response 200

{
    "auto_scaling_groups": [
        {
            "account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "desired_server_count": 1,
            "desired_server_count_editable": true,
            "drain_enabled": true,
            "drain_timeout": 300,
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
            "launch_configuration_name": "launch-configuration-name",
            "lb_server_groups": [],
            "max_server_count": 2,
            "min_server_count": 1,
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "auto-scaling-group-name",
            "security_group_ids": [
                "c09c3f05-03d9-443f-b27a-40e0f973c75f"
            ],
            "server_name_prefix": "server-name-prefix",
            "state": "IN_SERVICE",
            "subnet_ids": [],
            "vpc_id": "cc976b621087484ea5fd527f4b78708b"
        }
    ],
    "count": 20
}

4 - 1.0

get /v1/auto-scaling-groups

Description

List Auto-Scaling Groups.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
query	name optional	Auto-Scaling Group name Example : `auto-scaling-group-name`	any of [string, null]	None
query	state optional	Auto-Scaling Group state Example : `IN_SERVICE`	any of [string, null]	None
query	launch_configuration_id optional	Launch Configuration ID Example : `b5aea5a675fc4f6b9e0fcd1288354c5f`	any of [string, null]	None
query	launch_configuration_name optional	Launch Configuration name Example : `launch-configuration-name`	any of [string, null]	None
query	lb_server_group_id optional	LB Server Group ID Example : `d06e87d3-ca9a-461b-8e88-077a542a7335`	any of [string, null]	None
query	security_group_id optional	Security Group ID Example : `c09c3f05-03d9-443f-b27a-40e0f973c75f`	any of [string, null]	None
query	subnet_id optional	Subnet ID Example : `78b2ee3f074145c580ab6abac4821f97`	any of [string, null]	None
query	vpc_id optional	VPC ID Example : `cc976b621087484ea5fd527f4b78708b`	any of [string, null]	None
query	created_by optional	Created by Example : `97e6b22c9a4143789ca522df7457a32f`	any of [string, null]	None
query	offset optional	Index of where to start in the list Example : `0`	any of [integer, null]	0
query	limit optional	Page size of items Example : `20`	any of [integer, null]	20
query	sort optional	Comma-separated list of sort keys and optional sort directions in the form of [:] Example : `created_at:desc`	any of [string, null]	created_at:desc,id:desc

Responses

HTTP Code	Description	Schema
200	OK	AutoScalingGroupListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/auto-scaling-groups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"

Example HTTP response

Response 200

{
    "auto_scaling_groups": [
        {
            "account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "desired_server_count": 1,
            "desired_server_count_editable": true,
            "drain_enabled": true,
            "drain_timeout": 300,
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
            "launch_configuration_name": "launch-configuration-name",
            "lb_server_groups": [],
            "max_server_count": 2,
            "min_server_count": 1,
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "auto-scaling-group-name",
            "security_group_ids": [
                "c09c3f05-03d9-443f-b27a-40e0f973c75f"
            ],
            "server_name_prefix": "server-name-prefix",
            "state": "IN_SERVICE",
            "subnet_ids": [],
            "vpc_id": "cc976b621087484ea5fd527f4b78708b"
        }
    ],
    "count": 20
}