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

scpcli virtualserver auto scaling group list
[--name <value>]
[--state <value>]
[--launch_configuration_id <value>]
[--launch_configuration_name <value>]
[--lb_server_group_id <value>]
[--security_group_id <value>]
[--subnet_id <value>]
[--vpc_id <value>]
[--created_by <value>]
[--offset <value>]
[--limit <value>]
[--sort <value>]
[--long]

Description

List Auto-Scaling Groups.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
name
optional
stringAuto-Scaling Group nameauto-scaling-group-name
state
optional
stringAuto-Scaling Group stateIN_SERVICE
launch_configuration_id
optional
stringLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f
launch_configuration_name
optional
stringLaunch Configuration namelaunch-configuration-name
lb_server_group_id
optional
stringLB Server Group IDd06e87d3-ca9a-461b-8e88-077a542a7335
security_group_id
optional
stringSecurity Group IDc09c3f05-03d9-443f-b27a-40e0f973c75f
subnet_id
optional
stringSubnet ID78b2ee3f074145c580ab6abac4821f97
vpc_id
optional
stringVPC IDcc976b621087484ea5fd527f4b78708b
created_by
optional
stringCreated by97e6b22c9a4143789ca522df7457a32f
offset
optional
integerIndex of where to start in the list0
limit
optional
integerPage size of items20
sort
optional
stringComma-separated list of sort keys and optional sort directions in the form of [:]created_at:desc

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
Requires --long option
a8f10467abfc4b87b64614ab36eb9ae4
created_atCreated At
Requires --long option
2024-05-17T00:23:17Z
created_byCreated By
Requires --long option
90dddfc2b1e04edba54ba2b41539a9ac
desired_server_countDesired server count1
desired_server_count_editableDesired server count editable
Requires --long option
True
drain_enabledDrain enabled
Requires --long option
True
drain_timeoutDrain timeout
Requires --long option
300
launch_configuration_idLaunch Configuration ID
Requires --long option
b5aea5a675fc4f6b9e0fcd1288354c5f
launch_configuration_nameLaunch Configuration namelaunch-configuration-name
lb_server_groupsLB Server Group list
Requires --long option
max_server_countMax server count2
min_server_countMin server count1
modified_atModified At
Requires --long option
2024-05-17T00:23:17Z
modified_byModified By
Requires --long option
90dddfc2b1e04edba54ba2b41539a9ac
nameAuto-Scaling Group nameauto-scaling-group-name
security_group_idsSecurity Group ID list
Requires --long option
[‘c09c3f05-03d9-443f-b27a-40e0f973c75f’]
server_name_prefixServer name prefix
Requires --long option
server-name-prefix
stateAuto-Scaling Group stateIN_SERVICE
state_check_delay_timeThe delay time between ASG VM creation and state check operation
Requires --long option
300
subnet_idsSubnet ID list
Requires --long option
use_lb_state_checkWhether LB state check operates or not
Requires --long option
True
vpc_idVPC ID
Requires --long option
cc976b621087484ea5fd527f4b78708b

2 - 1.1

scpcli virtualserver auto scaling group list
[--name <value>]
[--state <value>]
[--launch_configuration_id <value>]
[--launch_configuration_name <value>]
[--lb_server_group_id <value>]
[--security_group_id <value>]
[--subnet_id <value>]
[--vpc_id <value>]
[--created_by <value>]
[--offset <value>]
[--limit <value>]
[--sort <value>]
[--long]

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.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
name
optional
stringAuto-Scaling Group nameauto-scaling-group-name
state
optional
stringAuto-Scaling Group stateIN_SERVICE
launch_configuration_id
optional
stringLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f
launch_configuration_name
optional
stringLaunch Configuration namelaunch-configuration-name
lb_server_group_id
optional
stringLB Server Group IDd06e87d3-ca9a-461b-8e88-077a542a7335
security_group_id
optional
stringSecurity Group IDc09c3f05-03d9-443f-b27a-40e0f973c75f
subnet_id
optional
stringSubnet ID78b2ee3f074145c580ab6abac4821f97
vpc_id
optional
stringVPC IDcc976b621087484ea5fd527f4b78708b
created_by
optional
stringCreated by97e6b22c9a4143789ca522df7457a32f
offset
optional
integerIndex of where to start in the list0
limit
optional
integerPage size of items20
sort
optional
stringComma-separated list of sort keys and optional sort directions in the form of [:]created_at:desc

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
Requires --long option
a8f10467abfc4b87b64614ab36eb9ae4
created_atCreated At
Requires --long option
2024-05-17T00:23:17Z
created_byCreated By
Requires --long option
90dddfc2b1e04edba54ba2b41539a9ac
desired_server_countDesired server count1
desired_server_count_editableDesired server count editable
Requires --long option
True
drain_enabledDrain enabled
Requires --long option
True
drain_timeoutDrain timeout
Requires --long option
300
launch_configuration_idLaunch Configuration ID
Requires --long option
b5aea5a675fc4f6b9e0fcd1288354c5f
launch_configuration_nameLaunch Configuration namelaunch-configuration-name
lb_server_groupsLB Server Group list
Requires --long option
max_server_countMax server count2
min_server_countMin server count1
modified_atModified At
Requires --long option
2024-05-17T00:23:17Z
modified_byModified By
Requires --long option
90dddfc2b1e04edba54ba2b41539a9ac
nameAuto-Scaling Group nameauto-scaling-group-name
security_group_idsSecurity Group ID list
Requires --long option
[‘c09c3f05-03d9-443f-b27a-40e0f973c75f’]
server_name_prefixServer name prefix
Requires --long option
server-name-prefix
stateAuto-Scaling Group stateIN_SERVICE
subnet_idsSubnet ID list
Requires --long option
vpc_idVPC ID
Requires --long option
cc976b621087484ea5fd527f4b78708b

3 - 1.0

scpcli virtualserver auto scaling group list
[--name <value>]
[--state <value>]
[--launch_configuration_id <value>]
[--launch_configuration_name <value>]
[--lb_server_group_id <value>]
[--security_group_id <value>]
[--subnet_id <value>]
[--vpc_id <value>]
[--created_by <value>]
[--offset <value>]
[--limit <value>]
[--sort <value>]
[--long]

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.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
name
optional
stringAuto-Scaling Group nameauto-scaling-group-name
state
optional
stringAuto-Scaling Group stateIN_SERVICE
launch_configuration_id
optional
stringLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f
launch_configuration_name
optional
stringLaunch Configuration namelaunch-configuration-name
lb_server_group_id
optional
stringLB Server Group IDd06e87d3-ca9a-461b-8e88-077a542a7335
security_group_id
optional
stringSecurity Group IDc09c3f05-03d9-443f-b27a-40e0f973c75f
subnet_id
optional
stringSubnet ID78b2ee3f074145c580ab6abac4821f97
vpc_id
optional
stringVPC IDcc976b621087484ea5fd527f4b78708b
created_by
optional
stringCreated by97e6b22c9a4143789ca522df7457a32f
offset
optional
integerIndex of where to start in the list0
limit
optional
integerPage size of items20
sort
optional
stringComma-separated list of sort keys and optional sort directions in the form of [:]created_at:desc

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
Requires --long option
a8f10467abfc4b87b64614ab36eb9ae4
created_atCreated At
Requires --long option
2024-05-17T00:23:17Z
created_byCreated By
Requires --long option
90dddfc2b1e04edba54ba2b41539a9ac
desired_server_countDesired server count1
desired_server_count_editableDesired server count editable
Requires --long option
True
drain_enabledDrain enabled
Requires --long option
True
drain_timeoutDrain timeout
Requires --long option
300
launch_configuration_idLaunch Configuration ID
Requires --long option
b5aea5a675fc4f6b9e0fcd1288354c5f
launch_configuration_nameLaunch Configuration namelaunch-configuration-name
lb_server_groupsLB Server Group list
Requires --long option
max_server_countMax server count2
min_server_countMin server count1
modified_atModified At
Requires --long option
2024-05-17T00:23:17Z
modified_byModified By
Requires --long option
90dddfc2b1e04edba54ba2b41539a9ac
nameAuto-Scaling Group nameauto-scaling-group-name
security_group_idsSecurity Group ID list
Requires --long option
[‘c09c3f05-03d9-443f-b27a-40e0f973c75f’]
server_name_prefixServer name prefix
Requires --long option
server-name-prefix
stateAuto-Scaling Group stateIN_SERVICE
subnet_idsSubnet ID list
Requires --long option
vpc_idVPC ID
Requires --long option
cc976b621087484ea5fd527f4b78708b