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

Return to the regular view of this page.

CLIs

1 - Accept a volume transfer

1.1 - 1.2

scpcli virtualserver volume transfer accept
--transfer_id <value>
--auth_key <value>

Description

Accept a volume transfer.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
transfer_id
required
stringVolume Transfer ID1ac231be-823b-4a4d-8ff0-aac503a7118a
auth_key
required
stringAuth keyf5972fdb456897eb

Responses

NameDescriptionExample
idVolume Transfer ID1ac231be-823b-4a4d-8ff0-aac503a7118a
nameVolume namevolume01
volume_idVolume ID3f500f00-ed80-4566-a057-e31760226f9a

1.2 - 1.1

scpcli virtualserver volume transfer accept
--transfer_id <value>
--auth_key <value>

Description

Accept a volume transfer.

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
transfer_id
required
stringVolume Transfer ID1ac231be-823b-4a4d-8ff0-aac503a7118a
auth_key
required
stringAuth keyf5972fdb456897eb

Responses

NameDescriptionExample
idVolume Transfer ID1ac231be-823b-4a4d-8ff0-aac503a7118a
nameVolume namevolume01
volume_idVolume ID3f500f00-ed80-4566-a057-e31760226f9a

1.3 - 1.0

scpcli virtualserver volume transfer accept
--transfer_id <value>
--auth_key <value>

Description

Accept a volume transfer.

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
transfer_id
required
stringVolume Transfer ID1ac231be-823b-4a4d-8ff0-aac503a7118a
auth_key
required
stringAuth keyf5972fdb456897eb

Responses

NameDescriptionExample
idVolume Transfer ID1ac231be-823b-4a4d-8ff0-aac503a7118a
nameVolume namevolume01
volume_idVolume ID3f500f00-ed80-4566-a057-e31760226f9a

2 - Attach Virtual Server Security Group

2.1 - 1.0

scpcli virtualserver server add security group
--server_id <value>
--security_group_id <value>

Description

Attach Virtual Server Security Group.

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
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
security_group_id
required
stringSecurity Group IDc09c3f05-03d9-443f-b27a-40e0f973c75f

Responses

NameDescriptionExample

3 - Attach Volume to Virtual Server

3.1 - 1.2

scpcli virtualserver volume attach server
--volume_id <value>
--server_id <value>
[--delete_on_termination <value>]

Description

Attach Volume to Virtual Server.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
delete_on_termination
optional
booleanDelete the boot volume when the server is terminated.False

Responses

NameDescriptionExample
delete_on_terminationDelete the boot volume when the server is terminated.False
deviceDevice name such as, /dev/vda./dev/vda
server_idServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_idVolume ID3f500f00-ed80-4566-a057-e31760226f9a

3.2 - 1.1

scpcli virtualserver volume attach server
--volume_id <value>
--server_id <value>
[--delete_on_termination <value>]

Description

Attach Volume to Virtual Server.

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
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
delete_on_termination
optional
booleanDelete the boot volume when the server is terminated.False

Responses

NameDescriptionExample
delete_on_terminationDelete the boot volume when the server is terminated.False
deviceDevice name such as, /dev/vda./dev/vda
server_idServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_idVolume ID3f500f00-ed80-4566-a057-e31760226f9a

3.3 - 1.0

scpcli virtualserver volume attach server
--volume_id <value>
--server_id <value>
[--delete_on_termination <value>]

Description

Attach Volume to Virtual Server.

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
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
delete_on_termination
optional
booleanDelete the boot volume when the server is terminated.False

Responses

NameDescriptionExample
delete_on_terminationDelete the boot volume when the server is terminated.False
deviceDevice name such as, /dev/vda./dev/vda
server_idServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_idVolume ID3f500f00-ed80-4566-a057-e31760226f9a

4 - Create a snapshot

4.1 - 1.2

scpcli virtualserver volume snapshot create
--volume_id <value>
--name <value>
[--description <value>]
[--force <value>]
[--metadata <value>]

Description

Create a volume snapshot. This snapshot is a full copy of the volume. You can create a volume from the snapshot that was created.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
name
required
stringSnapshot namesnapshot-1
description
optional
stringDescriptiondescription
force
optional
booleanWhether to create a snapshot even if the volume is attachedTrue
metadata
optional
objectOne or more metadata key and value pairs for the snapshot-

Responses

NameDescriptionExample
idSnapshot IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790
created_atCreated at2025-07-22T09:00:00Z
descriptionDescriptiondescription
metadataOne or more metadata key and value pairs for the snapshotMetadata
nameSnapshot namesnapshot-1
sizeVolume size104
statusVolume stateavailable
updated_atUpdated at2025-07-26T12:00:00Z
user_idUser ID570907805e5447be84b618450ef52o0t
volume_idVolume ID3f500f00-ed80-4566-a057-e31760226f9a

4.2 - 1.1

scpcli virtualserver volume snapshot create
--volume_id <value>
--name <value>
[--description <value>]
[--force <value>]
[--metadata <value>]

Description

Create a volume snapshot. This snapshot is a full copy of the volume. You can create a volume from the snapshot that was created.

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
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
name
required
stringSnapshot namesnapshot-1
description
optional
stringDescriptiondescription
force
optional
booleanWhether to create a snapshot even if the volume is attachedTrue
metadata
optional
objectOne or more metadata key and value pairs for the snapshot-

Responses

NameDescriptionExample
idSnapshot IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790
created_atCreated at2025-07-22T09:00:00Z
descriptionDescriptiondescription
metadataOne or more metadata key and value pairs for the snapshotMetadata
nameSnapshot namesnapshot-1
sizeVolume size104
statusVolume stateavailable
updated_atUpdated at2025-07-26T12:00:00Z
user_idUser ID570907805e5447be84b618450ef52o0t
volume_idVolume ID3f500f00-ed80-4566-a057-e31760226f9a

4.3 - 1.0

scpcli virtualserver volume snapshot create
--volume_id <value>
--name <value>
[--description <value>]
[--force <value>]
[--metadata <value>]

Description

Create a volume snapshot. This snapshot is a full copy of the volume. You can create a volume from the snapshot that was created.

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
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
name
required
stringSnapshot namesnapshot-1
description
optional
stringDescriptiondescription
force
optional
booleanWhether to create a snapshot even if the volume is attachedTrue
metadata
optional
objectOne or more metadata key and value pairs for the snapshot-

Responses

NameDescriptionExample
idSnapshot IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790
created_atCreated at2025-07-22T09:00:00Z
descriptionDescriptiondescription
metadataOne or more metadata key and value pairs for the snapshotMetadata
nameSnapshot namesnapshot-1
sizeVolume size104
statusVolume stateavailable
updated_atUpdated at2025-07-26T12:00:00Z
user_idUser ID570907805e5447be84b618450ef52o0t
volume_idVolume ID3f500f00-ed80-4566-a057-e31760226f9a

5 - Create a volume transfer

5.1 - 1.2

scpcli virtualserver volume transfer create
--volume_id <value>
[--name <value>]

Description

Create a volume transfer.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
name
optional
stringVolume namevolume01

Responses

NameDescriptionExample
idVolume Transfer ID1ac231be-823b-4a4d-8ff0-aac503a7118a
auth_keyAuth keyf5972fdb456897eb
created_atCreated at
nameVolume namevolume01
volume_idVolume ID3f500f00-ed80-4566-a057-e31760226f9a

5.2 - 1.1

scpcli virtualserver volume transfer create
--volume_id <value>
[--name <value>]

Description

Create a volume transfer.

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
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
name
optional
stringVolume namevolume01

Responses

NameDescriptionExample
idVolume Transfer ID1ac231be-823b-4a4d-8ff0-aac503a7118a
auth_keyAuth keyf5972fdb456897eb
created_atCreated at
nameVolume namevolume01
volume_idVolume ID3f500f00-ed80-4566-a057-e31760226f9a

5.3 - 1.0

scpcli virtualserver volume transfer create
--volume_id <value>
[--name <value>]

Description

Create a volume transfer.

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
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
name
optional
stringVolume namevolume01

Responses

NameDescriptionExample
idVolume Transfer ID1ac231be-823b-4a4d-8ff0-aac503a7118a
auth_keyAuth keyf5972fdb456897eb
created_atCreated at
nameVolume namevolume01
volume_idVolume ID3f500f00-ed80-4566-a057-e31760226f9a

6 - Create Auto-Scaling Group

6.1 - 1.2

scpcli virtualserver auto scaling group create
--use_lb_state_check <value>
--subnet_ids <value>
--state_check_delay_time <value>
--server_name_prefix <value>
--name <value>
--min_server_count <value>
--max_server_count <value>
--launch_configuration_id <value>
--desired_server_count_editable <value>
--desired_server_count <value>
[--drain_enabled <value>]
[--drain_timeout <value>]
[--lb_server_groups <value>]
[--notifications <value>]
[--scaling_policies <value>]
[--security_group_ids <value>]
[--tags <value>]

Description

Create Auto-Scaling Group.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
use_lb_state_check
required
booleanWhether LB state check operates or notTrue
subnet_ids
required
arraySubnet ID list-
state_check_delay_time
required
integerThe delay time between ASG VM creation and state check operation300
server_name_prefix
required
stringServer name prefixserver-name-prefix
name
required
stringAuto-Scaling Group nameauto-scaling-group-name
min_server_count
required
integerMin server count1
max_server_count
required
integerMax server count2
launch_configuration_id
required
stringLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f
desired_server_count_editable
required
booleanDesired server count editableTrue
desired_server_count
required
integerDesired server count1
drain_enabled
optional
booleanDrain enabledTrue
drain_timeout
optional
integerDrain timeout300
lb_server_groups
optional
arrayLB Server Group list'{"id": "d06e87d3-ca9a-461b-8e88-077a542a7335", "port": 8080}'
notifications
optional
arrayAuto-Scaling Group notifications'{"notification_events": ["SCALE_OUT", "SCALE_OUT_FAIL"], "user_ids": ["570907805e5447be84b618450ef52o0t"]}'
scaling_policies
optional
arrayAuto-Scaling Group policy list'{"comparison_operator": "ge", "cooldown_seconds": 300, "evaluation_minutes": 5, "metric_method": "AVG", "metric_type": "CPU", "name": "policy-name", "scale_method": "AMOUNT", "scale_type": "SCALE_OUT", "scale_value": 10, "threshold": 60}'
security_group_ids
optional
arraySecurity Group ID listc09c3f05-03d9-443f-b27a-40e0f973c75f
tags
optional
arrayTags'{"key": "Key", "value": "Value"}'

Responses

NameDescriptionExample
idLB Server Group IDd06e87d3-ca9a-461b-8e88-077a542a7335
portLB Server Group port8080

6.2 - 1.1

scpcli virtualserver auto scaling group create
--subnet_ids <value>
--server_name_prefix <value>
--name <value>
--min_server_count <value>
--max_server_count <value>
--launch_configuration_id <value>
--desired_server_count_editable <value>
--desired_server_count <value>
[--drain_enabled <value>]
[--drain_timeout <value>]
[--lb_server_groups <value>]
[--notifications <value>]
[--scaling_policies <value>]
[--security_group_ids <value>]
[--tags <value>]

Description

Create Auto-Scaling Group.

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
subnet_ids
required
arraySubnet ID list-
server_name_prefix
required
stringServer name prefixserver-name-prefix
name
required
stringAuto-Scaling Group nameauto-scaling-group-name
min_server_count
required
integerMin server count1
max_server_count
required
integerMax server count2
launch_configuration_id
required
stringLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f
desired_server_count_editable
required
booleanDesired server count editableTrue
desired_server_count
required
integerDesired server count1
drain_enabled
optional
booleanDrain enabledTrue
drain_timeout
optional
integerDrain timeout300
lb_server_groups
optional
arrayLB Server Group list'{"id": "d06e87d3-ca9a-461b-8e88-077a542a7335", "port": 8080}'
notifications
optional
arrayAuto-Scaling Group notifications'{"notification_events": ["SCALE_OUT", "SCALE_OUT_FAIL"], "user_ids": ["570907805e5447be84b618450ef52o0t"]}'
scaling_policies
optional
arrayAuto-Scaling Group policy list'{"comparison_operator": "ge", "cooldown_seconds": 300, "evaluation_minutes": 5, "metric_method": "AVG", "metric_type": "CPU", "name": "policy-name", "scale_method": "AMOUNT", "scale_type": "SCALE_OUT", "scale_value": 10, "threshold": 60}'
security_group_ids
optional
arraySecurity Group ID listc09c3f05-03d9-443f-b27a-40e0f973c75f
tags
optional
arrayTags'{"key": "Key", "value": "Value"}'

Responses

NameDescriptionExample
idLB Server Group IDd06e87d3-ca9a-461b-8e88-077a542a7335
portLB Server Group port8080

6.3 - 1.0

scpcli virtualserver auto scaling group create
--subnet_ids <value>
--server_name_prefix <value>
--name <value>
--min_server_count <value>
--max_server_count <value>
--launch_configuration_id <value>
--desired_server_count_editable <value>
--desired_server_count <value>
[--drain_enabled <value>]
[--drain_timeout <value>]
[--lb_server_groups <value>]
[--notifications <value>]
[--scaling_policies <value>]
[--security_group_ids <value>]
[--tags <value>]

Description

Create Auto-Scaling Group.

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
subnet_ids
required
arraySubnet ID list-
server_name_prefix
required
stringServer name prefixserver-name-prefix
name
required
stringAuto-Scaling Group nameauto-scaling-group-name
min_server_count
required
integerMin server count1
max_server_count
required
integerMax server count2
launch_configuration_id
required
stringLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f
desired_server_count_editable
required
booleanDesired server count editableTrue
desired_server_count
required
integerDesired server count1
drain_enabled
optional
booleanDrain enabledTrue
drain_timeout
optional
integerDrain timeout300
lb_server_groups
optional
arrayLB Server Group list'{"id": "d06e87d3-ca9a-461b-8e88-077a542a7335", "port": 8080}'
notifications
optional
arrayAuto-Scaling Group notifications'{"notification_events": ["SCALE_OUT", "SCALE_OUT_FAIL"], "user_ids": ["570907805e5447be84b618450ef52o0t"]}'
scaling_policies
optional
arrayAuto-Scaling Group policy list'{"comparison_operator": "ge", "cooldown_seconds": 300, "evaluation_minutes": 5, "metric_method": "AVG", "metric_type": "CPU", "name": "policy-name", "scale_method": "AMOUNT", "scale_type": "SCALE_OUT", "scale_value": 10, "threshold": 60}'
security_group_ids
optional
arraySecurity Group ID listc09c3f05-03d9-443f-b27a-40e0f973c75f
tags
optional
arrayTags'{"key": "Key", "value": "Value"}'

Responses

NameDescriptionExample
idLB Server Group IDd06e87d3-ca9a-461b-8e88-077a542a7335
portLB Server Group port8080

7 - Create Auto-Scaling Group Notification

7.1 - 1.2

scpcli virtualserver auto scaling group notification create
--auto_scaling_group_id <value>
--user_ids <value>
--notification_events <value>

Description

Create Auto-Scaling Group notification.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
user_ids
required
arrayUser ID list570907805e5447be84b618450ef52o0t
notification_events
required
arrayAuto-Scaling Group notification event list'{}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_idAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
notification_eventsAuto-Scaling Group notification event list[‘SCALE_OUT’, ‘SCALE_OUT_FAIL’]
notification_stateAuto-Scaling Group notification stateACTIVE
user_emailUser emailscpuser@samsung.com
user_idUser ID570907805e5447be84b618450ef52o0t
user_nameUser namescpuser

7.2 - 1.1

scpcli virtualserver auto scaling group notification create
--auto_scaling_group_id <value>
--user_ids <value>
--notification_events <value>

Description

Create Auto-Scaling Group notification.

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
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
user_ids
required
arrayUser ID list570907805e5447be84b618450ef52o0t
notification_events
required
arrayAuto-Scaling Group notification event list'{}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_idAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
notification_eventsAuto-Scaling Group notification event list[‘SCALE_OUT’, ‘SCALE_OUT_FAIL’]
notification_stateAuto-Scaling Group notification stateACTIVE
user_emailUser emailscpuser@samsung.com
user_idUser ID570907805e5447be84b618450ef52o0t
user_nameUser namescpuser

7.3 - 1.0

scpcli virtualserver auto scaling group notification create
--auto_scaling_group_id <value>
--user_ids <value>
--notification_events <value>

Description

Create Auto-Scaling Group notification.

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
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
user_ids
required
arrayUser ID list570907805e5447be84b618450ef52o0t
notification_events
required
arrayAuto-Scaling Group notification event list'{}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_idAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
notification_eventsAuto-Scaling Group notification event list[‘SCALE_OUT’, ‘SCALE_OUT_FAIL’]
notification_stateAuto-Scaling Group notification stateACTIVE
user_emailUser emailscpuser@samsung.com
user_idUser ID570907805e5447be84b618450ef52o0t
user_nameUser namescpuser

8 - Create Auto-Scaling Group Policy

8.1 - 1.2

scpcli virtualserver auto scaling group policy create
--auto_scaling_group_id <value>
--threshold <value>
--scale_value <value>
--scale_type <value>
--scale_method <value>
--name <value>
--metric_type <value>
--metric_method <value>
--evaluation_minutes <value>
--cooldown_seconds <value>
--comparison_operator <value>

Description

Create Auto-Scaling Group policy.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
threshold
required
integerThreshold60
scale_value
required
integerScale value10
scale_type
required
stringScale typeSCALE_OUT
scale_method
required
stringScale methodAMOUNT
name
required
stringPolicy namepolicy-name
metric_type
required
stringMetric typeCPU
metric_method
required
stringMetric methodAVG
evaluation_minutes
required
integerEvaluation minutes5
cooldown_seconds
required
integerCooldown seconds300
comparison_operator
required
stringComparison operatorge

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_idAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
comparison_operatorComparison operatorge
cooldown_secondsCooldown seconds300
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
evaluation_minutesEvaluation minutes5
metric_methodMetric methodAVG
metric_typeMetric typeCPU
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePolicy namepolicy-name
scale_methodScale methodAMOUNT
scale_typeScale typeSCALE_OUT
scale_valueScale value10
statePolicy stateACTIVE
thresholdThreshold60
threshold_unitThreshold unit%

8.2 - 1.1

scpcli virtualserver auto scaling group policy create
--auto_scaling_group_id <value>
--threshold <value>
--scale_value <value>
--scale_type <value>
--scale_method <value>
--name <value>
--metric_type <value>
--metric_method <value>
--evaluation_minutes <value>
--cooldown_seconds <value>
--comparison_operator <value>

Description

Create Auto-Scaling Group policy.

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
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
threshold
required
integerThreshold60
scale_value
required
integerScale value10
scale_type
required
stringScale typeSCALE_OUT
scale_method
required
stringScale methodAMOUNT
name
required
stringPolicy namepolicy-name
metric_type
required
stringMetric typeCPU
metric_method
required
stringMetric methodAVG
evaluation_minutes
required
integerEvaluation minutes5
cooldown_seconds
required
integerCooldown seconds300
comparison_operator
required
stringComparison operatorge

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_idAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
comparison_operatorComparison operatorge
cooldown_secondsCooldown seconds300
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
evaluation_minutesEvaluation minutes5
metric_methodMetric methodAVG
metric_typeMetric typeCPU
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePolicy namepolicy-name
scale_methodScale methodAMOUNT
scale_typeScale typeSCALE_OUT
scale_valueScale value10
statePolicy stateACTIVE
thresholdThreshold60
threshold_unitThreshold unit%

8.3 - 1.0

scpcli virtualserver auto scaling group policy create
--auto_scaling_group_id <value>
--threshold <value>
--scale_value <value>
--scale_type <value>
--scale_method <value>
--name <value>
--metric_type <value>
--metric_method <value>
--evaluation_minutes <value>
--cooldown_seconds <value>
--comparison_operator <value>

Description

Create Auto-Scaling Group policy.

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
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
threshold
required
integerThreshold60
scale_value
required
integerScale value10
scale_type
required
stringScale typeSCALE_OUT
scale_method
required
stringScale methodAMOUNT
name
required
stringPolicy namepolicy-name
metric_type
required
stringMetric typeCPU
metric_method
required
stringMetric methodAVG
evaluation_minutes
required
integerEvaluation minutes5
cooldown_seconds
required
integerCooldown seconds300
comparison_operator
required
stringComparison operatorge

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_idAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
comparison_operatorComparison operatorge
cooldown_secondsCooldown seconds300
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
evaluation_minutesEvaluation minutes5
metric_methodMetric methodAVG
metric_typeMetric typeCPU
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePolicy namepolicy-name
scale_methodScale methodAMOUNT
scale_typeScale typeSCALE_OUT
scale_valueScale value10
statePolicy stateACTIVE
thresholdThreshold60
threshold_unitThreshold unit%

9 - Create Auto-Scaling Group Schedule

9.1 - 1.2

scpcli virtualserver auto scaling group schedule create
--auto_scaling_group_id <value>
--timezone <value>
--start_date <value>
--name <value>
--minute <value>
--hour <value>
--frequency <value>
[--day_of_month <value>]
[--day_of_week <value>]
[--description <value>]
[--desired_server_count <value>]
[--end_date <value>]
[--max_server_count <value>]
[--min_server_count <value>]
[--state <value>]

Description

Create Auto-Scaling Group schedule.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
timezone
required
stringTimezoneAsia/Seoul
start_date
required
stringStart date2024-01-01
name
required
stringSchedule nameschedulename
minute
required
integerMinute0
hour
required
integerHour9
frequency
required
stringFrequencyWEEKLY
day_of_month
optional
stringDay of the month-1,1
day_of_week
optional
stringDay of the weekSU,SA
description
optional
stringDescriptiondescription
desired_server_count
optional
integerDesired server count1
end_date
optional
stringEnd date2025-01-01
max_server_count
optional
integerMax server count2
min_server_count
optional
integerMin server count1
state
optional
stringSchedule stateACTIVE

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
day_of_monthDay of the month-1,1
day_of_weekDay of the weekSU,SA
descriptionDescriptiondescription
desired_server_countDesired server count1
end_dateEnd date2025-01-01
frequencyFrequencyWEEKLY
hourHour9
max_server_countMax server count2
min_server_countMin server count1
minuteMinute0
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSchedule nameschedulename
start_dateStart date2024-01-01
stateSchedule stateACTIVE
timezoneTimezoneAsia/Seoul

9.2 - 1.1

scpcli virtualserver auto scaling group schedule create
--auto_scaling_group_id <value>
--timezone <value>
--start_date <value>
--name <value>
--minute <value>
--hour <value>
--frequency <value>
[--day_of_month <value>]
[--day_of_week <value>]
[--description <value>]
[--desired_server_count <value>]
[--end_date <value>]
[--max_server_count <value>]
[--min_server_count <value>]
[--state <value>]

Description

Create Auto-Scaling Group schedule.

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
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
timezone
required
stringTimezoneAsia/Seoul
start_date
required
stringStart date2024-01-01
name
required
stringSchedule nameschedulename
minute
required
integerMinute0
hour
required
integerHour9
frequency
required
stringFrequencyWEEKLY
day_of_month
optional
stringDay of the month-1,1
day_of_week
optional
stringDay of the weekSU,SA
description
optional
stringDescriptiondescription
desired_server_count
optional
integerDesired server count1
end_date
optional
stringEnd date2025-01-01
max_server_count
optional
integerMax server count2
min_server_count
optional
integerMin server count1
state
optional
stringSchedule stateACTIVE

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
day_of_monthDay of the month-1,1
day_of_weekDay of the weekSU,SA
descriptionDescriptiondescription
desired_server_countDesired server count1
end_dateEnd date2025-01-01
frequencyFrequencyWEEKLY
hourHour9
max_server_countMax server count2
min_server_countMin server count1
minuteMinute0
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSchedule nameschedulename
start_dateStart date2024-01-01
stateSchedule stateACTIVE
timezoneTimezoneAsia/Seoul

9.3 - 1.0

scpcli virtualserver auto scaling group schedule create
--auto_scaling_group_id <value>
--timezone <value>
--start_date <value>
--name <value>
--minute <value>
--hour <value>
--frequency <value>
[--day_of_month <value>]
[--day_of_week <value>]
[--description <value>]
[--desired_server_count <value>]
[--end_date <value>]
[--max_server_count <value>]
[--min_server_count <value>]
[--state <value>]

Description

Create Auto-Scaling Group schedule.

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
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
timezone
required
stringTimezoneAsia/Seoul
start_date
required
stringStart date2024-01-01
name
required
stringSchedule nameschedulename
minute
required
integerMinute0
hour
required
integerHour9
frequency
required
stringFrequencyWEEKLY
day_of_month
optional
stringDay of the month-1,1
day_of_week
optional
stringDay of the weekSU,SA
description
optional
stringDescriptiondescription
desired_server_count
optional
integerDesired server count1
end_date
optional
stringEnd date2025-01-01
max_server_count
optional
integerMax server count2
min_server_count
optional
integerMin server count1
state
optional
stringSchedule stateACTIVE

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
day_of_monthDay of the month-1,1
day_of_weekDay of the weekSU,SA
descriptionDescriptiondescription
desired_server_countDesired server count1
end_dateEnd date2025-01-01
frequencyFrequencyWEEKLY
hourHour9
max_server_countMax server count2
min_server_countMin server count1
minuteMinute0
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSchedule nameschedulename
start_dateStart date2024-01-01
stateSchedule stateACTIVE
timezoneTimezoneAsia/Seoul

10 - Create Image

10.1 - 1.2

scpcli virtualserver image create
--url <value>
--os_distro <value>
--name <value>
[--container_format <value>]
[--disk_format <value>]
[--min_disk <value>]
[--min_ram <value>]
[--protected <value>]
[--tags <value>]
[--visibility <value>]

Description

Create Image.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
url
required
stringObject Storage URL for Image file (only qcow2 format allowed)https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2
os_distro
required
stringOS distribution of the image to be uploadedalma
name
required
stringImage nameimagename
container_format
optional
stringContainer formatbare
disk_format
optional
stringDisk formatqcow2
min_disk
optional
integerMinimum disk capacity (GB) of the Image to be created100
min_ram
optional
integerMinimum RAM capacity (GB) of the Image to be created0
protected
optional
booleanwhether Image deletion is prohibitedFalse
tags
optional
arrayTags'{"key": "Key", "value": "Value"}'
visibility
optional
stringIndicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accountsprivate

Responses

NameDescriptionExample
idImage ID70a599e0-31e7-49b7-b260-868f441e862b
checksumMD5 hash of the entire image data. and this field could be used to verify the integrity of image.7538e0fcb56e0e272cfd89eb384d6613
container_formatContainer formatbare
created_atCreated at2025-07-22T09:00:00Z
disk_formatDisk formatqcow2
fileThe URL for the virtual server image file/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file
min_diskMinimum disk capacity (GB) of the Image to be created100
min_ramMinimum RAM capacity (GB) of the Image to be created0
nameImage nameimagename
os_distroOS distribution of the image to be uploadedalma
os_hash_algoOS hash algorithm used to verify image integritysha512
os_hash_valueThe actual digest of the image binary, calculated with the algorithm indicated by os_hash_algo. The value is presented as a hexadecimal string.c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99
os_hiddenWhether the image is hiddenFalse
ownerOwner account IDa8f10467abfc4b87b64614ab36eb9ae4
owner_account_nameOwner account nameAccountName
owner_user_nameOwner user nameuser@samsung.com
protectedwhether Image deletion is prohibitedFalse
root_device_nameRoot device name/dev/vda
scp_gpu_driverK8s GPU Image driver version535.183.06
scp_image_typeImage typecustom
scp_k8s_versionK8S versionv1.28.7
scp_original_image_typeOriginal Image typestandard
scp_os_build_versionOS build version20250101
scp_os_versionOS version8.8
sizeImage size2429747200
statusImage statusactive
updated_atUpdated at2025-07-26T12:00:00Z
urlObject Storage URL for Image file (only qcow2 format allowed)https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2
virtual_sizeVirtual size17179869184
visibilityIndicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accountsprivate
volumesVolumes[{“tag”: null, “volume_id”: null, “encryption_options”: null, “encryption_secret_uuid”: null, “encryption_format”: null, “device_name”: “/dev/vda”, “disk_bus”: “virtio”, “volume_type”: null, “encrypted”: null, “image_id”: null, “device_type”: “disk”, “source_type”: “snapshot”, “delete_on_termination”: false, “volume_size”: 104, “guest_format”: null, “boot_index”: 0, “destination_type”: “volume”, “snapshot_id”: “abde9e38-2ed5-4ecd-b23c-b0120e30690e”, “no_device”: null}]

10.2 - 1.1

scpcli virtualserver image create
--url <value>
--os_distro <value>
--name <value>
[--container_format <value>]
[--disk_format <value>]
[--min_disk <value>]
[--min_ram <value>]
[--protected <value>]
[--tags <value>]
[--visibility <value>]

Description

Create Image.

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
url
required
stringObject Storage URL for Image file (only qcow2 format allowed)https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2
os_distro
required
stringOS distribution of the image to be uploadedalma
name
required
stringImage nameimagename
container_format
optional
stringContainer formatbare
disk_format
optional
stringDisk formatqcow2
min_disk
optional
integerMinimum disk capacity (GB) of the Image to be created100
min_ram
optional
integerMinimum RAM capacity (GB) of the Image to be created0
protected
optional
booleanwhether Image deletion is prohibitedFalse
tags
optional
arrayTags'{"key": "Key", "value": "Value"}'
visibility
optional
stringIndicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accountsprivate

Responses

NameDescriptionExample
idImage ID70a599e0-31e7-49b7-b260-868f441e862b
checksumMD5 hash of the entire image data. and this field could be used to verify the integrity of image.7538e0fcb56e0e272cfd89eb384d6613
container_formatContainer formatbare
created_atCreated at2025-07-22T09:00:00Z
disk_formatDisk formatqcow2
fileThe URL for the virtual server image file/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file
min_diskMinimum disk capacity (GB) of the Image to be created100
min_ramMinimum RAM capacity (GB) of the Image to be created0
nameImage nameimagename
os_distroOS distribution of the image to be uploadedalma
os_hash_algoOS hash algorithm used to verify image integritysha512
os_hash_valueThe actual digest of the image binary, calculated with the algorithm indicated by os_hash_algo. The value is presented as a hexadecimal string.c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99
os_hiddenWhether the image is hiddenFalse
ownerOwner account IDa8f10467abfc4b87b64614ab36eb9ae4
owner_account_nameOwner account nameAccountName
owner_user_nameOwner user nameuser@samsung.com
protectedwhether Image deletion is prohibitedFalse
root_device_nameRoot device name/dev/vda
scp_image_typeImage typecustom
scp_k8s_versionK8S versionv1.28.7
scp_original_image_typeOriginal Image typestandard
scp_os_build_versionOS build version20250101
scp_os_versionOS version8.8
sizeImage size2429747200
statusImage statusactive
updated_atUpdated at2025-07-26T12:00:00Z
urlObject Storage URL for Image file (only qcow2 format allowed)https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2
virtual_sizeVirtual size17179869184
visibilityIndicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accountsprivate
volumesVolumes[{“tag”: null, “volume_id”: null, “encryption_options”: null, “encryption_secret_uuid”: null, “encryption_format”: null, “device_name”: “/dev/vda”, “disk_bus”: “virtio”, “volume_type”: null, “encrypted”: null, “image_id”: null, “device_type”: “disk”, “source_type”: “snapshot”, “delete_on_termination”: false, “volume_size”: 104, “guest_format”: null, “boot_index”: 0, “destination_type”: “volume”, “snapshot_id”: “abde9e38-2ed5-4ecd-b23c-b0120e30690e”, “no_device”: null}]

10.3 - 1.0

scpcli virtualserver image create
--url <value>
--os_distro <value>
--name <value>
[--container_format <value>]
[--disk_format <value>]
[--min_disk <value>]
[--min_ram <value>]
[--protected <value>]
[--tags <value>]
[--visibility <value>]

Description

Create Image.

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
url
required
stringObject Storage URL for Image file (only qcow2 format allowed)https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2
os_distro
required
stringOS distribution of the image to be uploadedalma
name
required
stringImage nameimagename
container_format
optional
stringContainer formatbare
disk_format
optional
stringDisk formatqcow2
min_disk
optional
integerMinimum disk capacity (GB) of the Image to be created100
min_ram
optional
integerMinimum RAM capacity (GB) of the Image to be created0
protected
optional
booleanwhether Image deletion is prohibitedFalse
tags
optional
arrayTags'{"key": "Key", "value": "Value"}'
visibility
optional
stringIndicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accountsprivate

Responses

NameDescriptionExample
idImage ID70a599e0-31e7-49b7-b260-868f441e862b
checksumMD5 hash of the entire image data. and this field could be used to verify the integrity of image.7538e0fcb56e0e272cfd89eb384d6613
container_formatContainer formatbare
created_atCreated at2025-07-22T09:00:00Z
disk_formatDisk formatqcow2
fileThe URL for the virtual server image file/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file
min_diskMinimum disk capacity (GB) of the Image to be created100
min_ramMinimum RAM capacity (GB) of the Image to be created0
nameImage nameimagename
os_distroOS distribution of the image to be uploadedalma
os_hash_algoOS hash algorithm used to verify image integritysha512
os_hash_valueThe actual digest of the image binary, calculated with the algorithm indicated by os_hash_algo. The value is presented as a hexadecimal string.c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99
os_hiddenWhether the image is hiddenFalse
ownerOwner account IDa8f10467abfc4b87b64614ab36eb9ae4
owner_account_nameOwner account nameAccountName
owner_user_nameOwner user nameuser@samsung.com
protectedwhether Image deletion is prohibitedFalse
root_device_nameRoot device name/dev/vda
scp_image_typeImage typecustom
scp_k8s_versionK8S versionv1.28.7
scp_original_image_typeOriginal Image typestandard
scp_os_build_versionOS build version20250101
scp_os_versionOS version8.8
sizeImage size2429747200
statusImage statusactive
updated_atUpdated at2025-07-26T12:00:00Z
urlObject Storage URL for Image file (only qcow2 format allowed)https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2
virtual_sizeVirtual size17179869184
visibilityIndicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accountsprivate
volumesVolumes[{“tag”: null, “volume_id”: null, “encryption_options”: null, “encryption_secret_uuid”: null, “encryption_format”: null, “device_name”: “/dev/vda”, “disk_bus”: “virtio”, “volume_type”: null, “encrypted”: null, “image_id”: null, “device_type”: “disk”, “source_type”: “snapshot”, “delete_on_termination”: false, “volume_size”: 104, “guest_format”: null, “boot_index”: 0, “destination_type”: “volume”, “snapshot_id”: “abde9e38-2ed5-4ecd-b23c-b0120e30690e”, “no_device”: null}]

11 - Create Image member

11.1 - 1.2

scpcli virtualserver image add member
--image_id <value>
--member_id <value>

Description

Add account ID as a shared Image member.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b
member_id
required
stringShared Image member IDa8f10467abfc4b87b64614ab36eb9ae4

Responses

NameDescriptionExample
created_atCreated at2025-07-22T09:00:00Z
image_idImage ID70a599e0-31e7-49b7-b260-868f441e862b
member_idShared Image member IDa8f10467abfc4b87b64614ab36eb9ae4
statusStatus of this Image member. Value of one of pending, accepted, rejected.pending
updated_atUpdated at2025-07-26T12:00:00Z

11.2 - 1.1

scpcli virtualserver image add member
--image_id <value>
--member_id <value>

Description

Add account ID as a shared Image member.

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
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b
member_id
required
stringShared Image member IDa8f10467abfc4b87b64614ab36eb9ae4

Responses

NameDescriptionExample
created_atCreated at2025-07-22T09:00:00Z
image_idImage ID70a599e0-31e7-49b7-b260-868f441e862b
member_idShared Image member IDa8f10467abfc4b87b64614ab36eb9ae4
statusStatus of this Image member. Value of one of pending, accepted, rejected.pending
updated_atUpdated at2025-07-26T12:00:00Z

11.3 - 1.0

scpcli virtualserver image add member
--image_id <value>
--member_id <value>

Description

Add account ID as a shared Image member.

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
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b
member_id
required
stringShared Image member IDa8f10467abfc4b87b64614ab36eb9ae4

Responses

NameDescriptionExample
created_atCreated at2025-07-22T09:00:00Z
image_idImage ID70a599e0-31e7-49b7-b260-868f441e862b
member_idShared Image member IDa8f10467abfc4b87b64614ab36eb9ae4
statusStatus of this Image member. Value of one of pending, accepted, rejected.pending
updated_atUpdated at2025-07-26T12:00:00Z

12 - Create Keypair

12.1 - 1.2

scpcli virtualserver keypair create
--name <value>
[--public_key <value>]
[--tags <value>]

Description

Create a new Keypair or Import a Public Key.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
name
required
stringKeypair namekeypairname
public_key
optional
stringPublic Keyssh-rsa fakeKey Generated-by-SCP
tags
optional
arrayTags'{"key": "Key", "value": "Value"}'

Responses

NameDescriptionExample
fingerprintFingerprint7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd
nameKeypair namekeypairname
private_keyPrivate key—–BEGIN RSA PRIVATE KEY—–
fakeKey
—–END RSA PRIVATE KEY—–
public_keyPublic Keyssh-rsa fakeKey Generated-by-SCP
typeKeypair typessh

12.2 - 1.1

scpcli virtualserver keypair create
--name <value>
[--public_key <value>]
[--tags <value>]

Description

Create a new Keypair or Import a Public Key.

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
required
stringKeypair namekeypairname
public_key
optional
stringPublic Keyssh-rsa fakeKey Generated-by-SCP
tags
optional
arrayTags'{"key": "Key", "value": "Value"}'

Responses

NameDescriptionExample
fingerprintFingerprint7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd
nameKeypair namekeypairname
private_keyPrivate key—–BEGIN RSA PRIVATE KEY—–
fakeKey
—–END RSA PRIVATE KEY—–
public_keyPublic Keyssh-rsa fakeKey Generated-by-SCP
typeKeypair typessh

12.3 - 1.0

scpcli virtualserver keypair create
--name <value>
[--public_key <value>]
[--tags <value>]

Description

Create a new Keypair or Import a Public Key.

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
required
stringKeypair namekeypairname
public_key
optional
stringPublic Keyssh-rsa fakeKey Generated-by-SCP
tags
optional
arrayTags'{"key": "Key", "value": "Value"}'

Responses

NameDescriptionExample
fingerprintFingerprint7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd
nameKeypair namekeypairname
private_keyPrivate key—–BEGIN RSA PRIVATE KEY—–
fakeKey
—–END RSA PRIVATE KEY—–
public_keyPublic Keyssh-rsa fakeKey Generated-by-SCP
typeKeypair typessh

13 - Create Launch Configuration

13.1 - 1.2

scpcli virtualserver launch configuration create
--server_type_id <value>
--name <value>
--keypair_name <value>
--image_id <value>
[--tags <value>]
[--user_data <value>]
[--volumes <value>]

Description

Create Launch Configuration.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
server_type_id
required
stringServer type IDs1v1m2
name
required
stringLaunch Configuration namelaunch-configuration-name
keypair_name
required
stringKeypair namekeypairname
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b
tags
optional
arrayTags'{"key": "Key", "value": "Value"}'
user_data
optional
stringA script that runs at the start of a server on Auto-Scaling Group that will use Launch Configuration.It must be Base64-encoded string and must not exceed 45,000 bytes.IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==
volumes
optional
arrayVolumes'{"boot_index": 0, "size": 104, "type": "SSD"}'

Responses

NameDescriptionExample
boot_indexBoot index0
max_iopsThe number of distinct read or write operations a volume can process in a single second.10000
max_throughputThe actual amount of data (volume) transferred to or from the storage device per second.500
sizeVolume size104
typeVolume typeSSD

13.2 - 1.1

scpcli virtualserver launch configuration create
--server_type_id <value>
--name <value>
--keypair_name <value>
--image_id <value>
[--tags <value>]
[--user_data <value>]
[--volumes <value>]

Description

Create Launch Configuration.

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
server_type_id
required
stringServer type IDs1v1m2
name
required
stringLaunch Configuration namelaunch-configuration-name
keypair_name
required
stringKeypair namekeypairname
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b
tags
optional
arrayTags'{"key": "Key", "value": "Value"}'
user_data
optional
stringA script that runs at the start of a server on Auto-Scaling Group that will use Launch Configuration.It must be Base64-encoded string and must not exceed 45,000 bytes.IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==
volumes
optional
arrayVolumes'{"boot_index": 0, "size": 104, "type": "SSD"}'

Responses

NameDescriptionExample
boot_indexBoot index0
sizeVolume size104
typeVolume typeSSD

13.3 - 1.0

scpcli virtualserver launch configuration create
--server_type_id <value>
--name <value>
--keypair_name <value>
--image_id <value>
[--tags <value>]
[--user_data <value>]
[--volumes <value>]

Description

Create Launch Configuration.

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
server_type_id
required
stringServer type IDs1v1m2
name
required
stringLaunch Configuration namelaunch-configuration-name
keypair_name
required
stringKeypair namekeypairname
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b
tags
optional
arrayTags'{"key": "Key", "value": "Value"}'
user_data
optional
stringA script that runs at the start of a server on Auto-Scaling Group that will use Launch Configuration.It must be Base64-encoded string and must not exceed 45,000 bytes.IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==
volumes
optional
arrayVolumes'{"boot_index": 0, "size": 104, "type": "SSD"}'

Responses

NameDescriptionExample
boot_indexBoot index0
sizeVolume size104
typeVolume typeSSD

14 - Create Server Group

14.1 - 1.2

scpcli virtualserver server group create
--policy <value>
--name <value>
[--tags <value>]

Description

Create server group.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
policy
required
stringServer Group policyanti-affinity
name
required
stringServer Group nameserver-group
tags
optional
arrayTags'{"key": "Key", "value": "Value"}'

Responses

NameDescriptionExample
idServer Group ID616fb98f-46ca-475e-917e-2563e5a8cd19
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
membersList of Virtual Servers belonging to Server Group[‘2a9be312-5d4b-4bc8-b2ae-35100fa9241f’]
nameServer Group nameserver-group
partition_sizeSize of partition when server group policy is partition3
policyServer Group policyanti-affinity
user_idUser ID570907805e5447be84b618450ef52o0t

14.2 - 1.1

scpcli virtualserver server group create
--policy <value>
--name <value>
[--tags <value>]

Description

Create server group.

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
policy
required
stringServer Group policyanti-affinity
name
required
stringServer Group nameserver-group
tags
optional
arrayTags'{"key": "Key", "value": "Value"}'

Responses

NameDescriptionExample
idServer Group ID616fb98f-46ca-475e-917e-2563e5a8cd19
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
membersList of Virtual Servers belonging to Server Group[‘2a9be312-5d4b-4bc8-b2ae-35100fa9241f’]
nameServer Group nameserver-group
partition_sizeSize of partition when server group policy is partition3
policyServer Group policyanti-affinity
user_idUser ID570907805e5447be84b618450ef52o0t

14.3 - 1.0

scpcli virtualserver server group create
--policy <value>
--name <value>
[--tags <value>]

Description

Create server group.

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
policy
required
stringServer Group policyanti-affinity
name
required
stringServer Group nameserver-group
tags
optional
arrayTags'{"key": "Key", "value": "Value"}'

Responses

NameDescriptionExample
idServer Group ID616fb98f-46ca-475e-917e-2563e5a8cd19
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
membersList of Virtual Servers belonging to Server Group[‘2a9be312-5d4b-4bc8-b2ae-35100fa9241f’]
nameServer Group nameserver-group
partition_sizeSize of partition when server group policy is partition3
policyServer Group policyanti-affinity
user_idUser ID570907805e5447be84b618450ef52o0t

15 - Create Server Interface

15.1 - 1.2

scpcli virtualserver server add interface
--server_id <value>
[--fixed_ips <value>]
[--port_id <value>]
[--subnet_id <value>]

Description

Create a new network port to the virtual server, or add an existing network port.

When creating a new network port, enter the subnet ID. IP can be set to auto-generate or user input fixed ips.

If you want to add an existing network port, enter the port ID.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
fixed_ips
optional
arrayFixed IP list'{"ip_address": "192.169.3.2"}'
port_id
optional
stringPort ID91424c08-0b26-49fb-9808-ed042292ceef
subnet_id
optional
stringSubnet ID78b2ee3f074145c580ab6abac4821f97

Responses

NameDescriptionExample
ip_addressIP address192.169.3.2

15.2 - 1.1

scpcli virtualserver server add interface
--server_id <value>
[--fixed_ips <value>]
[--port_id <value>]
[--subnet_id <value>]

Description

Create a new network port to the virtual server, or add an existing network port.

When creating a new network port, enter the subnet ID. IP can be set to auto-generate or user input fixed ips.

If you want to add an existing network port, enter the port ID.

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
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
fixed_ips
optional
arrayFixed IP list'{"ip_address": "192.169.3.2"}'
port_id
optional
stringPort ID91424c08-0b26-49fb-9808-ed042292ceef
subnet_id
optional
stringSubnet ID78b2ee3f074145c580ab6abac4821f97

Responses

NameDescriptionExample
ip_addressIP address192.169.3.2

15.3 - 1.0

scpcli virtualserver server add interface
--server_id <value>
[--fixed_ips <value>]
[--port_id <value>]
[--subnet_id <value>]

Description

Create a new network port to the virtual server, or add an existing network port.

When creating a new network port, enter the subnet ID. IP can be set to auto-generate or user input fixed ips.

If you want to add an existing network port, enter the port ID.

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
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
fixed_ips
optional
arrayFixed IP list'{"ip_address": "192.169.3.2"}'
port_id
optional
stringPort ID91424c08-0b26-49fb-9808-ed042292ceef
subnet_id
optional
stringSubnet ID78b2ee3f074145c580ab6abac4821f97

Responses

NameDescriptionExample
ip_addressIP address192.169.3.2

16 - Create Server Interface Nat

16.1 - 1.2

scpcli virtualserver server interface add static nat
--port_id <value>
--server_id <value>
--publicip_id <value>

Description

Create Server Interface Public Nat.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID91424c08-0b26-49fb-9808-ed042292ceef
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
publicip_id
required
stringPublic IP ID615fa9cd5cff486c9de679b3ce63e601

Responses

NameDescriptionExample

16.2 - 1.1

scpcli virtualserver server interface add static nat
--port_id <value>
--server_id <value>
--publicip_id <value>

Description

Create Server Interface Public Nat.

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
port_id
required
stringPort ID91424c08-0b26-49fb-9808-ed042292ceef
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
publicip_id
required
stringPublic IP ID615fa9cd5cff486c9de679b3ce63e601

Responses

NameDescriptionExample

16.3 - 1.0

scpcli virtualserver server interface add static nat
--port_id <value>
--server_id <value>
--publicip_id <value>

Description

Create Server Interface Public Nat.

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
port_id
required
stringPort ID91424c08-0b26-49fb-9808-ed042292ceef
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
publicip_id
required
stringPublic IP ID615fa9cd5cff486c9de679b3ce63e601

Responses

NameDescriptionExample

17 - Create Server Interface Private Nat

17.1 - 1.2

scpcli virtualserver server interface add private static nat
--port_id <value>
--server_id <value>
--private_nat_ip_id <value>
--private_nat_id <value>

Description

Create Server Interface Private Nat.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID91424c08-0b26-49fb-9808-ed042292ceef
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
private_nat_ip_id
required
stringPrivate NAT IP ID1f0cb5390c40483592ddc5a282f53496
private_nat_id
required
stringPrivate NAT ID3a6c1dc6b1b24e02a444d672c2798a1c

Responses

NameDescriptionExample

17.2 - 1.1

scpcli virtualserver server interface add private static nat
--port_id <value>
--server_id <value>
--private_nat_ip_id <value>
--private_nat_id <value>

Description

Create Server Interface Private Nat.

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
port_id
required
stringPort ID91424c08-0b26-49fb-9808-ed042292ceef
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
private_nat_ip_id
required
stringPrivate NAT IP ID1f0cb5390c40483592ddc5a282f53496
private_nat_id
required
stringPrivate NAT ID3a6c1dc6b1b24e02a444d672c2798a1c

Responses

NameDescriptionExample

17.3 - 1.0

scpcli virtualserver server interface add private static nat
--port_id <value>
--server_id <value>
--private_nat_ip_id <value>
--private_nat_id <value>

Description

Create Server Interface Private Nat.

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
port_id
required
stringPort ID91424c08-0b26-49fb-9808-ed042292ceef
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
private_nat_ip_id
required
stringPrivate NAT IP ID1f0cb5390c40483592ddc5a282f53496
private_nat_id
required
stringPrivate NAT ID3a6c1dc6b1b24e02a444d672c2798a1c

Responses

NameDescriptionExample

18 - Create Server Volume

18.1 - 1.2

scpcli virtualserver server add volume
--server_id <value>
--volume_id <value>
[--delete_on_termination <value>]
[--device <value>]

Description

Attach volume that are created to server.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
delete_on_termination
optional
booleanDelete the boot volume when the server is terminated.False
device
optional
stringDevice name such as, /dev/vda./dev/vda

Responses

NameDescriptionExample
idVolume Attachment ID3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c
delete_on_terminationDelete the boot volume when the server is terminated.False
deviceDevice name such as, /dev/vda./dev/vda
server_idServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_idVolume ID3f500f00-ed80-4566-a057-e31760226f9a

18.2 - 1.1

scpcli virtualserver server add volume
--server_id <value>
--volume_id <value>
[--delete_on_termination <value>]
[--device <value>]

Description

Attach volume that are created to server.

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
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
delete_on_termination
optional
booleanDelete the boot volume when the server is terminated.False
device
optional
stringDevice name such as, /dev/vda./dev/vda

Responses

NameDescriptionExample
idVolume Attachment ID3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c
delete_on_terminationDelete the boot volume when the server is terminated.False
deviceDevice name such as, /dev/vda./dev/vda
server_idServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_idVolume ID3f500f00-ed80-4566-a057-e31760226f9a

18.3 - 1.0

scpcli virtualserver server add volume
--server_id <value>
--volume_id <value>
[--delete_on_termination <value>]
[--device <value>]

Description

Attach volume that are created to server.

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
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
delete_on_termination
optional
booleanDelete the boot volume when the server is terminated.False
device
optional
stringDevice name such as, /dev/vda./dev/vda

Responses

NameDescriptionExample
idVolume Attachment ID3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c
delete_on_terminationDelete the boot volume when the server is terminated.False
deviceDevice name such as, /dev/vda./dev/vda
server_idServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_idVolume ID3f500f00-ed80-4566-a057-e31760226f9a

19 - Create Sharing Image

19.1 - 1.2

scpcli virtualserver sharing image create
--image_id <value>

Description

Create Sharing Image.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b

Responses

NameDescriptionExample

19.2 - 1.1

scpcli virtualserver sharing image create
--image_id <value>

Description

Create Sharing Image.

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
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b

Responses

NameDescriptionExample

19.3 - 1.0

scpcli virtualserver sharing image create
--image_id <value>

Description

Create Sharing Image.

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
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b

Responses

NameDescriptionExample

20 - Create Virtual Server

20.1 - 1.2

scpcli virtualserver server create
--volumes <value>
--server_type_id <value>
--networks <value>
--name <value>
--keypair_name <value>
--image_id <value>
[--file_storage_ids <value>]
[--lock <value>]
[--max_count <value>]
[--metadata <value>]
[--partition_number <value>]
[--product_category <value>]
[--product_offering <value>]
[--security_groups <value>]
[--server_group_id <value>]
[--tags <value>]
[--user_data <value>]

Description

Create Virtual Server.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
volumes
required
arrayVolumes'{"boot_index": 0, "delete_on_termination": false, "max_iops": 10000, "max_throughput": 500, "size": 104, "source_type": "image", "type": "SSD"}'
server_type_id
required
stringServer type IDs1v1m2
networks
required
arrayList of Network'{"fixed_ip": "192.169.3.2", "port_id": "91424c08-0b26-49fb-9808-ed042292ceef", "public_ip_id": "615fa9cd5cff486c9de679b3ce63e601", "subnet_id": "78b2ee3f074145c580ab6abac4821f97"}'
name
required
stringServer nameservername
keypair_name
required
stringKeypair namekeypairname
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b
file_storage_ids
optional
arrayFile Storage ID list96d258ea-dd5d-4cca-bb3a-b6909b7e2065
lock
optional
booleanSets the server's lock status. When the server is locked, most user actions are not allowed.False
max_count
optional
integerMaximum number of servers to launch.2
metadata
optional
objectUser can specify custom server metadata as a set of key-value pairs.-
partition_number
optional
integerSets the target partition number for server creation. only usable if server group type is partition.1
product_category
optional
****Product categorycompute
product_offering
optional
****Product offeringvirtual_server
security_groups
optional
arraySecurity Groupsc09c3f05-03d9-443f-b27a-40e0f973c75f
server_group_id
optional
stringServer Group ID616fb98f-46ca-475e-917e-2563e5a8cd19
tags
optional
arrayTags'{"key": "Key", "value": "Value"}'
user_data
optional
stringScript or configuration to run when the server starts. it must be Base64-encoded string and must not exceed 65535 bytes.IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==

Responses

NameDescriptionExample
idServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

20.2 - 1.1

scpcli virtualserver server create
--server_type_id <value>
--networks <value>
--name <value>
--keypair_name <value>
--image_id <value>
[--lock <value>]
[--max_count <value>]
[--metadata <value>]
[--partition_number <value>]
[--product_category <value>]
[--product_offering <value>]
[--security_groups <value>]
[--server_group_id <value>]
[--tags <value>]
[--user_data <value>]
[--volumes <value>]

Description

Create Virtual Server.

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
server_type_id
required
stringServer type IDs1v1m2
networks
required
arrayList of Network'{"fixed_ip": "192.169.3.2", "port_id": "91424c08-0b26-49fb-9808-ed042292ceef", "public_ip_id": "615fa9cd5cff486c9de679b3ce63e601", "subnet_id": "78b2ee3f074145c580ab6abac4821f97"}'
name
required
stringServer nameservername
keypair_name
required
stringKeypair namekeypairname
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b
lock
optional
booleanSets the server's lock status. When the server is locked, most user actions are not allowed.False
max_count
optional
integerMaximum number of servers to launch.2
metadata
optional
objectUser can specify custom server metadata as a set of key-value pairs.-
partition_number
optional
integerSets the target partition number for server creation. only usable if server group type is partition.1
product_category
optional
****Product categorycompute
product_offering
optional
****Product offeringvirtual_server
security_groups
optional
arraySecurity Groupsc09c3f05-03d9-443f-b27a-40e0f973c75f
server_group_id
optional
stringServer Group ID616fb98f-46ca-475e-917e-2563e5a8cd19
tags
optional
arrayTags'{"key": "Key", "value": "Value"}'
user_data
optional
stringScript or configuration to run when the server starts. it must be Base64-encoded string and must not exceed 65535 bytes.IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==
volumes
optional
arrayVolumes'{"boot_index": 0, "delete_on_termination": false, "size": 104, "source_type": "image", "type": "SSD"}'

Responses

NameDescriptionExample
idServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

20.3 - 1.0

scpcli virtualserver server create
--server_type_id <value>
--networks <value>
--name <value>
--keypair_name <value>
--image_id <value>
[--lock <value>]
[--max_count <value>]
[--metadata <value>]
[--partition_number <value>]
[--product_category <value>]
[--product_offering <value>]
[--security_groups <value>]
[--server_group_id <value>]
[--tags <value>]
[--user_data <value>]
[--volumes <value>]

Description

Create Virtual Server.

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
server_type_id
required
stringServer type IDs1v1m2
networks
required
arrayList of Network'{"fixed_ip": "192.169.3.2", "port_id": "91424c08-0b26-49fb-9808-ed042292ceef", "public_ip_id": "615fa9cd5cff486c9de679b3ce63e601", "subnet_id": "78b2ee3f074145c580ab6abac4821f97"}'
name
required
stringServer nameservername
keypair_name
required
stringKeypair namekeypairname
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b
lock
optional
booleanSets the server's lock status. When the server is locked, most user actions are not allowed.False
max_count
optional
integerMaximum number of servers to launch.2
metadata
optional
objectUser can specify custom server metadata as a set of key-value pairs.-
partition_number
optional
integerSets the target partition number for server creation. only usable if server group type is partition.1
product_category
optional
****Product categorycompute
product_offering
optional
****Product offeringvirtual_server
security_groups
optional
arraySecurity Groupsc09c3f05-03d9-443f-b27a-40e0f973c75f
server_group_id
optional
stringServer Group ID616fb98f-46ca-475e-917e-2563e5a8cd19
tags
optional
arrayTags'{"key": "Key", "value": "Value"}'
user_data
optional
stringScript or configuration to run when the server starts. it must be Base64-encoded string and must not exceed 65535 bytes.IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==
volumes
optional
arrayVolumes'{"boot_index": 0, "delete_on_termination": false, "size": 104, "source_type": "image", "type": "SSD"}'

Responses

NameDescriptionExample
idServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

21 - Create Virtual Server Custom Image

21.1 - 1.2

scpcli virtualserver server image create
--server_id <value>
--image_name <value>

Description

Create Virtual Server Custom Image.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
image_name
required
stringImage nameimagename

Responses

NameDescriptionExample
image_idImage ID70a599e0-31e7-49b7-b260-868f441e862b

21.2 - 1.1

scpcli virtualserver server image create
--server_id <value>
--image_name <value>

Description

Create Virtual Server Custom Image.

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
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
image_name
required
stringImage nameimagename

Responses

NameDescriptionExample
image_idImage ID70a599e0-31e7-49b7-b260-868f441e862b

21.3 - 1.0

scpcli virtualserver server image create
--server_id <value>
--image_name <value>

Description

Create Virtual Server Custom Image.

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
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
image_name
required
stringImage nameimagename

Responses

NameDescriptionExample
image_idImage ID70a599e0-31e7-49b7-b260-868f441e862b

22 - Create Virtual Server Dump

22.1 - 1.2

scpcli virtualserver server dump create
--server_id <value>

Description

Create Virtual Server Dump.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample

22.2 - 1.1

scpcli virtualserver server dump create
--server_id <value>

Description

Create Virtual Server Dump.

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
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample

22.3 - 1.0

scpcli virtualserver server dump create
--server_id <value>

Description

Create Virtual Server Dump.

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
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample

23 - Create Volume

23.1 - 1.2

scpcli virtualserver volume create
--size <value>
--name <value>
[--max_iops <value>]
[--max_throughput <value>]
[--snapshot_id <value>]
[--tags <value>]
[--volume_type <value>]

Description

Create a Volume.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
size
required
integerVolume size, in gibibytes(GiB), must be multiple of 8.104
name
required
stringVolume namevolume01
max_iops
optional
integerThe number of distinct read or write operations a volume can process in a single second.10000
max_throughput
optional
integerThe actual amount of data (volume) transferred to or from the storage device per second.500
snapshot_id
optional
stringSnapshot ID used to create the volume. when specified, request volume size must be greater than or equal to the size of the snapshot.cceed636-1f1e-4bb0-b85c-4e5b9e0bf790
tags
optional
arrayTags'{"key": "Key", "value": "Value"}'
volume_type
optional
stringSets the Volume type. if volume type is not set, the volume will be created using default type (SSD).SSD

Responses

NameDescriptionExample
idServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
attached_atThe time when the volume was attached to the server.
deviceDevice name such as, /dev/vda./dev/vda

23.2 - 1.1

scpcli virtualserver volume create
--size <value>
--name <value>
[--snapshot_id <value>]
[--tags <value>]
[--volume_type <value>]

Description

Create a Volume.

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
size
required
integerVolume size, in gibibytes(GiB), must be multiple of 8.104
name
required
stringVolume namevolume01
snapshot_id
optional
stringSnapshot ID used to create the volume. when specified, request volume size must be greater than or equal to the size of the snapshot.cceed636-1f1e-4bb0-b85c-4e5b9e0bf790
tags
optional
arrayTags'{"key": "Key", "value": "Value"}'
volume_type
optional
stringSets the Volume type. if volume type is not set, the volume will be created using default type (SSD).SSD

Responses

NameDescriptionExample
idServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
attached_atThe time when the volume was attached to the server.
deviceDevice name such as, /dev/vda./dev/vda

23.3 - 1.0

scpcli virtualserver volume create
--size <value>
--name <value>
[--snapshot_id <value>]
[--tags <value>]
[--volume_type <value>]

Description

Create a Volume.

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
size
required
integerVolume size, in gibibytes(GiB), must be multiple of 8.104
name
required
stringVolume namevolume01
snapshot_id
optional
stringSnapshot ID used to create the volume. when specified, request volume size must be greater than or equal to the size of the snapshot.cceed636-1f1e-4bb0-b85c-4e5b9e0bf790
tags
optional
arrayTags'{"key": "Key", "value": "Value"}'
volume_type
optional
stringSets the Volume type. if volume type is not set, the volume will be created using default type (SSD).SSD

Responses

NameDescriptionExample
idServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
attached_atThe time when the volume was attached to the server.
deviceDevice name such as, /dev/vda./dev/vda

24 - Delete a snapshot

24.1 - 1.2

scpcli virtualserver volume snapshot delete
--snapshot_id <value>

Description

Delete a snapshot.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
snapshot_id
required
stringSnapshot IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790

24.2 - 1.1

scpcli virtualserver volume snapshot delete
--snapshot_id <value>

Description

Delete a snapshot.

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
snapshot_id
required
stringSnapshot IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790

24.3 - 1.0

scpcli virtualserver volume snapshot delete
--snapshot_id <value>

Description

Delete a snapshot.

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
snapshot_id
required
stringSnapshot IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790

25 - Delete a volume transfer

25.1 - 1.2

scpcli virtualserver volume transfer delete
--transfer_id <value>

Description

Delete a volume transfer.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
transfer_id
required
stringVolume Transfer ID1ac231be-823b-4a4d-8ff0-aac503a7118a

25.2 - 1.1

scpcli virtualserver volume transfer delete
--transfer_id <value>

Description

Delete a volume transfer.

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
transfer_id
required
stringVolume Transfer ID1ac231be-823b-4a4d-8ff0-aac503a7118a

25.3 - 1.0

scpcli virtualserver volume transfer delete
--transfer_id <value>

Description

Delete a volume transfer.

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
transfer_id
required
stringVolume Transfer ID1ac231be-823b-4a4d-8ff0-aac503a7118a

26 - Delete Auto-Scaling Group

26.1 - 1.2

scpcli virtualserver auto scaling group delete
--auto_scaling_group_id <value>

Description

Delete Auto-Scaling Group.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

26.2 - 1.1

scpcli virtualserver auto scaling group delete
--auto_scaling_group_id <value>

Description

Delete Auto-Scaling Group.

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
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

26.3 - 1.0

scpcli virtualserver auto scaling group delete
--auto_scaling_group_id <value>

Description

Delete Auto-Scaling Group.

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
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

27 - Delete Auto-Scaling Group Notification

27.1 - 1.2

scpcli virtualserver auto scaling group notification delete
--notification_id <value>
--auto_scaling_group_id <value>

Description

Delete Auto-Scaling Group notification.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
notification_id
required
stringAuto-Scaling Group notification IDfa7fd191410744cd810a290c0b4d22b9
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

27.2 - 1.1

scpcli virtualserver auto scaling group notification delete
--notification_id <value>
--auto_scaling_group_id <value>

Description

Delete Auto-Scaling Group notification.

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
notification_id
required
stringAuto-Scaling Group notification IDfa7fd191410744cd810a290c0b4d22b9
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

27.3 - 1.0

scpcli virtualserver auto scaling group notification delete
--notification_id <value>
--auto_scaling_group_id <value>

Description

Delete Auto-Scaling Group notification.

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
notification_id
required
stringAuto-Scaling Group notification IDfa7fd191410744cd810a290c0b4d22b9
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

28 - Delete Auto-Scaling Group Policy

28.1 - 1.2

scpcli virtualserver auto scaling group policy delete
--policy_id <value>
--auto_scaling_group_id <value>

Description

Delete Auto-Scaling Group policy.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID0761d76085f54363bab07909baf69841
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

28.2 - 1.1

scpcli virtualserver auto scaling group policy delete
--policy_id <value>
--auto_scaling_group_id <value>

Description

Delete Auto-Scaling Group policy.

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
policy_id
required
stringPolicy ID0761d76085f54363bab07909baf69841
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

28.3 - 1.0

scpcli virtualserver auto scaling group policy delete
--policy_id <value>
--auto_scaling_group_id <value>

Description

Delete Auto-Scaling Group policy.

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
policy_id
required
stringPolicy ID0761d76085f54363bab07909baf69841
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

29 - Delete Auto-Scaling Group Schedule

29.1 - 1.2

scpcli virtualserver auto scaling group schedule delete
--schedule_id <value>
--auto_scaling_group_id <value>

Description

Delete Auto-Scaling Group schedule.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
schedule_id
required
stringSchedule ID43d4841abd404220af5f0904037aba71
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

29.2 - 1.1

scpcli virtualserver auto scaling group schedule delete
--schedule_id <value>
--auto_scaling_group_id <value>

Description

Delete Auto-Scaling Group schedule.

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
schedule_id
required
stringSchedule ID43d4841abd404220af5f0904037aba71
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

29.3 - 1.0

scpcli virtualserver auto scaling group schedule delete
--schedule_id <value>
--auto_scaling_group_id <value>

Description

Delete Auto-Scaling Group schedule.

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
schedule_id
required
stringSchedule ID43d4841abd404220af5f0904037aba71
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

30 - Delete Image

30.1 - 1.2

scpcli virtualserver image delete
--image_id <value>

Description

Delete Image.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b

30.2 - 1.1

scpcli virtualserver image delete
--image_id <value>

Description

Delete Image.

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
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b

30.3 - 1.0

scpcli virtualserver image delete
--image_id <value>

Description

Delete Image.

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
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b

31 - Delete Image member

31.1 - 1.2

scpcli virtualserver image remove member
--member_id <value>
--image_id <value>

Description

Delete Image member.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
member_id
required
stringShared Image member IDa8f10467abfc4b87b64614ab36eb9ae4
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b

31.2 - 1.1

scpcli virtualserver image remove member
--member_id <value>
--image_id <value>

Description

Delete Image member.

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
member_id
required
stringShared Image member IDa8f10467abfc4b87b64614ab36eb9ae4
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b

31.3 - 1.0

scpcli virtualserver image remove member
--member_id <value>
--image_id <value>

Description

Delete Image member.

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
member_id
required
stringShared Image member IDa8f10467abfc4b87b64614ab36eb9ae4
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b

32 - Delete Keypair

32.1 - 1.2

scpcli virtualserver keypair delete
--keypair_name <value>

Description

Delete keypair.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
keypair_name
required
stringKeypair namekeypairname

32.2 - 1.1

scpcli virtualserver keypair delete
--keypair_name <value>

Description

Delete keypair.

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
keypair_name
required
stringKeypair namekeypairname

32.3 - 1.0

scpcli virtualserver keypair delete
--keypair_name <value>

Description

Delete keypair.

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
keypair_name
required
stringKeypair namekeypairname

33 - Delete Launch Configuration

33.1 - 1.2

scpcli virtualserver launch configuration delete
--launch_configuration_id <value>

Description

Delete Launch Configuration.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
launch_configuration_id
required
stringLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f

33.2 - 1.1

scpcli virtualserver launch configuration delete
--launch_configuration_id <value>

Description

Delete Launch Configuration.

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
launch_configuration_id
required
stringLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f

33.3 - 1.0

scpcli virtualserver launch configuration delete
--launch_configuration_id <value>

Description

Delete Launch Configuration.

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
launch_configuration_id
required
stringLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f

34 - Delete Server Group

34.1 - 1.2

scpcli virtualserver server group delete
--server_group_id <value>

Description

Delete server group

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
server_group_id
required
stringServer Group ID616fb98f-46ca-475e-917e-2563e5a8cd19

34.2 - 1.1

scpcli virtualserver server group delete
--server_group_id <value>

Description

Delete server group

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
server_group_id
required
stringServer Group ID616fb98f-46ca-475e-917e-2563e5a8cd19

34.3 - 1.0

scpcli virtualserver server group delete
--server_group_id <value>

Description

Delete server group

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
server_group_id
required
stringServer Group ID616fb98f-46ca-475e-917e-2563e5a8cd19

35 - Delete Server Interface

35.1 - 1.2

scpcli virtualserver server remove interface
--port_id <value>
--server_id <value>

Description

Delete Server Interface.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID91424c08-0b26-49fb-9808-ed042292ceef
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

35.2 - 1.1

scpcli virtualserver server remove interface
--port_id <value>
--server_id <value>

Description

Delete Server Interface.

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
port_id
required
stringPort ID91424c08-0b26-49fb-9808-ed042292ceef
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

35.3 - 1.0

scpcli virtualserver server remove interface
--port_id <value>
--server_id <value>

Description

Delete Server Interface.

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
port_id
required
stringPort ID91424c08-0b26-49fb-9808-ed042292ceef
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

36 - Delete Server Interface Nat

36.1 - 1.2

scpcli virtualserver server interface remove static nat
--nat_id <value>
--port_id <value>
--server_id <value>

Description

Delete Server Interface Public Nat.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
nat_id
required
stringNAT ID224b80106e6f41b38efe98ac9ddbf280
port_id
required
stringPort ID91424c08-0b26-49fb-9808-ed042292ceef
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

36.2 - 1.1

scpcli virtualserver server interface remove static nat
--nat_id <value>
--port_id <value>
--server_id <value>

Description

Delete Server Interface Public Nat.

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
nat_id
required
stringNAT ID224b80106e6f41b38efe98ac9ddbf280
port_id
required
stringPort ID91424c08-0b26-49fb-9808-ed042292ceef
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

36.3 - 1.0

scpcli virtualserver server interface remove static nat
--nat_id <value>
--port_id <value>
--server_id <value>

Description

Delete Server Interface Public Nat.

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
nat_id
required
stringNAT ID224b80106e6f41b38efe98ac9ddbf280
port_id
required
stringPort ID91424c08-0b26-49fb-9808-ed042292ceef
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

37 - Delete Server Interface Private Nat

37.1 - 1.2

scpcli virtualserver server interface remove private static nat
--nat_id <value>
--port_id <value>
--server_id <value>

Description

Delete Server Interface Private Nat.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
nat_id
required
stringNAT ID224b80106e6f41b38efe98ac9ddbf280
port_id
required
stringPort ID91424c08-0b26-49fb-9808-ed042292ceef
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

37.2 - 1.1

scpcli virtualserver server interface remove private static nat
--nat_id <value>
--port_id <value>
--server_id <value>

Description

Delete Server Interface Private Nat.

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
nat_id
required
stringNAT ID224b80106e6f41b38efe98ac9ddbf280
port_id
required
stringPort ID91424c08-0b26-49fb-9808-ed042292ceef
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

37.3 - 1.0

scpcli virtualserver server interface remove private static nat
--nat_id <value>
--port_id <value>
--server_id <value>

Description

Delete Server Interface Private Nat.

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
nat_id
required
stringNAT ID224b80106e6f41b38efe98ac9ddbf280
port_id
required
stringPort ID91424c08-0b26-49fb-9808-ed042292ceef
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

38 - Delete Server Volume

38.1 - 1.2

scpcli virtualserver server remove volume
--volume_id <value>
--server_id <value>

Description

Delete Server Volume.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

38.2 - 1.1

scpcli virtualserver server remove volume
--volume_id <value>
--server_id <value>

Description

Delete Server Volume.

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
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

38.3 - 1.0

scpcli virtualserver server remove volume
--volume_id <value>
--server_id <value>

Description

Delete Server Volume.

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
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

39 - Delete Virtual Server

39.1 - 1.2

scpcli virtualserver server delete
--server_id <value>

Description

Delete Virtual Server.

  • Once deleted, the server cannot be recovered and will not be retrieved from the server list.

  • The termination of the connected storage depends on the delete on termination setting, so if necessary, from Block Storage terminate it.

In case of deletion failure.

  • File Storage connected

  • LB Server Group connected(Except VMs generated by Auto-Scaling Group)

  • Lock set

  • Backup connected

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

39.2 - 1.1

scpcli virtualserver server delete
--server_id <value>

Description

Delete Virtual Server.

  • Once deleted, the server cannot be recovered and will not be retrieved from the server list.

  • The termination of the connected storage depends on the delete on termination setting, so if necessary, from Block Storage terminate it.

In case of deletion failure.

  • File Storage connected

  • LB Server Group connected(Except VMs generated by Auto-Scaling Group)

  • Lock set

  • Backup connected

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
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

39.3 - 1.0

scpcli virtualserver server delete
--server_id <value>

Description

Delete Virtual Server.

  • Once deleted, the server cannot be recovered and will not be retrieved from the server list.

  • The termination of the connected storage depends on the delete on termination setting, so if necessary, from Block Storage terminate it.

In case of deletion failure.

  • File Storage connected

  • LB Server Group connected(Except VMs generated by Auto-Scaling Group)

  • Lock set

  • Backup connected

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
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

40 - Delete Volume

40.1 - 1.2

scpcli virtualserver volume delete
--volume_id <value>
[--cascade <value>]

Description

Delete Volume.

  • The termination of the connected storage depends on the delete on termination setting, so if necessary, from Block Storage terminate it.

If a volume cannot be deleted.

  • Connected to server

  • OS Default volume

  • Connection with custom Image of Virtual Server

  • If volume is in state other than available, error, error extending, error restoring, or error managing

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
cascade
optional
booleanWhether to delete snapshots togetherTrue

40.2 - 1.1

scpcli virtualserver volume delete
--volume_id <value>
[--cascade <value>]

Description

Delete Volume.

  • The termination of the connected storage depends on the delete on termination setting, so if necessary, from Block Storage terminate it.

If a volume cannot be deleted.

  • Connected to server

  • OS Default volume

  • Connection with custom Image of Virtual Server

  • If volume is in state other than available, error, error extending, error restoring, or error managing

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
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
cascade
optional
booleanWhether to delete snapshots togetherTrue

40.3 - 1.0

scpcli virtualserver volume delete
--volume_id <value>
[--cascade <value>]

Description

Delete Volume.

  • The termination of the connected storage depends on the delete on termination setting, so if necessary, from Block Storage terminate it.

If a volume cannot be deleted.

  • Connected to server

  • OS Default volume

  • Connection with custom Image of Virtual Server

  • If volume is in state other than available, error, error extending, error restoring, or error managing

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
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
cascade
optional
booleanWhether to delete snapshots togetherTrue

41 - Detach Virtual Server Security Group

41.1 - 1.0

scpcli virtualserver server remove security group
--security_group_id <value>
--server_id <value>

Description

Detach the Security Group from a server.

  • If a server has one or more networks attached, and the Security Group you want to detach is currently applied to all of those networks, then the Security Group will be removed from every network associated with a server.

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
security_group_id
required
stringSecurity Group IDc09c3f05-03d9-443f-b27a-40e0f973c75f
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

42 - Detach Volume from Virtual Server

42.1 - 1.2

scpcli virtualserver volume detach server
--server_id <value>
--volume_id <value>

Description

Detach the Volume from a server.

  • For the OS’s default volume, you cannot modify the attached server or cancel the service.

  • On the server, be sure to perform the disconnection steps (unmount, set the disk offline) before detaching the attached server. If a server is detached without these OS‑level actions, it may enter an error state (Hang).

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a

42.2 - 1.1

scpcli virtualserver volume detach server
--server_id <value>
--volume_id <value>

Description

Detach the Volume from a server.

  • For the OS’s default volume, you cannot modify the attached server or cancel the service.

  • On the server, be sure to perform the disconnection steps (unmount, set the disk offline) before detaching the attached server. If a server is detached without these OS‑level actions, it may enter an error state (Hang).

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
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a

42.3 - 1.0

scpcli virtualserver volume detach server
--server_id <value>
--volume_id <value>

Description

Detach the Volume from a server.

  • For the OS’s default volume, you cannot modify the attached server or cancel the service.

  • On the server, be sure to perform the disconnection steps (unmount, set the disk offline) before detaching the attached server. If a server is detached without these OS‑level actions, it may enter an error state (Hang).

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
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a

43 - Extend Volume

43.1 - 1.2

scpcli virtualserver volume resize
--volume_id <value>
--size <value>

Description

Increase the volume capacity.

  • Volume capacity can only be increased, reduction is not supported.

  • When increasing capacity, recovery is possible only by creating new volume from a previously taken snapshot (i.e., the snapshot can be used solely for the new‑volume creation method).

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
size
required
integerVolume size104

43.2 - 1.1

scpcli virtualserver volume resize
--volume_id <value>
--size <value>

Description

Increase the volume capacity.

  • Volume capacity can only be increased, reduction is not supported.

  • When increasing capacity, recovery is possible only by creating new volume from a previously taken snapshot (i.e., the snapshot can be used solely for the new‑volume creation method).

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
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
size
required
integerVolume size104

43.3 - 1.0

scpcli virtualserver volume resize
--volume_id <value>
--size <value>

Description

Increase the volume capacity.

  • Volume capacity can only be increased, reduction is not supported.

  • When increasing capacity, recovery is possible only by creating new volume from a previously taken snapshot (i.e., the snapshot can be used solely for the new‑volume creation method).

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
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
size
required
integerVolume size104

44 - Get region's maximum partition size.

44.1 - 1.2

scpcli virtualserver server group maximum partition size

Description

Get region’s maximum partition size

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Responses

NameDescriptionExample
partition_size

44.2 - 1.1

scpcli virtualserver server group maximum partition size

Description

Get region’s maximum partition size

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

Responses

NameDescriptionExample
partition_size

44.3 - 1.0

scpcli virtualserver server group maximum partition size

Description

Get region’s maximum partition size

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

Responses

NameDescriptionExample
partition_size

45 - Import Image

45.1 - 1.2

scpcli virtualserver image import
--image_id <value>
--url <value>

Description

Connect an external image file to use as an image resource.

  • You need the URL of the image file uploaded to Object Storage.

  • The Object Storage bucket containing the image must be in the same zone as the server you are creating.

  • The image file must have a .qcow2 extension.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b
url
required
stringObject Storage URL for Image file (only qcow2 format allowed)https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2

Responses

NameDescriptionExample

45.2 - 1.1

scpcli virtualserver image import
--image_id <value>
--url <value>

Description

Connect an external image file to use as an image resource.

  • You need the URL of the image file uploaded to Object Storage.

  • The Object Storage bucket containing the image must be in the same zone as the server you are creating.

  • The image file must have a .qcow2 extension.

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
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b
url
required
stringObject Storage URL for Image file (only qcow2 format allowed)https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2

Responses

NameDescriptionExample

45.3 - 1.0

scpcli virtualserver image import
--image_id <value>
--url <value>

Description

Connect an external image file to use as an image resource.

  • You need the URL of the image file uploaded to Object Storage.

  • The Object Storage bucket containing the image must be in the same zone as the server you are creating.

  • The image file must have a .qcow2 extension.

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
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b
url
required
stringObject Storage URL for Image file (only qcow2 format allowed)https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2

Responses

NameDescriptionExample

46 - List Auto-Scaling Group LB Server Groups

46.1 - 1.2

scpcli virtualserver auto scaling group lb server group list
--auto_scaling_group_id <value>
[--offset <value>]
[--limit <value>]
[--sort <value>]

Description

List Auto-Scaling Group LB Server Groups.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
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
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameLB Server Group namelb-server-group-name
portLB Server Group port8080

46.2 - 1.1

scpcli virtualserver auto scaling group lb server group list
--auto_scaling_group_id <value>
[--offset <value>]
[--limit <value>]
[--sort <value>]

Description

List Auto-Scaling Group LB Server 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
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
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
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameLB Server Group namelb-server-group-name
portLB Server Group port8080

46.3 - 1.0

scpcli virtualserver auto scaling group lb server group list
--auto_scaling_group_id <value>
[--offset <value>]
[--limit <value>]
[--sort <value>]

Description

List Auto-Scaling Group LB Server 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
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
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
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameLB Server Group namelb-server-group-name
portLB Server Group port8080

47 - List Auto-Scaling Group Notifications

47.1 - 1.2

scpcli virtualserver auto scaling group notification list
--auto_scaling_group_id <value>
[--user_ids <value>]
[--notification_state <value>]
[--notification_event <value>]
[--offset <value>]
[--limit <value>]
[--sort <value>]

Description

List Auto-Scaling Group notifications.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
user_ids
optional
arrayUser ID list570907805e5447be84b618450ef52o0t
notification_state
optional
stringAuto-Scaling Group notification stateACTIVE
notification_event
optional
stringAuto-Scaling Group notification eventSCALE_OUT
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 IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_idAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
notification_eventsAuto-Scaling Group notification event list[‘SCALE_OUT’, ‘SCALE_OUT_FAIL’]
notification_stateAuto-Scaling Group notification stateACTIVE
user_emailUser emailscpuser@samsung.com
user_idUser ID570907805e5447be84b618450ef52o0t
user_nameUser namescpuser

47.2 - 1.1

scpcli virtualserver auto scaling group notification list
--auto_scaling_group_id <value>
[--user_ids <value>]
[--notification_state <value>]
[--notification_event <value>]
[--offset <value>]
[--limit <value>]
[--sort <value>]

Description

List Auto-Scaling Group notifications.

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
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
user_ids
optional
arrayUser ID list570907805e5447be84b618450ef52o0t
notification_state
optional
stringAuto-Scaling Group notification stateACTIVE
notification_event
optional
stringAuto-Scaling Group notification eventSCALE_OUT
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 IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_idAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
notification_eventsAuto-Scaling Group notification event list[‘SCALE_OUT’, ‘SCALE_OUT_FAIL’]
notification_stateAuto-Scaling Group notification stateACTIVE
user_emailUser emailscpuser@samsung.com
user_idUser ID570907805e5447be84b618450ef52o0t
user_nameUser namescpuser

47.3 - 1.0

scpcli virtualserver auto scaling group notification list
--auto_scaling_group_id <value>
[--user_ids <value>]
[--notification_state <value>]
[--notification_event <value>]
[--offset <value>]
[--limit <value>]
[--sort <value>]

Description

List Auto-Scaling Group notifications.

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
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
user_ids
optional
arrayUser ID list570907805e5447be84b618450ef52o0t
notification_state
optional
stringAuto-Scaling Group notification stateACTIVE
notification_event
optional
stringAuto-Scaling Group notification eventSCALE_OUT
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 IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_idAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
notification_eventsAuto-Scaling Group notification event list[‘SCALE_OUT’, ‘SCALE_OUT_FAIL’]
notification_stateAuto-Scaling Group notification stateACTIVE
user_emailUser emailscpuser@samsung.com
user_idUser ID570907805e5447be84b618450ef52o0t
user_nameUser namescpuser

48 - List Auto-Scaling Group Policies

48.1 - 1.2

scpcli virtualserver auto scaling group policy list
--auto_scaling_group_id <value>
[--name <value>]
[--metric_method <value>]
[--metric_type <value>]
[--scale_type <value>]
[--offset <value>]
[--limit <value>]
[--sort <value>]

Description

List Auto-Scaling Group policies.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
name
optional
stringPolicy namepolicy-name
metric_method
optional
****Metric methodAVG
metric_type
optional
stringMetric typeCPU
scale_type
optional
****Scale typeSCALE_OUT
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 IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_idAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
comparison_operatorComparison operatorge
cooldown_secondsCooldown seconds300
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
evaluation_minutesEvaluation minutes5
metric_methodMetric methodAVG
metric_typeMetric typeCPU
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePolicy namepolicy-name
scale_methodScale methodAMOUNT
scale_typeScale typeSCALE_OUT
scale_valueScale value10
statePolicy stateACTIVE
thresholdThreshold60
threshold_unitThreshold unit%

48.2 - 1.1

scpcli virtualserver auto scaling group policy list
--auto_scaling_group_id <value>
[--name <value>]
[--metric_method <value>]
[--metric_type <value>]
[--scale_type <value>]
[--offset <value>]
[--limit <value>]
[--sort <value>]

Description

List Auto-Scaling Group policies.

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
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
name
optional
stringPolicy namepolicy-name
metric_method
optional
****Metric methodAVG
metric_type
optional
stringMetric typeCPU
scale_type
optional
****Scale typeSCALE_OUT
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 IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_idAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
comparison_operatorComparison operatorge
cooldown_secondsCooldown seconds300
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
evaluation_minutesEvaluation minutes5
metric_methodMetric methodAVG
metric_typeMetric typeCPU
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePolicy namepolicy-name
scale_methodScale methodAMOUNT
scale_typeScale typeSCALE_OUT
scale_valueScale value10
statePolicy stateACTIVE
thresholdThreshold60
threshold_unitThreshold unit%

48.3 - 1.0

scpcli virtualserver auto scaling group policy list
--auto_scaling_group_id <value>
[--name <value>]
[--metric_method <value>]
[--metric_type <value>]
[--scale_type <value>]
[--offset <value>]
[--limit <value>]
[--sort <value>]

Description

List Auto-Scaling Group policies.

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
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
name
optional
stringPolicy namepolicy-name
metric_method
optional
****Metric methodAVG
metric_type
optional
stringMetric typeCPU
scale_type
optional
****Scale typeSCALE_OUT
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 IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_idAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
comparison_operatorComparison operatorge
cooldown_secondsCooldown seconds300
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
evaluation_minutesEvaluation minutes5
metric_methodMetric methodAVG
metric_typeMetric typeCPU
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePolicy namepolicy-name
scale_methodScale methodAMOUNT
scale_typeScale typeSCALE_OUT
scale_valueScale value10
statePolicy stateACTIVE
thresholdThreshold60
threshold_unitThreshold unit%

49 - List Auto-Scaling Group Schedules

49.1 - 1.2

scpcli virtualserver auto scaling group schedule list
--auto_scaling_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--frequency <value>]

Description

Get Auto-Scaling Group schedule list.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
frequency
optional
****FrequencyWEEKLY

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
day_of_monthDay of the month-1,1
day_of_weekDay of the weekSU,SA
descriptionDescriptiondescription
desired_server_countDesired server count1
end_dateEnd date2025-01-01
frequencyFrequencyWEEKLY
hourHour9
max_server_countMax server count2
min_server_countMin server count1
minuteMinute0
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSchedule nameschedulename
start_dateStart date2024-01-01
stateSchedule stateACTIVE
timezoneTimezoneAsia/Seoul

49.2 - 1.1

scpcli virtualserver auto scaling group schedule list
--auto_scaling_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--frequency <value>]

Description

Get Auto-Scaling Group schedule list.

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
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
frequency
optional
****FrequencyWEEKLY

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
day_of_monthDay of the month-1,1
day_of_weekDay of the weekSU,SA
descriptionDescriptiondescription
desired_server_countDesired server count1
end_dateEnd date2025-01-01
frequencyFrequencyWEEKLY
hourHour9
max_server_countMax server count2
min_server_countMin server count1
minuteMinute0
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSchedule nameschedulename
start_dateStart date2024-01-01
stateSchedule stateACTIVE
timezoneTimezoneAsia/Seoul

49.3 - 1.0

scpcli virtualserver auto scaling group schedule list
--auto_scaling_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--frequency <value>]

Description

Get Auto-Scaling Group schedule list.

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
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
frequency
optional
****FrequencyWEEKLY

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
day_of_monthDay of the month-1,1
day_of_weekDay of the weekSU,SA
descriptionDescriptiondescription
desired_server_countDesired server count1
end_dateEnd date2025-01-01
frequencyFrequencyWEEKLY
hourHour9
max_server_countMax server count2
min_server_countMin server count1
minuteMinute0
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSchedule nameschedulename
start_dateStart date2024-01-01
stateSchedule stateACTIVE
timezoneTimezoneAsia/Seoul

50 - List Auto-Scaling Group Virtual Servers

50.1 - 1.2

scpcli virtualserver auto scaling group server list
--auto_scaling_group_id <value>
[--marker <value>]
[--limit <value>]
[--sort <value>]

Description

List Auto-Scaling Group Virtual Servers.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
marker
optional
stringThe last item's ID from previous request2a9be312-5d4b-4bc8-b2ae-35100fa9241f
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
idServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
addressesAddresses
auto_scaling_group_idAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
created_atCreated at
created_byCreated by97e6b22c9a4143789ca522df7457a32f
disk_configDisk configMANUAL
image_idImage ID70a599e0-31e7-49b7-b260-868f441e862b
is_asg_virtual_server_healthyHealth state of ASG Virtual ServerTrue
is_lb_healthyLB Health State of ASG Virtual ServerTrue
is_marketplaceIs MarketplaceFalse
keypair_nameKeypair namekeypairname
launch_configuration_idLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f
lb_linked_stateLoad Balancer linked stateATTACHED
lockedLockedFalse
metadataMetadata
modified_atModified at
nameServer nameservername
partition_numberPartition number1
planned_compute_os_typePlanned Compute OS typewindows
product_categoryProduct categorycompute
product_offeringProduct offeringvirtual_server
security_groupsSecurity Groups
server_group_idServer Group ID616fb98f-46ca-475e-917e-2563e5a8cd19
server_typeServer type
stateServer stateACTIVE
volumesVolumes
vpc_idVPC IDcc976b621087484ea5fd527f4b78708b

50.2 - 1.1

scpcli virtualserver auto scaling group server list
--auto_scaling_group_id <value>
[--marker <value>]
[--limit <value>]
[--sort <value>]

Description

List Auto-Scaling Group Virtual Servers.

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
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
marker
optional
stringThe last item's ID from previous request2a9be312-5d4b-4bc8-b2ae-35100fa9241f
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
idServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
addressesAddresses
auto_scaling_group_idAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
created_atCreated at
created_byCreated by97e6b22c9a4143789ca522df7457a32f
disk_configDisk configMANUAL
image_idImage ID70a599e0-31e7-49b7-b260-868f441e862b
is_marketplaceIs MarketplaceFalse
keypair_nameKeypair namekeypairname
launch_configuration_idLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f
lb_linked_stateLoad Balancer linked stateATTACHED
lockedLockedFalse
metadataMetadata
modified_atModified at
nameServer nameservername
partition_numberPartition number1
planned_compute_os_typePlanned Compute OS typewindows
product_categoryProduct categorycompute
product_offeringProduct offeringvirtual_server
security_groupsSecurity Groups
server_group_idServer Group ID616fb98f-46ca-475e-917e-2563e5a8cd19
server_typeServer type
stateServer stateACTIVE
volumesVolumes
vpc_idVPC IDcc976b621087484ea5fd527f4b78708b

50.3 - 1.0

scpcli virtualserver auto scaling group server list
--auto_scaling_group_id <value>
[--marker <value>]
[--limit <value>]
[--sort <value>]

Description

List Auto-Scaling Group Virtual Servers.

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
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
marker
optional
stringThe last item's ID from previous request2a9be312-5d4b-4bc8-b2ae-35100fa9241f
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
idServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
addressesAddresses
auto_scaling_group_idAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
created_atCreated at
created_byCreated by97e6b22c9a4143789ca522df7457a32f
disk_configDisk configMANUAL
image_idImage ID70a599e0-31e7-49b7-b260-868f441e862b
is_marketplaceIs MarketplaceFalse
keypair_nameKeypair namekeypairname
launch_configuration_idLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f
lb_linked_stateLoad Balancer linked stateATTACHED
lockedLockedFalse
metadataMetadata
modified_atModified at
nameServer nameservername
partition_numberPartition number1
planned_compute_os_typePlanned Compute OS typewindows
product_categoryProduct categorycompute
product_offeringProduct offeringvirtual_server
security_groupsSecurity Groups
server_group_idServer Group ID616fb98f-46ca-475e-917e-2563e5a8cd19
server_typeServer type
stateServer stateACTIVE
volumesVolumes
vpc_idVPC IDcc976b621087484ea5fd527f4b78708b

51 - List Auto-Scaling Groups

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

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

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

52 - List Default Configs

52.1 - 1.2

scpcli virtualserver default config list
[--name <value>]
[--category <value>]

Description

Retrieves a list of default configuration values, including resource‑usage limits, thresholds, and related settings.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
name
optional
stringNamekey
category
optional
stringCategoryAUTO_SCALING_GROUP

Responses

NameDescriptionExample
configsConfigs(‘key’: ‘value’}
countcount20

52.2 - 1.1

scpcli virtualserver default config list
[--name <value>]
[--category <value>]

Description

Retrieves a list of default configuration values, including resource‑usage limits, thresholds, and related settings.

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
stringNamekey
category
optional
stringCategoryAUTO_SCALING_GROUP

Responses

NameDescriptionExample
configsConfigs(‘key’: ‘value’}
countcount20

52.3 - 1.0

scpcli virtualserver default config list
[--name <value>]
[--category <value>]

Description

Retrieves a list of default configuration values, including resource‑usage limits, thresholds, and related settings.

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
stringNamekey
category
optional
stringCategoryAUTO_SCALING_GROUP

Responses

NameDescriptionExample
configsConfigs(‘key’: ‘value’}
countcount20

53 - List Image members

53.1 - 1.2

scpcli virtualserver image member list
--image_id <value>

Description

Retrieves the list of account members with whom the image owner has shared the image.

  • You can request image sharing between accounts.

  • Image members have read‑only permission on the image.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b

Responses

NameDescriptionExample
created_atCreated at2025-07-22T09:00:00Z
image_idImage ID70a599e0-31e7-49b7-b260-868f441e862b
member_idShared Image member IDa8f10467abfc4b87b64614ab36eb9ae4
statusStatus of this Image member. Value of one of pending, accepted, rejected.pending
updated_atUpdated at2025-07-26T12:00:00Z

53.2 - 1.1

scpcli virtualserver image member list
--image_id <value>

Description

Retrieves the list of account members with whom the image owner has shared the image.

  • You can request image sharing between accounts.

  • Image members have read‑only permission on the image.

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
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b

Responses

NameDescriptionExample
created_atCreated at2025-07-22T09:00:00Z
image_idImage ID70a599e0-31e7-49b7-b260-868f441e862b
member_idShared Image member IDa8f10467abfc4b87b64614ab36eb9ae4
statusStatus of this Image member. Value of one of pending, accepted, rejected.pending
updated_atUpdated at2025-07-26T12:00:00Z

53.3 - 1.0

scpcli virtualserver image member list
--image_id <value>

Description

Retrieves the list of account members with whom the image owner has shared the image.

  • You can request image sharing between accounts.

  • Image members have read‑only permission on the image.

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
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b

Responses

NameDescriptionExample
created_atCreated at2025-07-22T09:00:00Z
image_idImage ID70a599e0-31e7-49b7-b260-868f441e862b
member_idShared Image member IDa8f10467abfc4b87b64614ab36eb9ae4
statusStatus of this Image member. Value of one of pending, accepted, rejected.pending
updated_atUpdated at2025-07-26T12:00:00Z

54 - List Images

54.1 - 1.2

scpcli virtualserver image list
[--limit <value>]
[--marker <value>]
[--scp_image_type <value>]
[--scp_original_image_type <value>]
[--name <value>]
[--os_distro <value>]
[--status <value>]
[--visibility <value>]
[--sort <value>]
[--long]

Description

List Images.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
limit
optional
integerPage size of items20
marker
optional
stringThe last item's ID from previous request2a9be312-5d4b-4bc8-b2ae-35100fa9241f
scp_image_type
optional
stringImage typecustom
scp_original_image_type
optional
stringOriginal Image typestandard
name
optional
stringImage nameimagename
os_distro
optional
stringOS distribution of the image to be uploadedalma
status
optional
stringImage statusactive
visibility
optional
****Indicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accountsprivate
sort
optional
stringComma-separated list of sort keys and optional sort directions in the form of [:]created_at:desc

Responses

NameDescriptionExample
idImage ID70a599e0-31e7-49b7-b260-868f441e862b
checksumMD5 hash of the entire image data. and this field could be used to verify the integrity of image.
Requires --long option
7538e0fcb56e0e272cfd89eb384d6613
container_formatContainer format
Requires --long option
bare
created_atCreated at2025-07-22T09:00:00Z
disk_formatDisk format
Requires --long option
qcow2
fileThe URL for the virtual server image file
Requires --long option
/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file
min_diskMinimum disk capacity (GB) of the Image to be created
Requires --long option
100
min_ramMinimum RAM capacity (GB) of the Image to be created
Requires --long option
0
nameImage nameimagename
os_distroOS distribution of the image to be uploadedalma
os_hash_algoOS hash algorithm used to verify image integrity
Requires --long option
sha512
os_hash_valueThe actual digest of the image binary, calculated with the algorithm indicated by os_hash_algo. The value is presented as a hexadecimal string.
Requires --long option
c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99
os_hiddenWhether the image is hidden
Requires --long option
False
ownerOwner account ID
Requires --long option
a8f10467abfc4b87b64614ab36eb9ae4
owner_account_nameOwner account name
Requires --long option
AccountName
owner_user_nameOwner user name
Requires --long option
user@samsung.com
protectedwhether Image deletion is prohibited
Requires --long option
False
root_device_nameRoot device name
Requires --long option
/dev/vda
scp_gpu_driverK8s GPU Image driver version
Requires --long option
535.183.06
scp_image_typeImage type
Requires --long option
custom
scp_k8s_versionK8S version
Requires --long option
v1.28.7
scp_original_image_typeOriginal Image type
Requires --long option
standard
scp_os_build_versionOS build version
Requires --long option
20250101
scp_os_versionOS version
Requires --long option
8.8
sizeImage size
Requires --long option
2429747200
statusImage status
Requires --long option
active
updated_atUpdated at
Requires --long option
2025-07-26T12:00:00Z
urlObject Storage URL for Image file (only qcow2 format allowed)
Requires --long option
https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2
virtual_sizeVirtual size
Requires --long option
17179869184
visibilityIndicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accountsprivate
volumesVolumes
Requires --long option
[{“tag”: null, “volume_id”: null, “encryption_options”: null, “encryption_secret_uuid”: null, “encryption_format”: null, “device_name”: “/dev/vda”, “disk_bus”: “virtio”, “volume_type”: null, “encrypted”: null, “image_id”: null, “device_type”: “disk”, “source_type”: “snapshot”, “delete_on_termination”: false, “volume_size”: 104, “guest_format”: null, “boot_index”: 0, “destination_type”: “volume”, “snapshot_id”: “abde9e38-2ed5-4ecd-b23c-b0120e30690e”, “no_device”: null}]

54.2 - 1.1

scpcli virtualserver image list
[--limit <value>]
[--marker <value>]
[--scp_image_type <value>]
[--scp_original_image_type <value>]
[--name <value>]
[--os_distro <value>]
[--status <value>]
[--visibility <value>]
[--sort <value>]
[--long]

Description

List Images.

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
limit
optional
integerPage size of items20
marker
optional
stringThe last item's ID from previous request2a9be312-5d4b-4bc8-b2ae-35100fa9241f
scp_image_type
optional
stringImage typecustom
scp_original_image_type
optional
stringOriginal Image typestandard
name
optional
stringImage nameimagename
os_distro
optional
stringOS distribution of the image to be uploadedalma
status
optional
stringImage statusactive
visibility
optional
****Indicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accountsprivate
sort
optional
stringComma-separated list of sort keys and optional sort directions in the form of [:]created_at:desc

Responses

NameDescriptionExample
idImage ID70a599e0-31e7-49b7-b260-868f441e862b
checksumMD5 hash of the entire image data. and this field could be used to verify the integrity of image.
Requires --long option
7538e0fcb56e0e272cfd89eb384d6613
container_formatContainer format
Requires --long option
bare
created_atCreated at2025-07-22T09:00:00Z
disk_formatDisk format
Requires --long option
qcow2
fileThe URL for the virtual server image file
Requires --long option
/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file
min_diskMinimum disk capacity (GB) of the Image to be created
Requires --long option
100
min_ramMinimum RAM capacity (GB) of the Image to be created
Requires --long option
0
nameImage nameimagename
os_distroOS distribution of the image to be uploadedalma
os_hash_algoOS hash algorithm used to verify image integrity
Requires --long option
sha512
os_hash_valueThe actual digest of the image binary, calculated with the algorithm indicated by os_hash_algo. The value is presented as a hexadecimal string.
Requires --long option
c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99
os_hiddenWhether the image is hidden
Requires --long option
False
ownerOwner account ID
Requires --long option
a8f10467abfc4b87b64614ab36eb9ae4
owner_account_nameOwner account name
Requires --long option
AccountName
owner_user_nameOwner user name
Requires --long option
user@samsung.com
protectedwhether Image deletion is prohibited
Requires --long option
False
root_device_nameRoot device name
Requires --long option
/dev/vda
scp_image_typeImage type
Requires --long option
custom
scp_k8s_versionK8S version
Requires --long option
v1.28.7
scp_original_image_typeOriginal Image type
Requires --long option
standard
scp_os_build_versionOS build version
Requires --long option
20250101
scp_os_versionOS version
Requires --long option
8.8
sizeImage size
Requires --long option
2429747200
statusImage status
Requires --long option
active
updated_atUpdated at
Requires --long option
2025-07-26T12:00:00Z
urlObject Storage URL for Image file (only qcow2 format allowed)
Requires --long option
https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2
virtual_sizeVirtual size
Requires --long option
17179869184
visibilityIndicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accountsprivate
volumesVolumes
Requires --long option
[{“tag”: null, “volume_id”: null, “encryption_options”: null, “encryption_secret_uuid”: null, “encryption_format”: null, “device_name”: “/dev/vda”, “disk_bus”: “virtio”, “volume_type”: null, “encrypted”: null, “image_id”: null, “device_type”: “disk”, “source_type”: “snapshot”, “delete_on_termination”: false, “volume_size”: 104, “guest_format”: null, “boot_index”: 0, “destination_type”: “volume”, “snapshot_id”: “abde9e38-2ed5-4ecd-b23c-b0120e30690e”, “no_device”: null}]

54.3 - 1.0

scpcli virtualserver image list
[--limit <value>]
[--marker <value>]
[--scp_image_type <value>]
[--scp_original_image_type <value>]
[--name <value>]
[--os_distro <value>]
[--status <value>]
[--visibility <value>]
[--sort <value>]
[--long]

Description

List Images.

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
limit
optional
integerPage size of items20
marker
optional
stringThe last item's ID from previous request2a9be312-5d4b-4bc8-b2ae-35100fa9241f
scp_image_type
optional
stringImage typecustom
scp_original_image_type
optional
stringOriginal Image typestandard
name
optional
stringImage nameimagename
os_distro
optional
stringOS distribution of the image to be uploadedalma
status
optional
stringImage statusactive
visibility
optional
****Indicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accountsprivate
sort
optional
stringComma-separated list of sort keys and optional sort directions in the form of [:]created_at:desc

Responses

NameDescriptionExample
idImage ID70a599e0-31e7-49b7-b260-868f441e862b
checksumMD5 hash of the entire image data. and this field could be used to verify the integrity of image.
Requires --long option
7538e0fcb56e0e272cfd89eb384d6613
container_formatContainer format
Requires --long option
bare
created_atCreated at2025-07-22T09:00:00Z
disk_formatDisk format
Requires --long option
qcow2
fileThe URL for the virtual server image file
Requires --long option
/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file
min_diskMinimum disk capacity (GB) of the Image to be created
Requires --long option
100
min_ramMinimum RAM capacity (GB) of the Image to be created
Requires --long option
0
nameImage nameimagename
os_distroOS distribution of the image to be uploadedalma
os_hash_algoOS hash algorithm used to verify image integrity
Requires --long option
sha512
os_hash_valueThe actual digest of the image binary, calculated with the algorithm indicated by os_hash_algo. The value is presented as a hexadecimal string.
Requires --long option
c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99
os_hiddenWhether the image is hidden
Requires --long option
False
ownerOwner account ID
Requires --long option
a8f10467abfc4b87b64614ab36eb9ae4
owner_account_nameOwner account name
Requires --long option
AccountName
owner_user_nameOwner user name
Requires --long option
user@samsung.com
protectedwhether Image deletion is prohibited
Requires --long option
False
root_device_nameRoot device name
Requires --long option
/dev/vda
scp_image_typeImage type
Requires --long option
custom
scp_k8s_versionK8S version
Requires --long option
v1.28.7
scp_original_image_typeOriginal Image type
Requires --long option
standard
scp_os_build_versionOS build version
Requires --long option
20250101
scp_os_versionOS version
Requires --long option
8.8
sizeImage size
Requires --long option
2429747200
statusImage status
Requires --long option
active
updated_atUpdated at
Requires --long option
2025-07-26T12:00:00Z
urlObject Storage URL for Image file (only qcow2 format allowed)
Requires --long option
https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2
virtual_sizeVirtual size
Requires --long option
17179869184
visibilityIndicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accountsprivate
volumesVolumes
Requires --long option
[{“tag”: null, “volume_id”: null, “encryption_options”: null, “encryption_secret_uuid”: null, “encryption_format”: null, “device_name”: “/dev/vda”, “disk_bus”: “virtio”, “volume_type”: null, “encrypted”: null, “image_id”: null, “device_type”: “disk”, “source_type”: “snapshot”, “delete_on_termination”: false, “volume_size”: 104, “guest_format”: null, “boot_index”: 0, “destination_type”: “volume”, “snapshot_id”: “abde9e38-2ed5-4ecd-b23c-b0120e30690e”, “no_device”: null}]

55 - List Keypairs

55.1 - 1.2

scpcli virtualserver keypair list
[--limit <value>]
[--marker <value>]
[--long]

Description

Get keypair list.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
limit
optional
integerPage size of items20
marker
optional
stringThe last item's ID from previous request2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
fingerprintFingerprint7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd
nameKeypair namekeypairname
public_keyPublic Key
Requires --long option
ssh-rsa fakeKey Generated-by-SCP
typeKeypair typessh

55.2 - 1.1

scpcli virtualserver keypair list
[--limit <value>]
[--marker <value>]
[--long]

Description

Get keypair list.

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
limit
optional
integerPage size of items20
marker
optional
stringThe last item's ID from previous request2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
fingerprintFingerprint7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd
nameKeypair namekeypairname
public_keyPublic Key
Requires --long option
ssh-rsa fakeKey Generated-by-SCP
typeKeypair typessh

55.3 - 1.0

scpcli virtualserver keypair list
[--limit <value>]
[--marker <value>]
[--long]

Description

Get keypair list.

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
limit
optional
integerPage size of items20
marker
optional
stringThe last item's ID from previous request2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
fingerprintFingerprint7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd
nameKeypair namekeypairname
public_keyPublic Key
Requires --long option
ssh-rsa fakeKey Generated-by-SCP
typeKeypair typessh

56 - List Launch Configurations

56.1 - 1.2

scpcli virtualserver launch configuration list
[--name <value>]
[--image_id <value>]
[--offset <value>]
[--limit <value>]
[--sort <value>]
[--long]

Description

List Launch Configurations.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
name
optional
stringLaunch Configuration namelaunch-configuration-name
image_id
optional
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b
offset
optional
integerIndex of where to start in the list-
limit
optional
integerPage size of items-
sort
optional
stringComma-separated list of sort keys and optional sort directions in the form of [:]-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
Requires --long option
a8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_countNumber of Auto-Scaling Group attached to Launch Configuration1
boot_disk_sizeSize of default volume
Requires --long option
104
created_atCreated At
Requires --long option
2024-05-17T00:23:17Z
created_byCreated By
Requires --long option
90dddfc2b1e04edba54ba2b41539a9ac
extra_disk_sizeSize of additional volume
Requires --long option
104
file_storage_idsFile Storage ID list
Requires --long option
image_idImage ID
Requires --long option
70a599e0-31e7-49b7-b260-868f441e862b
image_nameImage nameimagename
keypair_nameKeypair name
Requires --long option
keypairname
modified_atModified At
Requires --long option
2024-05-17T00:23:17Z
modified_byModified By
Requires --long option
90dddfc2b1e04edba54ba2b41539a9ac
nameLaunch Configuration namelaunch-configuration-name
public_keyPublic Key
Requires --long option
ssh-rsa fakeKey Generated-by-SCP
server_type_idServer type IDs1v1m2
stateLaunch Configuration state
Requires --long option
ACTIVE
user_dataA script that runs at the start of a server on Auto-Scaling Group that will use Launch Configuration.It must be Base64-encoded string and must not exceed 45,000 bytes.
Requires --long option
IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==
volumesVolumes

56.2 - 1.1

scpcli virtualserver launch configuration list
[--name <value>]
[--image_id <value>]
[--offset <value>]
[--limit <value>]
[--sort <value>]
[--long]

Description

List Launch Configurations.

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
stringLaunch Configuration namelaunch-configuration-name
image_id
optional
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b
offset
optional
integerIndex of where to start in the list-
limit
optional
integerPage size of items-
sort
optional
stringComma-separated list of sort keys and optional sort directions in the form of [:]-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
Requires --long option
a8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_countNumber of Auto-Scaling Group attached to Launch Configuration1
boot_disk_sizeSize of default volume
Requires --long option
104
created_atCreated At
Requires --long option
2024-05-17T00:23:17Z
created_byCreated By
Requires --long option
90dddfc2b1e04edba54ba2b41539a9ac
extra_disk_sizeSize of additional volume
Requires --long option
104
image_idImage ID
Requires --long option
70a599e0-31e7-49b7-b260-868f441e862b
image_nameImage nameimagename
keypair_nameKeypair name
Requires --long option
keypairname
modified_atModified At
Requires --long option
2024-05-17T00:23:17Z
modified_byModified By
Requires --long option
90dddfc2b1e04edba54ba2b41539a9ac
nameLaunch Configuration namelaunch-configuration-name
public_keyPublic Key
Requires --long option
ssh-rsa fakeKey Generated-by-SCP
server_type_idServer type IDs1v1m2
stateLaunch Configuration state
Requires --long option
ACTIVE
user_dataA script that runs at the start of a server on Auto-Scaling Group that will use Launch Configuration.It must be Base64-encoded string and must not exceed 45,000 bytes.
Requires --long option
IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==
volumesVolumes

56.3 - 1.0

scpcli virtualserver launch configuration list
[--name <value>]
[--image_id <value>]
[--offset <value>]
[--limit <value>]
[--sort <value>]
[--long]

Description

List Launch Configurations.

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
stringLaunch Configuration namelaunch-configuration-name
image_id
optional
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b
offset
optional
integerIndex of where to start in the list-
limit
optional
integerPage size of items-
sort
optional
stringComma-separated list of sort keys and optional sort directions in the form of [:]-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
Requires --long option
a8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_countNumber of Auto-Scaling Group attached to Launch Configuration1
boot_disk_sizeSize of default volume
Requires --long option
104
created_atCreated At
Requires --long option
2024-05-17T00:23:17Z
created_byCreated By
Requires --long option
90dddfc2b1e04edba54ba2b41539a9ac
extra_disk_sizeSize of additional volume
Requires --long option
104
image_idImage ID
Requires --long option
70a599e0-31e7-49b7-b260-868f441e862b
image_nameImage nameimagename
keypair_nameKeypair name
Requires --long option
keypairname
modified_atModified At
Requires --long option
2024-05-17T00:23:17Z
modified_byModified By
Requires --long option
90dddfc2b1e04edba54ba2b41539a9ac
nameLaunch Configuration namelaunch-configuration-name
public_keyPublic Key
Requires --long option
ssh-rsa fakeKey Generated-by-SCP
server_type_idServer type IDs1v1m2
stateLaunch Configuration state
Requires --long option
ACTIVE
user_dataA script that runs at the start of a server on Auto-Scaling Group that will use Launch Configuration.It must be Base64-encoded string and must not exceed 45,000 bytes.
Requires --long option
IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==
volumesVolumes

57 - List pending Images

57.1 - 1.2

scpcli virtualserver image pending list
[--scp_image_type <value>]
[--scp_original_image_type <value>]
[--long]

Description

Retrieve a list of images pending sharing.

  • Image sharing can be requested between accounts.

  • Member accounts that have been shared an image can view the pending‑share list and decide whether to accept or reject it.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
scp_image_type
optional
stringImage typecustom
scp_original_image_type
optional
stringOriginal Image typestandard

Responses

NameDescriptionExample
idImage ID70a599e0-31e7-49b7-b260-868f441e862b
checksumMD5 hash of the entire image data. and this field could be used to verify the integrity of image.
Requires --long option
7538e0fcb56e0e272cfd89eb384d6613
container_formatContainer format
Requires --long option
bare
created_atCreated at2025-07-22T09:00:00Z
disk_formatDisk format
Requires --long option
qcow2
fileThe URL for the virtual server image file
Requires --long option
/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file
min_diskMinimum disk capacity (GB) of the Image to be created
Requires --long option
100
min_ramMinimum RAM capacity (GB) of the Image to be created
Requires --long option
0
nameImage nameimagename
os_distroOS distribution of the image to be uploadedalma
os_hash_algoOS hash algorithm used to verify image integrity
Requires --long option
sha512
os_hash_valueThe actual digest of the image binary, calculated with the algorithm indicated by os_hash_algo. The value is presented as a hexadecimal string.
Requires --long option
c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99
os_hiddenWhether the image is hidden
Requires --long option
False
ownerOwner account ID
Requires --long option
a8f10467abfc4b87b64614ab36eb9ae4
owner_account_nameOwner account name
Requires --long option
AccountName
owner_user_nameOwner user name
Requires --long option
user@samsung.com
protectedwhether Image deletion is prohibited
Requires --long option
False
root_device_nameRoot device name
Requires --long option
/dev/vda
scp_gpu_driverK8s GPU Image driver version
Requires --long option
535.183.06
scp_image_typeImage type
Requires --long option
custom
scp_k8s_versionK8S version
Requires --long option
v1.28.7
scp_original_image_typeOriginal Image type
Requires --long option
standard
scp_os_build_versionOS build version
Requires --long option
20250101
scp_os_versionOS version
Requires --long option
8.8
sizeImage size
Requires --long option
2429747200
statusImage status
Requires --long option
active
updated_atUpdated at
Requires --long option
2025-07-26T12:00:00Z
urlObject Storage URL for Image file (only qcow2 format allowed)
Requires --long option
https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2
virtual_sizeVirtual size
Requires --long option
17179869184
visibilityIndicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accountsprivate
volumesVolumes
Requires --long option
[{“tag”: null, “volume_id”: null, “encryption_options”: null, “encryption_secret_uuid”: null, “encryption_format”: null, “device_name”: “/dev/vda”, “disk_bus”: “virtio”, “volume_type”: null, “encrypted”: null, “image_id”: null, “device_type”: “disk”, “source_type”: “snapshot”, “delete_on_termination”: false, “volume_size”: 104, “guest_format”: null, “boot_index”: 0, “destination_type”: “volume”, “snapshot_id”: “abde9e38-2ed5-4ecd-b23c-b0120e30690e”, “no_device”: null}]

57.2 - 1.1

scpcli virtualserver image pending list
[--scp_image_type <value>]
[--scp_original_image_type <value>]
[--long]

Description

Retrieve a list of images pending sharing.

  • Image sharing can be requested between accounts.

  • Member accounts that have been shared an image can view the pending‑share list and decide whether to accept or reject it.

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
scp_image_type
optional
stringImage typecustom
scp_original_image_type
optional
stringOriginal Image typestandard

Responses

NameDescriptionExample
idImage ID70a599e0-31e7-49b7-b260-868f441e862b
checksumMD5 hash of the entire image data. and this field could be used to verify the integrity of image.
Requires --long option
7538e0fcb56e0e272cfd89eb384d6613
container_formatContainer format
Requires --long option
bare
created_atCreated at2025-07-22T09:00:00Z
disk_formatDisk format
Requires --long option
qcow2
fileThe URL for the virtual server image file
Requires --long option
/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file
min_diskMinimum disk capacity (GB) of the Image to be created
Requires --long option
100
min_ramMinimum RAM capacity (GB) of the Image to be created
Requires --long option
0
nameImage nameimagename
os_distroOS distribution of the image to be uploadedalma
os_hash_algoOS hash algorithm used to verify image integrity
Requires --long option
sha512
os_hash_valueThe actual digest of the image binary, calculated with the algorithm indicated by os_hash_algo. The value is presented as a hexadecimal string.
Requires --long option
c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99
os_hiddenWhether the image is hidden
Requires --long option
False
ownerOwner account ID
Requires --long option
a8f10467abfc4b87b64614ab36eb9ae4
owner_account_nameOwner account name
Requires --long option
AccountName
owner_user_nameOwner user name
Requires --long option
user@samsung.com
protectedwhether Image deletion is prohibited
Requires --long option
False
root_device_nameRoot device name
Requires --long option
/dev/vda
scp_image_typeImage type
Requires --long option
custom
scp_k8s_versionK8S version
Requires --long option
v1.28.7
scp_original_image_typeOriginal Image type
Requires --long option
standard
scp_os_build_versionOS build version
Requires --long option
20250101
scp_os_versionOS version
Requires --long option
8.8
sizeImage size
Requires --long option
2429747200
statusImage status
Requires --long option
active
updated_atUpdated at
Requires --long option
2025-07-26T12:00:00Z
urlObject Storage URL for Image file (only qcow2 format allowed)
Requires --long option
https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2
virtual_sizeVirtual size
Requires --long option
17179869184
visibilityIndicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accountsprivate
volumesVolumes
Requires --long option
[{“tag”: null, “volume_id”: null, “encryption_options”: null, “encryption_secret_uuid”: null, “encryption_format”: null, “device_name”: “/dev/vda”, “disk_bus”: “virtio”, “volume_type”: null, “encrypted”: null, “image_id”: null, “device_type”: “disk”, “source_type”: “snapshot”, “delete_on_termination”: false, “volume_size”: 104, “guest_format”: null, “boot_index”: 0, “destination_type”: “volume”, “snapshot_id”: “abde9e38-2ed5-4ecd-b23c-b0120e30690e”, “no_device”: null}]

57.3 - 1.0

scpcli virtualserver image pending list
[--scp_image_type <value>]
[--scp_original_image_type <value>]
[--long]

Description

Retrieve a list of images pending sharing.

  • Image sharing can be requested between accounts.

  • Member accounts that have been shared an image can view the pending‑share list and decide whether to accept or reject it.

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
scp_image_type
optional
stringImage typecustom
scp_original_image_type
optional
stringOriginal Image typestandard

Responses

NameDescriptionExample
idImage ID70a599e0-31e7-49b7-b260-868f441e862b
checksumMD5 hash of the entire image data. and this field could be used to verify the integrity of image.
Requires --long option
7538e0fcb56e0e272cfd89eb384d6613
container_formatContainer format
Requires --long option
bare
created_atCreated at2025-07-22T09:00:00Z
disk_formatDisk format
Requires --long option
qcow2
fileThe URL for the virtual server image file
Requires --long option
/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file
min_diskMinimum disk capacity (GB) of the Image to be created
Requires --long option
100
min_ramMinimum RAM capacity (GB) of the Image to be created
Requires --long option
0
nameImage nameimagename
os_distroOS distribution of the image to be uploadedalma
os_hash_algoOS hash algorithm used to verify image integrity
Requires --long option
sha512
os_hash_valueThe actual digest of the image binary, calculated with the algorithm indicated by os_hash_algo. The value is presented as a hexadecimal string.
Requires --long option
c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99
os_hiddenWhether the image is hidden
Requires --long option
False
ownerOwner account ID
Requires --long option
a8f10467abfc4b87b64614ab36eb9ae4
owner_account_nameOwner account name
Requires --long option
AccountName
owner_user_nameOwner user name
Requires --long option
user@samsung.com
protectedwhether Image deletion is prohibited
Requires --long option
False
root_device_nameRoot device name
Requires --long option
/dev/vda
scp_image_typeImage type
Requires --long option
custom
scp_k8s_versionK8S version
Requires --long option
v1.28.7
scp_original_image_typeOriginal Image type
Requires --long option
standard
scp_os_build_versionOS build version
Requires --long option
20250101
scp_os_versionOS version
Requires --long option
8.8
sizeImage size
Requires --long option
2429747200
statusImage status
Requires --long option
active
updated_atUpdated at
Requires --long option
2025-07-26T12:00:00Z
urlObject Storage URL for Image file (only qcow2 format allowed)
Requires --long option
https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2
virtual_sizeVirtual size
Requires --long option
17179869184
visibilityIndicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accountsprivate
volumesVolumes
Requires --long option
[{“tag”: null, “volume_id”: null, “encryption_options”: null, “encryption_secret_uuid”: null, “encryption_format”: null, “device_name”: “/dev/vda”, “disk_bus”: “virtio”, “volume_type”: null, “encrypted”: null, “image_id”: null, “device_type”: “disk”, “source_type”: “snapshot”, “delete_on_termination”: false, “volume_size”: 104, “guest_format”: null, “boot_index”: 0, “destination_type”: “volume”, “snapshot_id”: “abde9e38-2ed5-4ecd-b23c-b0120e30690e”, “no_device”: null}]

58 - List Server Groups

58.1 - 1.2

scpcli virtualserver server group list
[--limit <value>]
[--offset <value>]
[--long]

Description

Get server group list.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
limit
optional
integerPage size of items20
offset
optional
integerIndex of where to start in the list0

Responses

NameDescriptionExample
idServer Group ID616fb98f-46ca-475e-917e-2563e5a8cd19
account_idAccount ID
Requires --long option
a8f10467abfc4b87b64614ab36eb9ae4
membersList of Virtual Servers belonging to Server Group
Requires --long option
[‘2a9be312-5d4b-4bc8-b2ae-35100fa9241f’]
nameServer Group nameserver-group
partition_sizeSize of partition when server group policy is partition
Requires --long option
3
policyServer Group policyanti-affinity
user_idUser ID
Requires --long option
570907805e5447be84b618450ef52o0t

58.2 - 1.1

scpcli virtualserver server group list
[--limit <value>]
[--offset <value>]
[--long]

Description

Get server group list.

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
limit
optional
integerPage size of items20
offset
optional
integerIndex of where to start in the list0

Responses

NameDescriptionExample
idServer Group ID616fb98f-46ca-475e-917e-2563e5a8cd19
account_idAccount ID
Requires --long option
a8f10467abfc4b87b64614ab36eb9ae4
membersList of Virtual Servers belonging to Server Group
Requires --long option
[‘2a9be312-5d4b-4bc8-b2ae-35100fa9241f’]
nameServer Group nameserver-group
partition_sizeSize of partition when server group policy is partition
Requires --long option
3
policyServer Group policyanti-affinity
user_idUser ID
Requires --long option
570907805e5447be84b618450ef52o0t

58.3 - 1.0

scpcli virtualserver server group list
[--limit <value>]
[--offset <value>]
[--long]

Description

Get server group list.

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
limit
optional
integerPage size of items20
offset
optional
integerIndex of where to start in the list0

Responses

NameDescriptionExample
idServer Group ID616fb98f-46ca-475e-917e-2563e5a8cd19
account_idAccount ID
Requires --long option
a8f10467abfc4b87b64614ab36eb9ae4
membersList of Virtual Servers belonging to Server Group
Requires --long option
[‘2a9be312-5d4b-4bc8-b2ae-35100fa9241f’]
nameServer Group nameserver-group
partition_sizeSize of partition when server group policy is partition
Requires --long option
3
policyServer Group policyanti-affinity
user_idUser ID
Requires --long option
570907805e5447be84b618450ef52o0t

59 - List Server Interfaces

59.1 - 1.2

scpcli virtualserver server interface list
--server_id <value>

Description

List Server Interfaces.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
fixed_ipsFixed IP list
is_defaultIndicates whether this is the default port.True
mac_addrMAC Addressfa:16:3e:c0:71:2b
port_idPort IDf2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc
port_statePort StateACTIVE
private_static_natPrivate Static NAT
static_natPublic Static NAT
subnet_idSubnet ID183c6c30df0c4fcbb16422aa2d64aa21

59.2 - 1.1

scpcli virtualserver server interface list
--server_id <value>

Description

List Server Interfaces.

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
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
fixed_ipsFixed IP list
mac_addrMAC Addressfa:16:3e:c0:71:2b
port_idPort IDf2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc
port_statePort StateACTIVE
private_static_natPrivate Static NAT
static_natPublic Static NAT
subnet_idSubnet ID183c6c30df0c4fcbb16422aa2d64aa21

59.3 - 1.0

scpcli virtualserver server interface list
--server_id <value>

Description

List Server Interfaces.

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
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
fixed_ipsFixed IP list
mac_addrMAC Addressfa:16:3e:c0:71:2b
port_idPort IDf2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc
port_statePort StateACTIVE
private_static_natPrivate Static NAT
static_natPublic Static NAT
subnet_idSubnet ID183c6c30df0c4fcbb16422aa2d64aa21

60 - List Server Ips

60.1 - 1.2

scpcli virtualserver server ip list
--server_id <value>

Description

List Server Ips.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
ip_addressesIP addresses
subnet_nameSubnet namesubnetname

60.2 - 1.1

scpcli virtualserver server ip list
--server_id <value>

Description

List Server Ips.

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
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
ip_addressesIP addresses
subnet_nameSubnet namesubnetname

60.3 - 1.0

scpcli virtualserver server ip list
--server_id <value>

Description

List Server Ips.

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
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
ip_addressesIP addresses
subnet_nameSubnet namesubnetname

61 - List Server Types

61.1 - 1.2

scpcli virtualserver server type list
[--limit <value>]
[--marker <value>]
[--min_disk <value>]
[--min_ram <value>]
[--sort <value>]

Description

Get server type list.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
limit
optional
integerPage size of items20
marker
optional
stringThe last item's ID from previous request2a9be312-5d4b-4bc8-b2ae-35100fa9241f
min_disk
optional
integerMinimum disk size0
min_ram
optional
integerMinimum ram size2048
sort
optional
stringComma-separated list of sort keys and optional sort directions in the form of [:]created_at:desc

Responses

NameDescriptionExample
idServer type IDs1v1m2
descriptionDescriptiondescription
diskSize of root disk100
ephemeralSize of ephemeral disk0
extra_specsExtra specs
nameServer type names1v1m2
ramAmount of RAM2
swapSize of dedicated swap disk0
vcpusNumber of CPUs1

61.2 - 1.1

scpcli virtualserver server type list
[--limit <value>]
[--marker <value>]
[--min_disk <value>]
[--min_ram <value>]
[--sort <value>]

Description

Get server type list.

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
limit
optional
integerPage size of items20
marker
optional
stringThe last item's ID from previous request2a9be312-5d4b-4bc8-b2ae-35100fa9241f
min_disk
optional
integerMinimum disk size0
min_ram
optional
integerMinimum ram size2048
sort
optional
stringComma-separated list of sort keys and optional sort directions in the form of [:]created_at:desc

Responses

NameDescriptionExample
idServer type IDs1v1m2
descriptionDescriptiondescription
diskSize of root disk100
ephemeralSize of ephemeral disk0
extra_specsExtra specs
nameServer type names1v1m2
ramAmount of RAM2
swapSize of dedicated swap disk0
vcpusNumber of CPUs1

61.3 - 1.0

scpcli virtualserver server type list
[--limit <value>]
[--marker <value>]
[--min_disk <value>]
[--min_ram <value>]
[--sort <value>]

Description

Get server type list.

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
limit
optional
integerPage size of items20
marker
optional
stringThe last item's ID from previous request2a9be312-5d4b-4bc8-b2ae-35100fa9241f
min_disk
optional
integerMinimum disk size0
min_ram
optional
integerMinimum ram size2048
sort
optional
stringComma-separated list of sort keys and optional sort directions in the form of [:]created_at:desc

Responses

NameDescriptionExample
idServer type IDs1v1m2
descriptionDescriptiondescription
diskSize of root disk100
ephemeralSize of ephemeral disk0
extra_specsExtra specs
nameServer type names1v1m2
ramAmount of RAM2
swapSize of dedicated swap disk0
vcpusNumber of CPUs1

62 - List Server Volumes

62.1 - 1.2

scpcli virtualserver server volume list
--server_id <value>

Description

List Server Volumes.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
idVolume Attachment ID3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c
delete_on_terminationDelete the boot volume when the server is terminated.False
deviceDevice name such as, /dev/vda./dev/vda
server_idServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_idVolume ID3f500f00-ed80-4566-a057-e31760226f9a

62.2 - 1.1

scpcli virtualserver server volume list
--server_id <value>

Description

List Server Volumes.

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
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
idVolume Attachment ID3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c
delete_on_terminationDelete the boot volume when the server is terminated.False
deviceDevice name such as, /dev/vda./dev/vda
server_idServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_idVolume ID3f500f00-ed80-4566-a057-e31760226f9a

62.3 - 1.0

scpcli virtualserver server volume list
--server_id <value>

Description

List Server Volumes.

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
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
idVolume Attachment ID3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c
delete_on_terminationDelete the boot volume when the server is terminated.False
deviceDevice name such as, /dev/vda./dev/vda
server_idServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_idVolume ID3f500f00-ed80-4566-a057-e31760226f9a

63 - List snapshots

63.1 - 1.2

scpcli virtualserver volume snapshot list
[--volume_id <value>]
[--limit <value>]
[--offset <value>]
[--marker <value>]
[--with_count <value>]
[--name <value>]
[--sort <value>]

Description

List snapshots.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
volume_id
optional
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
limit
optional
integerPage size of items20
offset
optional
integerIndex of where to start in the list0
marker
optional
stringThe last item's ID from previous request2a9be312-5d4b-4bc8-b2ae-35100fa9241f
with_count
optional
booleanWhether to show countTrue
name
optional
stringSnapshot namesnapshot-1
sort
optional
stringComma-separated list of sort keys and optional sort directions in the form of [:]created_at:desc

Responses

NameDescriptionExample
idSnapshot IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790
created_atCreated at2025-07-22T09:00:00Z
descriptionDescriptiondescription
metadataOne or more metadata key and value pairs for the snapshotMetadata
nameSnapshot namesnapshot-1
sizeVolume size104
statusVolume stateavailable
updated_atUpdated at2025-07-26T12:00:00Z
user_idUser ID570907805e5447be84b618450ef52o0t
volume_idVolume ID3f500f00-ed80-4566-a057-e31760226f9a

63.2 - 1.1

scpcli virtualserver volume snapshot list
[--volume_id <value>]
[--limit <value>]
[--offset <value>]
[--marker <value>]
[--with_count <value>]
[--name <value>]

Description

List snapshots.

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
volume_id
optional
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
limit
optional
integerPage size of items20
offset
optional
integerIndex of where to start in the list0
marker
optional
stringThe last item's ID from previous request2a9be312-5d4b-4bc8-b2ae-35100fa9241f
with_count
optional
booleanWhether to show countTrue
name
optional
stringSnapshot namesnapshot-1

Responses

NameDescriptionExample
idSnapshot IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790
created_atCreated at2025-07-22T09:00:00Z
descriptionDescriptiondescription
metadataOne or more metadata key and value pairs for the snapshotMetadata
nameSnapshot namesnapshot-1
sizeVolume size104
statusVolume stateavailable
updated_atUpdated at2025-07-26T12:00:00Z
user_idUser ID570907805e5447be84b618450ef52o0t
volume_idVolume ID3f500f00-ed80-4566-a057-e31760226f9a

63.3 - 1.0

scpcli virtualserver volume snapshot list
[--volume_id <value>]
[--limit <value>]
[--offset <value>]
[--marker <value>]
[--with_count <value>]
[--name <value>]

Description

List snapshots.

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
volume_id
optional
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
limit
optional
integerPage size of items20
offset
optional
integerIndex of where to start in the list0
marker
optional
stringThe last item's ID from previous request2a9be312-5d4b-4bc8-b2ae-35100fa9241f
with_count
optional
booleanWhether to show countTrue
name
optional
stringSnapshot namesnapshot-1

Responses

NameDescriptionExample
idSnapshot IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790
created_atCreated at2025-07-22T09:00:00Z
descriptionDescriptiondescription
metadataOne or more metadata key and value pairs for the snapshotMetadata
nameSnapshot namesnapshot-1
sizeVolume size104
statusVolume stateavailable
updated_atUpdated at2025-07-26T12:00:00Z
user_idUser ID570907805e5447be84b618450ef52o0t
volume_idVolume ID3f500f00-ed80-4566-a057-e31760226f9a

64 - List Virtual Server Security Group

64.1 - 1.2

scpcli virtualserver server security group list
--server_id <value>

Description

List Virtual Server Security Group.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
idSecurity Group ID616fb98f-46ca-475e-917e-2563e5a8cd19
account_idSecurity Group owner’s account ID6f70656e737461636b20342065766572
descriptionSecurity group descriptionSecurity group description
nameSecurity Group namesecuritygroup
rulesSecurity group rules

64.2 - 1.1

scpcli virtualserver server security group list
--server_id <value>

Description

List Virtual Server Security Group.

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
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
idSecurity Group ID616fb98f-46ca-475e-917e-2563e5a8cd19
account_idSecurity Group owner’s account ID6f70656e737461636b20342065766572
descriptionSecurity group descriptionSecurity group description
nameSecurity Group namesecuritygroup
rulesSecurity group rules

64.3 - 1.0

scpcli virtualserver server security group list
--server_id <value>

Description

List Virtual Server Security Group.

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
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
idSecurity Group ID616fb98f-46ca-475e-917e-2563e5a8cd19
account_idSecurity Group owner’s account ID6f70656e737461636b20342065766572
descriptionSecurity group descriptionSecurity group description
nameSecurity Group namesecuritygroup
rulesSecurity group rules

65 - List Virtual Servers

65.1 - 1.2

scpcli virtualserver server list
[--name <value>]
[--ip <value>]
[--state <value>]
[--product_category <value>]
[--product_offering <value>]
[--vpc_id <value>]
[--server_type_id <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--auto_scaling_group_id <value>]
[--long]

Description

List Virtual Servers.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
name
optional
stringServer nameservername
ip
optional
stringIP address192.169.3.2
state
optional
stringServer stateACTIVE
product_category
optional
****Product categorycompute
product_offering
optional
arrayProduct offering'v'
vpc_id
optional
stringVPC IDcc976b621087484ea5fd527f4b78708b
server_type_id
optional
stringServer type IDs1v1m2
limit
optional
integerPage size of items20
marker
optional
stringThe last item's ID from previous request2a9be312-5d4b-4bc8-b2ae-35100fa9241f
sort
optional
stringComma-separated list of sort keys and optional sort directions in the form of [:]created_at:desc
auto_scaling_group_id
optional
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

Responses

NameDescriptionExample
idServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
account_idAccount ID
Requires --long option
a8f10467abfc4b87b64614ab36eb9ae4
addressesAddresses
auto_scaling_group_idAuto-Scaling Group ID
Requires --long option
52613bd852b04b39adcb15a8364d856d
created_atCreated at
Requires --long option
created_byCreated by
Requires --long option
97e6b22c9a4143789ca522df7457a32f
disk_configDisk config
Requires --long option
MANUAL
image_idImage ID
Requires --long option
70a599e0-31e7-49b7-b260-868f441e862b
is_marketplaceIs Marketplace
Requires --long option
False
keypair_nameKeypair name
Requires --long option
keypairname
launch_configuration_idLaunch Configuration ID
Requires --long option
b5aea5a675fc4f6b9e0fcd1288354c5f
lockedLocked
Requires --long option
False
metadataMetadata
Requires --long option
modified_atModified at
Requires --long option
nameServer nameservername
partition_numberPartition number
Requires --long option
1
planned_compute_os_typePlanned Compute OS type
Requires --long option
windows
product_categoryProduct category
Requires --long option
compute
product_offeringProduct offering
Requires --long option
virtual_server
security_groupsSecurity Groups
Requires --long option
server_group_idServer Group ID
Requires --long option
616fb98f-46ca-475e-917e-2563e5a8cd19
server_typeServer type
stateServer stateACTIVE
volumesVolumes
Requires --long option
vpc_idVPC ID
Requires --long option
cc976b621087484ea5fd527f4b78708b

65.2 - 1.1

scpcli virtualserver server list
[--name <value>]
[--ip <value>]
[--state <value>]
[--product_category <value>]
[--product_offering <value>]
[--vpc_id <value>]
[--server_type_id <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--auto_scaling_group_id <value>]
[--long]

Description

List Virtual Servers.

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
stringServer nameservername
ip
optional
stringIP address192.169.3.2
state
optional
stringServer stateACTIVE
product_category
optional
****Product categorycompute
product_offering
optional
arrayProduct offering'v'
vpc_id
optional
stringVPC IDcc976b621087484ea5fd527f4b78708b
server_type_id
optional
stringServer type IDs1v1m2
limit
optional
integerPage size of items20
marker
optional
stringThe last item's ID from previous request2a9be312-5d4b-4bc8-b2ae-35100fa9241f
sort
optional
stringComma-separated list of sort keys and optional sort directions in the form of [:]created_at:desc
auto_scaling_group_id
optional
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

Responses

NameDescriptionExample
idServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
account_idAccount ID
Requires --long option
a8f10467abfc4b87b64614ab36eb9ae4
addressesAddresses
auto_scaling_group_idAuto-Scaling Group ID
Requires --long option
52613bd852b04b39adcb15a8364d856d
created_atCreated at
Requires --long option
created_byCreated by
Requires --long option
97e6b22c9a4143789ca522df7457a32f
disk_configDisk config
Requires --long option
MANUAL
image_idImage ID
Requires --long option
70a599e0-31e7-49b7-b260-868f441e862b
is_marketplaceIs Marketplace
Requires --long option
False
keypair_nameKeypair name
Requires --long option
keypairname
launch_configuration_idLaunch Configuration ID
Requires --long option
b5aea5a675fc4f6b9e0fcd1288354c5f
lockedLocked
Requires --long option
False
metadataMetadata
Requires --long option
modified_atModified at
Requires --long option
nameServer nameservername
partition_numberPartition number
Requires --long option
1
planned_compute_os_typePlanned Compute OS type
Requires --long option
windows
product_categoryProduct category
Requires --long option
compute
product_offeringProduct offering
Requires --long option
virtual_server
security_groupsSecurity Groups
Requires --long option
server_group_idServer Group ID
Requires --long option
616fb98f-46ca-475e-917e-2563e5a8cd19
server_typeServer type
stateServer stateACTIVE
volumesVolumes
Requires --long option
vpc_idVPC ID
Requires --long option
cc976b621087484ea5fd527f4b78708b

65.3 - 1.0

scpcli virtualserver server list
[--name <value>]
[--ip <value>]
[--state <value>]
[--product_category <value>]
[--product_offering <value>]
[--vpc_id <value>]
[--server_type_id <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--auto_scaling_group_id <value>]
[--long]

Description

List Virtual Servers.

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
stringServer nameservername
ip
optional
stringIP address192.169.3.2
state
optional
stringServer stateACTIVE
product_category
optional
****Product categorycompute
product_offering
optional
arrayProduct offering'v'
vpc_id
optional
stringVPC IDcc976b621087484ea5fd527f4b78708b
server_type_id
optional
stringServer type IDs1v1m2
limit
optional
integerPage size of items20
marker
optional
stringThe last item's ID from previous request2a9be312-5d4b-4bc8-b2ae-35100fa9241f
sort
optional
stringComma-separated list of sort keys and optional sort directions in the form of [:]created_at:desc
auto_scaling_group_id
optional
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

Responses

NameDescriptionExample
idServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
account_idAccount ID
Requires --long option
a8f10467abfc4b87b64614ab36eb9ae4
addressesAddresses
auto_scaling_group_idAuto-Scaling Group ID
Requires --long option
52613bd852b04b39adcb15a8364d856d
created_atCreated at
Requires --long option
created_byCreated by
Requires --long option
97e6b22c9a4143789ca522df7457a32f
disk_configDisk config
Requires --long option
MANUAL
image_idImage ID
Requires --long option
70a599e0-31e7-49b7-b260-868f441e862b
is_marketplaceIs Marketplace
Requires --long option
False
keypair_nameKeypair name
Requires --long option
keypairname
launch_configuration_idLaunch Configuration ID
Requires --long option
b5aea5a675fc4f6b9e0fcd1288354c5f
lockedLocked
Requires --long option
False
metadataMetadata
Requires --long option
modified_atModified at
Requires --long option
nameServer nameservername
partition_numberPartition number
Requires --long option
1
planned_compute_os_typePlanned Compute OS type
Requires --long option
windows
product_categoryProduct category
Requires --long option
compute
product_offeringProduct offering
Requires --long option
virtual_server
security_groupsSecurity Groups
Requires --long option
server_group_idServer Group ID
Requires --long option
616fb98f-46ca-475e-917e-2563e5a8cd19
server_typeServer type
stateServer stateACTIVE
volumesVolumes
Requires --long option
vpc_idVPC ID
Requires --long option
cc976b621087484ea5fd527f4b78708b

66 - List volume transfers

66.1 - 1.2

scpcli virtualserver volume transfer list

Description

List volume transfers.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Responses

NameDescriptionExample
idVolume Transfer ID1ac231be-823b-4a4d-8ff0-aac503a7118a
nameVolume namevolume01
volume_idVolume ID3f500f00-ed80-4566-a057-e31760226f9a

66.2 - 1.1

scpcli virtualserver volume transfer list

Description

List volume transfers.

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

Responses

NameDescriptionExample
idVolume Transfer ID1ac231be-823b-4a4d-8ff0-aac503a7118a
nameVolume namevolume01
volume_idVolume ID3f500f00-ed80-4566-a057-e31760226f9a

66.3 - 1.0

scpcli virtualserver volume transfer list

Description

List volume transfers.

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

Responses

NameDescriptionExample
idVolume Transfer ID1ac231be-823b-4a4d-8ff0-aac503a7118a
nameVolume namevolume01
volume_idVolume ID3f500f00-ed80-4566-a057-e31760226f9a

67 - List volume types

67.1 - 1.2

scpcli virtualserver volume type list
[--limit <value>]
[--offset <value>]
[--marker <value>]
[--sort <value>]

Description

List volume types.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
limit
optional
integerPage size of items. Max value is 1000.20
offset
optional
integerIndex of where to start in the list0
marker
optional
stringThe last item's ID from previous request2a9be312-5d4b-4bc8-b2ae-35100fa9241f
sort
optional
stringComma-separated list of sort keys and optional sort directions in the form of [:]created_at:desc

Responses

NameDescriptionExample
idVolume type IDc643ac35-3aec-43e6-b97a-3d6f666c5207
descriptionVolume type descriptionVolume type description
extra_specsExtra specs
nameVolume type nameSSD

67.2 - 1.1

scpcli virtualserver volume type list
[--limit <value>]
[--offset <value>]
[--marker <value>]
[--sort <value>]

Description

List volume types.

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
limit
optional
integerPage size of items. Max value is 1000.20
offset
optional
integerIndex of where to start in the list0
marker
optional
stringThe last item's ID from previous request2a9be312-5d4b-4bc8-b2ae-35100fa9241f
sort
optional
stringComma-separated list of sort keys and optional sort directions in the form of [:]created_at:desc

Responses

NameDescriptionExample
idVolume type IDc643ac35-3aec-43e6-b97a-3d6f666c5207
descriptionVolume type descriptionVolume type description
extra_specsExtra specs
nameVolume type nameSSD

67.3 - 1.0

scpcli virtualserver volume type list
[--limit <value>]
[--offset <value>]
[--marker <value>]
[--sort <value>]

Description

List volume types.

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
limit
optional
integerPage size of items. Max value is 1000.20
offset
optional
integerIndex of where to start in the list0
marker
optional
stringThe last item's ID from previous request2a9be312-5d4b-4bc8-b2ae-35100fa9241f
sort
optional
stringComma-separated list of sort keys and optional sort directions in the form of [:]created_at:desc

Responses

NameDescriptionExample
idVolume type IDc643ac35-3aec-43e6-b97a-3d6f666c5207
descriptionVolume type descriptionVolume type description
extra_specsExtra specs
nameVolume type nameSSD

68 - List volumes

68.1 - 1.2

scpcli virtualserver volume list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--offset <value>]
[--name <value>]
[--state <value>]
[--bootable <value>]
[--long]

Description

List volumes.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
with_count
optional
booleanWhether to show countTrue
limit
optional
integerPage size of items. Max value is 1000.20
marker
optional
stringThe last item's ID from previous request2a9be312-5d4b-4bc8-b2ae-35100fa9241f
sort
optional
stringComma-separated list of sort keys and optional sort directions in the form of [:]created_at:desc
offset
optional
integerIndex of where to start in the list0
name
optional
stringVolume namevolume01
state
optional
stringVolume stateavailable
bootable
optional
booleanBootableFalse

Responses

NameDescriptionExample
idVolume ID3f500f00-ed80-4566-a057-e31760226f9a
bootableBootableFalse
created_atCreated at
encryptedEncrypted
Requires --long option
True
max_iopsThe number of distinct read or write operations a volume can process in a single second.
Requires --long option
10000
max_throughputThe actual amount of data (volume) transferred to or from the storage device per second.
Requires --long option
500
modified_atModified at
Requires --long option
2025-07-26T12:00:00Z
multiattachConnect to two or more servers, no restriction on the number of connected servers per volume, and Virtual Server can connect up to 26 volumes.
Requires --long option
False
nameVolume namevolume01
serversAttached servers
Requires --long option
sizeVolume size104
snapshot_idSnapshot ID
Requires --long option
cceed636-1f1e-4bb0-b85c-4e5b9e0bf790
stateVolume stateavailable
user_idUser ID
Requires --long option
570907805e5447be84b618450ef52o0t
volume_image_metadataVolume Image metadata
Requires --long option
volume_typeVolume typeSSD
volume_type_idVolume type ID
Requires --long option
c643ac35-3aec-43e6-b97a-3d6f666c5207

68.2 - 1.1

scpcli virtualserver volume list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--offset <value>]
[--name <value>]
[--state <value>]
[--bootable <value>]
[--long]

Description

List volumes.

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
with_count
optional
booleanWhether to show countTrue
limit
optional
integerPage size of items. Max value is 1000.20
marker
optional
stringThe last item's ID from previous request2a9be312-5d4b-4bc8-b2ae-35100fa9241f
sort
optional
stringComma-separated list of sort keys and optional sort directions in the form of [:]created_at:desc
offset
optional
integerIndex of where to start in the list0
name
optional
stringVolume namevolume01
state
optional
stringVolume stateavailable
bootable
optional
booleanBootableFalse

Responses

NameDescriptionExample
idVolume ID3f500f00-ed80-4566-a057-e31760226f9a
bootableBootableFalse
created_atCreated at
encryptedEncrypted
Requires --long option
True
modified_atModified at
Requires --long option
2025-07-26T12:00:00Z
multiattachConnect to two or more servers, no restriction on the number of connected servers per volume, and Virtual Server can connect up to 26 volumes.
Requires --long option
False
nameVolume namevolume01
serversAttached servers
Requires --long option
sizeVolume size104
snapshot_idSnapshot ID
Requires --long option
cceed636-1f1e-4bb0-b85c-4e5b9e0bf790
stateVolume stateavailable
user_idUser ID
Requires --long option
570907805e5447be84b618450ef52o0t
volume_image_metadataVolume Image metadata
Requires --long option
volume_typeVolume typeSSD
volume_type_idVolume type ID
Requires --long option
c643ac35-3aec-43e6-b97a-3d6f666c5207

68.3 - 1.0

scpcli virtualserver volume list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--offset <value>]
[--name <value>]
[--state <value>]
[--bootable <value>]
[--long]

Description

List volumes.

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
with_count
optional
booleanWhether to show countTrue
limit
optional
integerPage size of items. Max value is 1000.20
marker
optional
stringThe last item's ID from previous request2a9be312-5d4b-4bc8-b2ae-35100fa9241f
sort
optional
stringComma-separated list of sort keys and optional sort directions in the form of [:]created_at:desc
offset
optional
integerIndex of where to start in the list0
name
optional
stringVolume namevolume01
state
optional
stringVolume stateavailable
bootable
optional
booleanBootableFalse

Responses

NameDescriptionExample
idVolume ID3f500f00-ed80-4566-a057-e31760226f9a
bootableBootableFalse
created_atCreated at
encryptedEncrypted
Requires --long option
True
modified_atModified at
Requires --long option
2025-07-26T12:00:00Z
multiattachConnect to two or more servers, no restriction on the number of connected servers per volume, and Virtual Server can connect up to 26 volumes.
Requires --long option
False
nameVolume namevolume01
serversAttached servers
Requires --long option
sizeVolume size104
snapshot_idSnapshot ID
Requires --long option
cceed636-1f1e-4bb0-b85c-4e5b9e0bf790
stateVolume stateavailable
user_idUser ID
Requires --long option
570907805e5447be84b618450ef52o0t
volume_image_metadataVolume Image metadata
Requires --long option
volume_typeVolume typeSSD
volume_type_idVolume type ID
Requires --long option
c643ac35-3aec-43e6-b97a-3d6f666c5207

69 - Lock Virtual Server

69.1 - 1.2

scpcli virtualserver server lock
--server_id <value>

Description

Lock Virtual Server.

The lock prevents actions such as terminate/start/stop the server from being executed, preventing accidental actions.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample

69.2 - 1.1

scpcli virtualserver server lock
--server_id <value>

Description

Lock Virtual Server.

The lock prevents actions such as terminate/start/stop the server from being executed, preventing accidental actions.

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
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample

69.3 - 1.0

scpcli virtualserver server lock
--server_id <value>

Description

Lock Virtual Server.

The lock prevents actions such as terminate/start/stop the server from being executed, preventing accidental actions.

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
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample

70 - Reboot Virtual Server

70.1 - 1.2

scpcli virtualserver server reboot
--server_id <value>
[--reboot_type <value>]

Description

Reboot Virtual Server.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
reboot_type
optional
****Reboot type. A SOFT reboot attempts a graceful shutdown and restart of the server. A HARD reboot attempts a forced shutdown and restart of the server. The HARD reboot corresponds to the power cycles of the server.SOFT

Responses

NameDescriptionExample

70.2 - 1.1

scpcli virtualserver server reboot
--server_id <value>
[--reboot_type <value>]

Description

Reboot Virtual Server.

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
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
reboot_type
optional
****Reboot type. A SOFT reboot attempts a graceful shutdown and restart of the server. A HARD reboot attempts a forced shutdown and restart of the server. The HARD reboot corresponds to the power cycles of the server.SOFT

Responses

NameDescriptionExample

70.3 - 1.0

scpcli virtualserver server reboot
--server_id <value>
[--reboot_type <value>]

Description

Reboot Virtual Server.

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
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
reboot_type
optional
****Reboot type. A SOFT reboot attempts a graceful shutdown and restart of the server. A HARD reboot attempts a forced shutdown and restart of the server. The HARD reboot corresponds to the power cycles of the server.SOFT

Responses

NameDescriptionExample

71 - Rebuild Virtual Server

71.1 - 1.2

scpcli virtualserver server rebuild
--server_id <value>

Description

Rebuild Virtual Server.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample

71.2 - 1.1

scpcli virtualserver server rebuild
--server_id <value>

Description

Rebuild Virtual Server.

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
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample

71.3 - 1.0

scpcli virtualserver server rebuild
--server_id <value>

Description

Rebuild Virtual Server.

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
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample

72 - Revert Volume to snapshot

72.1 - 1.2

scpcli virtualserver volume revert
--volume_id <value>
--snapshot_id <value>

Description

Revert a volume to its latest snapshot, this API only support reverting a detached volume, and the volume status must be available.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
snapshot_id
required
stringSnapshot IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790

Responses

NameDescriptionExample

72.2 - 1.1

scpcli virtualserver volume revert
--volume_id <value>
--snapshot_id <value>

Description

Revert a volume to its latest snapshot, this API only support reverting a detached volume, and the volume status must be available.

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
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
snapshot_id
required
stringSnapshot IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790

Responses

NameDescriptionExample

72.3 - 1.0

scpcli virtualserver volume revert
--volume_id <value>
--snapshot_id <value>

Description

Revert a volume to its latest snapshot, this API only support reverting a detached volume, and the volume status must be available.

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
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
snapshot_id
required
stringSnapshot IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790

Responses

NameDescriptionExample

73 - Set Volume Qos

73.1 - 1.2

scpcli virtualserver volume revert
--volume_id <value>
[--max_iops <value>]
[--max_throughput <value>]

Description

Set Volume Qos

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
max_iops
optional
integerThe number of distinct read or write operations a volume can process in a single second.10000
max_throughput
optional
integerThe actual amount of data (volume) transferred to or from the storage device per second.500

74 - Show a snapshot’s details

74.1 - 1.2

scpcli virtualserver volume snapshot show
--snapshot_id <value>

Description

Show a snapshot’s details.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
snapshot_id
required
stringSnapshot IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790

Responses

NameDescriptionExample
idSnapshot IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790
created_atCreated at2025-07-22T09:00:00Z
descriptionDescriptiondescription
metadataOne or more metadata key and value pairs for the snapshotMetadata
nameSnapshot namesnapshot-1
sizeVolume size104
statusVolume stateavailable
updated_atUpdated at2025-07-26T12:00:00Z
user_idUser ID570907805e5447be84b618450ef52o0t
volume_idVolume ID3f500f00-ed80-4566-a057-e31760226f9a

74.2 - 1.1

scpcli virtualserver volume snapshot show
--snapshot_id <value>

Description

Show a snapshot’s details.

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
snapshot_id
required
stringSnapshot IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790

Responses

NameDescriptionExample
idSnapshot IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790
created_atCreated at2025-07-22T09:00:00Z
descriptionDescriptiondescription
metadataOne or more metadata key and value pairs for the snapshotMetadata
nameSnapshot namesnapshot-1
sizeVolume size104
statusVolume stateavailable
updated_atUpdated at2025-07-26T12:00:00Z
user_idUser ID570907805e5447be84b618450ef52o0t
volume_idVolume ID3f500f00-ed80-4566-a057-e31760226f9a

74.3 - 1.0

scpcli virtualserver volume snapshot show
--snapshot_id <value>

Description

Show a snapshot’s details.

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
snapshot_id
required
stringSnapshot IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790

Responses

NameDescriptionExample
idSnapshot IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790
created_atCreated at2025-07-22T09:00:00Z
descriptionDescriptiondescription
metadataOne or more metadata key and value pairs for the snapshotMetadata
nameSnapshot namesnapshot-1
sizeVolume size104
statusVolume stateavailable
updated_atUpdated at2025-07-26T12:00:00Z
user_idUser ID570907805e5447be84b618450ef52o0t
volume_idVolume ID3f500f00-ed80-4566-a057-e31760226f9a

75 - Show Auto-Scaling Group

75.1 - 1.2

scpcli virtualserver auto scaling group show
--auto_scaling_group_id <value>

Description

Show Auto-Scaling Group.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

Responses

NameDescriptionExample
idLB Server Group IDd06e87d3-ca9a-461b-8e88-077a542a7335
portLB Server Group port8080

75.2 - 1.1

scpcli virtualserver auto scaling group show
--auto_scaling_group_id <value>

Description

Show Auto-Scaling Group.

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
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

Responses

NameDescriptionExample
idLB Server Group IDd06e87d3-ca9a-461b-8e88-077a542a7335
portLB Server Group port8080

75.3 - 1.0

scpcli virtualserver auto scaling group show
--auto_scaling_group_id <value>

Description

Show Auto-Scaling Group.

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
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

Responses

NameDescriptionExample
idLB Server Group IDd06e87d3-ca9a-461b-8e88-077a542a7335
portLB Server Group port8080

76 - Show Auto-Scaling Group Notification

76.1 - 1.2

scpcli virtualserver auto scaling group notification show
--notification_id <value>
--auto_scaling_group_id <value>

Description

Show Auto-Scaling Group notification.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
notification_id
required
stringAuto-Scaling Group notification IDfa7fd191410744cd810a290c0b4d22b9
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_idAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
notification_eventsAuto-Scaling Group notification event list[‘SCALE_OUT’, ‘SCALE_OUT_FAIL’]
notification_stateAuto-Scaling Group notification stateACTIVE
user_emailUser emailscpuser@samsung.com
user_idUser ID570907805e5447be84b618450ef52o0t
user_nameUser namescpuser

76.2 - 1.1

scpcli virtualserver auto scaling group notification show
--notification_id <value>
--auto_scaling_group_id <value>

Description

Show Auto-Scaling Group notification.

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
notification_id
required
stringAuto-Scaling Group notification IDfa7fd191410744cd810a290c0b4d22b9
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_idAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
notification_eventsAuto-Scaling Group notification event list[‘SCALE_OUT’, ‘SCALE_OUT_FAIL’]
notification_stateAuto-Scaling Group notification stateACTIVE
user_emailUser emailscpuser@samsung.com
user_idUser ID570907805e5447be84b618450ef52o0t
user_nameUser namescpuser

76.3 - 1.0

scpcli virtualserver auto scaling group notification show
--notification_id <value>
--auto_scaling_group_id <value>

Description

Show Auto-Scaling Group notification.

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
notification_id
required
stringAuto-Scaling Group notification IDfa7fd191410744cd810a290c0b4d22b9
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_idAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
notification_eventsAuto-Scaling Group notification event list[‘SCALE_OUT’, ‘SCALE_OUT_FAIL’]
notification_stateAuto-Scaling Group notification stateACTIVE
user_emailUser emailscpuser@samsung.com
user_idUser ID570907805e5447be84b618450ef52o0t
user_nameUser namescpuser

77 - Show Auto-Scaling Group Policy

77.1 - 1.2

scpcli virtualserver auto scaling group policy show
--policy_id <value>
--auto_scaling_group_id <value>

Description

Show Auto-Scaling Group policy.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID0761d76085f54363bab07909baf69841
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_idAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
comparison_operatorComparison operatorge
cooldown_secondsCooldown seconds300
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
evaluation_minutesEvaluation minutes5
metric_methodMetric methodAVG
metric_typeMetric typeCPU
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePolicy namepolicy-name
scale_methodScale methodAMOUNT
scale_typeScale typeSCALE_OUT
scale_valueScale value10
statePolicy stateACTIVE
thresholdThreshold60
threshold_unitThreshold unit%

77.2 - 1.1

scpcli virtualserver auto scaling group policy show
--policy_id <value>
--auto_scaling_group_id <value>

Description

Show Auto-Scaling Group policy.

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
policy_id
required
stringPolicy ID0761d76085f54363bab07909baf69841
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_idAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
comparison_operatorComparison operatorge
cooldown_secondsCooldown seconds300
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
evaluation_minutesEvaluation minutes5
metric_methodMetric methodAVG
metric_typeMetric typeCPU
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePolicy namepolicy-name
scale_methodScale methodAMOUNT
scale_typeScale typeSCALE_OUT
scale_valueScale value10
statePolicy stateACTIVE
thresholdThreshold60
threshold_unitThreshold unit%

77.3 - 1.0

scpcli virtualserver auto scaling group policy show
--policy_id <value>
--auto_scaling_group_id <value>

Description

Show Auto-Scaling Group policy.

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
policy_id
required
stringPolicy ID0761d76085f54363bab07909baf69841
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_idAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
comparison_operatorComparison operatorge
cooldown_secondsCooldown seconds300
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
evaluation_minutesEvaluation minutes5
metric_methodMetric methodAVG
metric_typeMetric typeCPU
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePolicy namepolicy-name
scale_methodScale methodAMOUNT
scale_typeScale typeSCALE_OUT
scale_valueScale value10
statePolicy stateACTIVE
thresholdThreshold60
threshold_unitThreshold unit%

78 - Show Auto-Scaling Group Schedule

78.1 - 1.2

scpcli virtualserver auto scaling group schedule show
--schedule_id <value>
--auto_scaling_group_id <value>

Description

Show Auto-Scaling Group schedule.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
schedule_id
required
stringSchedule ID43d4841abd404220af5f0904037aba71
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
day_of_monthDay of the month-1,1
day_of_weekDay of the weekSU,SA
descriptionDescriptiondescription
desired_server_countDesired server count1
end_dateEnd date2025-01-01
frequencyFrequencyWEEKLY
hourHour9
max_server_countMax server count2
min_server_countMin server count1
minuteMinute0
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSchedule nameschedulename
start_dateStart date2024-01-01
stateSchedule stateACTIVE
timezoneTimezoneAsia/Seoul

78.2 - 1.1

scpcli virtualserver auto scaling group schedule show
--schedule_id <value>
--auto_scaling_group_id <value>

Description

Show Auto-Scaling Group schedule.

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
schedule_id
required
stringSchedule ID43d4841abd404220af5f0904037aba71
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
day_of_monthDay of the month-1,1
day_of_weekDay of the weekSU,SA
descriptionDescriptiondescription
desired_server_countDesired server count1
end_dateEnd date2025-01-01
frequencyFrequencyWEEKLY
hourHour9
max_server_countMax server count2
min_server_countMin server count1
minuteMinute0
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSchedule nameschedulename
start_dateStart date2024-01-01
stateSchedule stateACTIVE
timezoneTimezoneAsia/Seoul

78.3 - 1.0

scpcli virtualserver auto scaling group schedule show
--schedule_id <value>
--auto_scaling_group_id <value>

Description

Show Auto-Scaling Group schedule.

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
schedule_id
required
stringSchedule ID43d4841abd404220af5f0904037aba71
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
day_of_monthDay of the month-1,1
day_of_weekDay of the weekSU,SA
descriptionDescriptiondescription
desired_server_countDesired server count1
end_dateEnd date2025-01-01
frequencyFrequencyWEEKLY
hourHour9
max_server_countMax server count2
min_server_countMin server count1
minuteMinute0
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSchedule nameschedulename
start_dateStart date2024-01-01
stateSchedule stateACTIVE
timezoneTimezoneAsia/Seoul

79 - Show default Volume type’s details

79.1 - 1.2

scpcli virtualserver volume type default show

Description

Show a default Volume type’s details.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Responses

NameDescriptionExample
idVolume type IDc643ac35-3aec-43e6-b97a-3d6f666c5207
descriptionVolume type descriptionVolume type description
extra_specsExtra specs
nameVolume type nameSSD

79.2 - 1.1

scpcli virtualserver volume type default show

Description

Show a default Volume type’s details.

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

Responses

NameDescriptionExample
idVolume type IDc643ac35-3aec-43e6-b97a-3d6f666c5207
descriptionVolume type descriptionVolume type description
extra_specsExtra specs
nameVolume type nameSSD

79.3 - 1.0

scpcli virtualserver volume type default show

Description

Show a default Volume type’s details.

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

Responses

NameDescriptionExample
idVolume type IDc643ac35-3aec-43e6-b97a-3d6f666c5207
descriptionVolume type descriptionVolume type description
extra_specsExtra specs
nameVolume type nameSSD

80 - Show Image

80.1 - 1.2

scpcli virtualserver image show
--image_id <value>

Description

Show Image.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b

Responses

NameDescriptionExample
idImage ID70a599e0-31e7-49b7-b260-868f441e862b
checksumMD5 hash of the entire image data. and this field could be used to verify the integrity of image.7538e0fcb56e0e272cfd89eb384d6613
container_formatContainer formatbare
created_atCreated at2025-07-22T09:00:00Z
disk_formatDisk formatqcow2
fileThe URL for the virtual server image file/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file
min_diskMinimum disk capacity (GB) of the Image to be created100
min_ramMinimum RAM capacity (GB) of the Image to be created0
nameImage nameimagename
os_distroOS distribution of the image to be uploadedalma
os_hash_algoOS hash algorithm used to verify image integritysha512
os_hash_valueThe actual digest of the image binary, calculated with the algorithm indicated by os_hash_algo. The value is presented as a hexadecimal string.c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99
os_hiddenWhether the image is hiddenFalse
ownerOwner account IDa8f10467abfc4b87b64614ab36eb9ae4
owner_account_nameOwner account nameAccountName
owner_user_nameOwner user nameuser@samsung.com
protectedwhether Image deletion is prohibitedFalse
root_device_nameRoot device name/dev/vda
scp_gpu_driverK8s GPU Image driver version535.183.06
scp_image_typeImage typecustom
scp_k8s_versionK8S versionv1.28.7
scp_original_image_typeOriginal Image typestandard
scp_os_build_versionOS build version20250101
scp_os_versionOS version8.8
sizeImage size2429747200
statusImage statusactive
updated_atUpdated at2025-07-26T12:00:00Z
urlObject Storage URL for Image file (only qcow2 format allowed)https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2
virtual_sizeVirtual size17179869184
visibilityIndicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accountsprivate
volumesVolumes[{“tag”: null, “volume_id”: null, “encryption_options”: null, “encryption_secret_uuid”: null, “encryption_format”: null, “device_name”: “/dev/vda”, “disk_bus”: “virtio”, “volume_type”: null, “encrypted”: null, “image_id”: null, “device_type”: “disk”, “source_type”: “snapshot”, “delete_on_termination”: false, “volume_size”: 104, “guest_format”: null, “boot_index”: 0, “destination_type”: “volume”, “snapshot_id”: “abde9e38-2ed5-4ecd-b23c-b0120e30690e”, “no_device”: null}]

80.2 - 1.1

scpcli virtualserver image show
--image_id <value>

Description

Show Image.

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
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b

Responses

NameDescriptionExample
idImage ID70a599e0-31e7-49b7-b260-868f441e862b
checksumMD5 hash of the entire image data. and this field could be used to verify the integrity of image.7538e0fcb56e0e272cfd89eb384d6613
container_formatContainer formatbare
created_atCreated at2025-07-22T09:00:00Z
disk_formatDisk formatqcow2
fileThe URL for the virtual server image file/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file
min_diskMinimum disk capacity (GB) of the Image to be created100
min_ramMinimum RAM capacity (GB) of the Image to be created0
nameImage nameimagename
os_distroOS distribution of the image to be uploadedalma
os_hash_algoOS hash algorithm used to verify image integritysha512
os_hash_valueThe actual digest of the image binary, calculated with the algorithm indicated by os_hash_algo. The value is presented as a hexadecimal string.c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99
os_hiddenWhether the image is hiddenFalse
ownerOwner account IDa8f10467abfc4b87b64614ab36eb9ae4
owner_account_nameOwner account nameAccountName
owner_user_nameOwner user nameuser@samsung.com
protectedwhether Image deletion is prohibitedFalse
root_device_nameRoot device name/dev/vda
scp_image_typeImage typecustom
scp_k8s_versionK8S versionv1.28.7
scp_original_image_typeOriginal Image typestandard
scp_os_build_versionOS build version20250101
scp_os_versionOS version8.8
sizeImage size2429747200
statusImage statusactive
updated_atUpdated at2025-07-26T12:00:00Z
urlObject Storage URL for Image file (only qcow2 format allowed)https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2
virtual_sizeVirtual size17179869184
visibilityIndicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accountsprivate
volumesVolumes[{“tag”: null, “volume_id”: null, “encryption_options”: null, “encryption_secret_uuid”: null, “encryption_format”: null, “device_name”: “/dev/vda”, “disk_bus”: “virtio”, “volume_type”: null, “encrypted”: null, “image_id”: null, “device_type”: “disk”, “source_type”: “snapshot”, “delete_on_termination”: false, “volume_size”: 104, “guest_format”: null, “boot_index”: 0, “destination_type”: “volume”, “snapshot_id”: “abde9e38-2ed5-4ecd-b23c-b0120e30690e”, “no_device”: null}]

80.3 - 1.0

scpcli virtualserver image show
--image_id <value>

Description

Show Image.

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
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b

Responses

NameDescriptionExample
idImage ID70a599e0-31e7-49b7-b260-868f441e862b
checksumMD5 hash of the entire image data. and this field could be used to verify the integrity of image.7538e0fcb56e0e272cfd89eb384d6613
container_formatContainer formatbare
created_atCreated at2025-07-22T09:00:00Z
disk_formatDisk formatqcow2
fileThe URL for the virtual server image file/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file
min_diskMinimum disk capacity (GB) of the Image to be created100
min_ramMinimum RAM capacity (GB) of the Image to be created0
nameImage nameimagename
os_distroOS distribution of the image to be uploadedalma
os_hash_algoOS hash algorithm used to verify image integritysha512
os_hash_valueThe actual digest of the image binary, calculated with the algorithm indicated by os_hash_algo. The value is presented as a hexadecimal string.c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99
os_hiddenWhether the image is hiddenFalse
ownerOwner account IDa8f10467abfc4b87b64614ab36eb9ae4
owner_account_nameOwner account nameAccountName
owner_user_nameOwner user nameuser@samsung.com
protectedwhether Image deletion is prohibitedFalse
root_device_nameRoot device name/dev/vda
scp_image_typeImage typecustom
scp_k8s_versionK8S versionv1.28.7
scp_original_image_typeOriginal Image typestandard
scp_os_build_versionOS build version20250101
scp_os_versionOS version8.8
sizeImage size2429747200
statusImage statusactive
updated_atUpdated at2025-07-26T12:00:00Z
urlObject Storage URL for Image file (only qcow2 format allowed)https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2
virtual_sizeVirtual size17179869184
visibilityIndicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accountsprivate
volumesVolumes[{“tag”: null, “volume_id”: null, “encryption_options”: null, “encryption_secret_uuid”: null, “encryption_format”: null, “device_name”: “/dev/vda”, “disk_bus”: “virtio”, “volume_type”: null, “encrypted”: null, “image_id”: null, “device_type”: “disk”, “source_type”: “snapshot”, “delete_on_termination”: false, “volume_size”: 104, “guest_format”: null, “boot_index”: 0, “destination_type”: “volume”, “snapshot_id”: “abde9e38-2ed5-4ecd-b23c-b0120e30690e”, “no_device”: null}]

81 - Show Image member

81.1 - 1.2

scpcli virtualserver image member show
--member_id <value>
--image_id <value>

Description

Show Image member.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
member_id
required
stringShared Image member IDa8f10467abfc4b87b64614ab36eb9ae4
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b

Responses

NameDescriptionExample
created_atCreated at2025-07-22T09:00:00Z
image_idImage ID70a599e0-31e7-49b7-b260-868f441e862b
member_idShared Image member IDa8f10467abfc4b87b64614ab36eb9ae4
statusStatus of this Image member. Value of one of pending, accepted, rejected.pending
updated_atUpdated at2025-07-26T12:00:00Z

81.2 - 1.1

scpcli virtualserver image member show
--member_id <value>
--image_id <value>

Description

Show Image member.

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
member_id
required
stringShared Image member IDa8f10467abfc4b87b64614ab36eb9ae4
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b

Responses

NameDescriptionExample
created_atCreated at2025-07-22T09:00:00Z
image_idImage ID70a599e0-31e7-49b7-b260-868f441e862b
member_idShared Image member IDa8f10467abfc4b87b64614ab36eb9ae4
statusStatus of this Image member. Value of one of pending, accepted, rejected.pending
updated_atUpdated at2025-07-26T12:00:00Z

81.3 - 1.0

scpcli virtualserver image member show
--member_id <value>
--image_id <value>

Description

Show Image member.

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
member_id
required
stringShared Image member IDa8f10467abfc4b87b64614ab36eb9ae4
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b

Responses

NameDescriptionExample
created_atCreated at2025-07-22T09:00:00Z
image_idImage ID70a599e0-31e7-49b7-b260-868f441e862b
member_idShared Image member IDa8f10467abfc4b87b64614ab36eb9ae4
statusStatus of this Image member. Value of one of pending, accepted, rejected.pending
updated_atUpdated at2025-07-26T12:00:00Z

82 - Show Keypair

82.1 - 1.2

scpcli virtualserver keypair show
--keypair_name <value>

Description

Show keypair.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
keypair_name
required
stringKeypair namekeypairname

Responses

NameDescriptionExample
idKeypair ID1
created_atCreated at2025-07-22T09:00:00Z
fingerprintFingerprint7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd
nameKeypair namekeypairname
public_keyPublic Keyssh-rsa fakeKey Generated-by-SCP
typeKeypair typessh
user_idUser ID570907805e5447be84b618450ef52o0t

82.2 - 1.1

scpcli virtualserver keypair show
--keypair_name <value>

Description

Show keypair.

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
keypair_name
required
stringKeypair namekeypairname

Responses

NameDescriptionExample
idKeypair ID1
created_atCreated at2025-07-22T09:00:00Z
fingerprintFingerprint7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd
nameKeypair namekeypairname
public_keyPublic Keyssh-rsa fakeKey Generated-by-SCP
typeKeypair typessh
user_idUser ID570907805e5447be84b618450ef52o0t

82.3 - 1.0

scpcli virtualserver keypair show
--keypair_name <value>

Description

Show keypair.

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
keypair_name
required
stringKeypair namekeypairname

Responses

NameDescriptionExample
idKeypair ID1
created_atCreated at2025-07-22T09:00:00Z
fingerprintFingerprint7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd
nameKeypair namekeypairname
public_keyPublic Keyssh-rsa fakeKey Generated-by-SCP
typeKeypair typessh
user_idUser ID570907805e5447be84b618450ef52o0t

83 - Show Launch Configuration

83.1 - 1.2

scpcli virtualserver launch configuration show
--launch_configuration_id <value>

Description

Show Launch Configuration.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
launch_configuration_id
required
stringLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f

Responses

NameDescriptionExample
boot_indexBoot index0
max_iopsThe number of distinct read or write operations a volume can process in a single second.10000
max_throughputThe actual amount of data (volume) transferred to or from the storage device per second.500
sizeVolume size104
typeVolume typeSSD

83.2 - 1.1

scpcli virtualserver launch configuration show
--launch_configuration_id <value>

Description

Show Launch Configuration.

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
launch_configuration_id
required
stringLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f

Responses

NameDescriptionExample
boot_indexBoot index0
sizeVolume size104
typeVolume typeSSD

83.3 - 1.0

scpcli virtualserver launch configuration show
--launch_configuration_id <value>

Description

Show Launch Configuration.

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
launch_configuration_id
required
stringLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f

Responses

NameDescriptionExample
boot_indexBoot index0
sizeVolume size104
typeVolume typeSSD

84 - Show Server Group

84.1 - 1.2

scpcli virtualserver server group show
--server_group_id <value>

Description

Show server group.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
server_group_id
required
stringServer Group ID616fb98f-46ca-475e-917e-2563e5a8cd19

Responses

NameDescriptionExample
idServer Group ID616fb98f-46ca-475e-917e-2563e5a8cd19
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
membersList of Virtual Servers belonging to Server Group[‘2a9be312-5d4b-4bc8-b2ae-35100fa9241f’]
nameServer Group nameserver-group
partition_sizeSize of partition when server group policy is partition3
policyServer Group policyanti-affinity
user_idUser ID570907805e5447be84b618450ef52o0t

84.2 - 1.1

scpcli virtualserver server group show
--server_group_id <value>

Description

Show server group.

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
server_group_id
required
stringServer Group ID616fb98f-46ca-475e-917e-2563e5a8cd19

Responses

NameDescriptionExample
idServer Group ID616fb98f-46ca-475e-917e-2563e5a8cd19
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
membersList of Virtual Servers belonging to Server Group[‘2a9be312-5d4b-4bc8-b2ae-35100fa9241f’]
nameServer Group nameserver-group
partition_sizeSize of partition when server group policy is partition3
policyServer Group policyanti-affinity
user_idUser ID570907805e5447be84b618450ef52o0t

84.3 - 1.0

scpcli virtualserver server group show
--server_group_id <value>

Description

Show server group.

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
server_group_id
required
stringServer Group ID616fb98f-46ca-475e-917e-2563e5a8cd19

Responses

NameDescriptionExample
idServer Group ID616fb98f-46ca-475e-917e-2563e5a8cd19
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
membersList of Virtual Servers belonging to Server Group[‘2a9be312-5d4b-4bc8-b2ae-35100fa9241f’]
nameServer Group nameserver-group
partition_sizeSize of partition when server group policy is partition3
policyServer Group policyanti-affinity
user_idUser ID570907805e5447be84b618450ef52o0t

85 - Show Server Interface

85.1 - 1.2

scpcli virtualserver server interface show
--port_id <value>
--server_id <value>

Description

Show Server Interface.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID91424c08-0b26-49fb-9808-ed042292ceef
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
fixed_ipsFixed IP list
is_defaultIndicates whether this is the default port.True
mac_addrMAC Addressfa:16:3e:c0:71:2b
port_idPort IDf2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc
port_statePort StateACTIVE
private_static_natPrivate Static NAT
static_natPublic Static NAT
subnet_idSubnet ID183c6c30df0c4fcbb16422aa2d64aa21

85.2 - 1.1

scpcli virtualserver server interface show
--port_id <value>
--server_id <value>

Description

Show Server Interface.

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
port_id
required
stringPort ID91424c08-0b26-49fb-9808-ed042292ceef
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
fixed_ipsFixed IP list
mac_addrMAC Addressfa:16:3e:c0:71:2b
port_idPort IDf2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc
port_statePort StateACTIVE
private_static_natPrivate Static NAT
static_natPublic Static NAT
subnet_idSubnet ID183c6c30df0c4fcbb16422aa2d64aa21

85.3 - 1.0

scpcli virtualserver server interface show
--port_id <value>
--server_id <value>

Description

Show Server Interface.

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
port_id
required
stringPort ID91424c08-0b26-49fb-9808-ed042292ceef
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
fixed_ipsFixed IP list
mac_addrMAC Addressfa:16:3e:c0:71:2b
port_idPort IDf2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc
port_statePort StateACTIVE
private_static_natPrivate Static NAT
static_natPublic Static NAT
subnet_idSubnet ID183c6c30df0c4fcbb16422aa2d64aa21

86 - Show Server Ip

86.1 - 1.2

scpcli virtualserver server ip show
--subnet_id <value>
--server_id <value>

Description

Show Server Ip.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet ID78b2ee3f074145c580ab6abac4821f97
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
ip_addressIP address192.169.3.2
versionIP address version4

86.2 - 1.1

scpcli virtualserver server ip show
--subnet_id <value>
--server_id <value>

Description

Show Server Ip.

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
subnet_id
required
stringSubnet ID78b2ee3f074145c580ab6abac4821f97
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
ip_addressIP address192.169.3.2
versionIP address version4

86.3 - 1.0

scpcli virtualserver server ip show
--subnet_id <value>
--server_id <value>

Description

Show Server Ip.

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
subnet_id
required
stringSubnet ID78b2ee3f074145c580ab6abac4821f97
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
ip_addressIP address192.169.3.2
versionIP address version4

87 - Show Server Quota Set

87.1 - 1.2

scpcli virtualserver quota set show

Description

Show server quota Set.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Responses

NameDescriptionExample
idQuota set IDfc7283354c6143a58629b59f4c3e16b2
coresCore quota
instancesInstance quota
keypairsKeypairs quota
metadata_itemsMetadata items quota
ramRAM quota
server_group_membersServer group members quota
server_groupsServer groups quota

87.2 - 1.1

scpcli virtualserver quota set show

Description

Show server quota Set.

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

Responses

NameDescriptionExample
idQuota set IDfc7283354c6143a58629b59f4c3e16b2
coresCore quota
instancesInstance quota
keypairsKeypairs quota
metadata_itemsMetadata items quota
ramRAM quota
server_group_membersServer group members quota
server_groupsServer groups quota

87.3 - 1.0

scpcli virtualserver quota set show

Description

Show server quota Set.

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

Responses

NameDescriptionExample
idQuota set IDfc7283354c6143a58629b59f4c3e16b2
coresCore quota
instancesInstance quota
keypairsKeypairs quota
metadata_itemsMetadata items quota
ramRAM quota
server_group_membersServer group members quota
server_groupsServer groups quota

88 - Show Server Type

88.1 - 1.2

scpcli virtualserver server type show
--server_type_id <value>

Description

Show server type.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
server_type_id
required
stringServer type IDs1v1m2

Responses

NameDescriptionExample
idServer type IDs1v1m2
descriptionDescriptiondescription
diskSize of root disk100
ephemeralSize of ephemeral disk0
extra_specsExtra specs
nameServer type names1v1m2
ramAmount of RAM2
swapSize of dedicated swap disk0
vcpusNumber of CPUs1

88.2 - 1.1

scpcli virtualserver server type show
--server_type_id <value>

Description

Show server type.

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
server_type_id
required
stringServer type IDs1v1m2

Responses

NameDescriptionExample
idServer type IDs1v1m2
descriptionDescriptiondescription
diskSize of root disk100
ephemeralSize of ephemeral disk0
extra_specsExtra specs
nameServer type names1v1m2
ramAmount of RAM2
swapSize of dedicated swap disk0
vcpusNumber of CPUs1

88.3 - 1.0

scpcli virtualserver server type show
--server_type_id <value>

Description

Show server type.

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
server_type_id
required
stringServer type IDs1v1m2

Responses

NameDescriptionExample
idServer type IDs1v1m2
descriptionDescriptiondescription
diskSize of root disk100
ephemeralSize of ephemeral disk0
extra_specsExtra specs
nameServer type names1v1m2
ramAmount of RAM2
swapSize of dedicated swap disk0
vcpusNumber of CPUs1

89 - Show Server Volume

89.1 - 1.2

scpcli virtualserver server volume show
--volume_id <value>
--server_id <value>

Description

Show Server Volume.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
idVolume Attachment ID3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c
delete_on_terminationDelete the boot volume when the server is terminated.False
deviceDevice name such as, /dev/vda./dev/vda
server_idServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_idVolume ID3f500f00-ed80-4566-a057-e31760226f9a

89.2 - 1.1

scpcli virtualserver server volume show
--volume_id <value>
--server_id <value>

Description

Show Server Volume.

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
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
idVolume Attachment ID3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c
delete_on_terminationDelete the boot volume when the server is terminated.False
deviceDevice name such as, /dev/vda./dev/vda
server_idServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_idVolume ID3f500f00-ed80-4566-a057-e31760226f9a

89.3 - 1.0

scpcli virtualserver server volume show
--volume_id <value>
--server_id <value>

Description

Show Server Volume.

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
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
idVolume Attachment ID3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c
delete_on_terminationDelete the boot volume when the server is terminated.False
deviceDevice name such as, /dev/vda./dev/vda
server_idServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_idVolume ID3f500f00-ed80-4566-a057-e31760226f9a

90 - Show Virtual Server

90.1 - 1.2

scpcli virtualserver server show
--server_id <value>

Description

Show Virtual Server.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
ip_addressesIP addresses
subnet_nameSubnet namesubnetname

90.2 - 1.1

scpcli virtualserver server show
--server_id <value>

Description

Show Virtual Server.

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
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
ip_addressesIP addresses
subnet_nameSubnet namesubnetname

90.3 - 1.0

scpcli virtualserver server show
--server_id <value>

Description

Show Virtual Server.

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
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
ip_addressesIP addresses
subnet_nameSubnet namesubnetname

91 - Show Virtual Server Console Log

91.1 - 1.2

scpcli virtualserver server console log show
--server_id <value>
[--line_size <value>]

Description

Show Virtual Server Console Log.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
line_size
optional
integerNumber of log lines to get1

Responses

NameDescriptionExample
outputServer console log outputFAKE CONSOLE OUTPUT

91.2 - 1.1

scpcli virtualserver server console log show
--server_id <value>
[--line_size <value>]

Description

Show Virtual Server Console Log.

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
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
line_size
optional
integerNumber of log lines to get1

Responses

NameDescriptionExample
outputServer console log outputFAKE CONSOLE OUTPUT

91.3 - 1.0

scpcli virtualserver server console log show
--server_id <value>
[--line_size <value>]

Description

Show Virtual Server Console Log.

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
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
line_size
optional
integerNumber of log lines to get1

Responses

NameDescriptionExample
outputServer console log outputFAKE CONSOLE OUTPUT

92 - Show Virtual Server Password

92.1 - 1.2

scpcli virtualserver server password show
--server_id <value>
[--private_key <value>]

Description

Show Virtual Server Password.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
private_key
optional
stringPrivate key```—–BEGIN RSA PRIVATE KEY—–
fakeKey
—–END RSA PRIVATE KEY—–```

Responses

NameDescriptionExample
passwordServer passwordpassword

92.2 - 1.1

scpcli virtualserver server password show
--server_id <value>
[--private_key <value>]

Description

Show Virtual Server Password.

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
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
private_key
optional
stringPrivate key```—–BEGIN RSA PRIVATE KEY—–
fakeKey
—–END RSA PRIVATE KEY—–```

Responses

NameDescriptionExample
passwordServer passwordpassword

92.3 - 1.0

scpcli virtualserver server password show
--server_id <value>
[--private_key <value>]

Description

Show Virtual Server Password.

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
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
private_key
optional
stringPrivate key```—–BEGIN RSA PRIVATE KEY—–
fakeKey
—–END RSA PRIVATE KEY—–```

Responses

NameDescriptionExample
passwordServer passwordpassword

93 - Show Volume Quota Set

93.1 - 1.2

scpcli virtualserver volume quota set show

Description

Show volume quota set.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Responses

NameDescriptionExample
idQuota set IDfc7283354c6143a58629b59f4c3e16b2
per_volume_sizePer volume size quota
snapshotsSnapshot Quota
usagesUsage quota
volumesVolume Quota

93.2 - 1.1

scpcli virtualserver volume quota set show

Description

Show volume quota set.

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

Responses

NameDescriptionExample
idQuota set IDfc7283354c6143a58629b59f4c3e16b2
per_volume_sizePer volume size quota
snapshotsSnapshot Quota
usagesUsage quota
volumesVolume Quota

93.3 - 1.0

scpcli virtualserver volume quota set show

Description

Show volume quota set.

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

Responses

NameDescriptionExample
idQuota set IDfc7283354c6143a58629b59f4c3e16b2
per_volume_sizePer volume size quota
snapshotsSnapshot Quota
usagesUsage quota
volumesVolume Quota

94 - Show volume transfer detail

94.1 - 1.2

scpcli virtualserver volume transfer show
--transfer_id <value>

Description

Show volume transfer detail.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
transfer_id
required
stringVolume Transfer ID1ac231be-823b-4a4d-8ff0-aac503a7118a

Responses

NameDescriptionExample
idVolume Transfer ID1ac231be-823b-4a4d-8ff0-aac503a7118a
created_atCreated at2025-07-22T09:00:00Z
nameVolume namevolume01
volume_idVolume ID3f500f00-ed80-4566-a057-e31760226f9a

94.2 - 1.1

scpcli virtualserver volume transfer show
--transfer_id <value>

Description

Show volume transfer detail.

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
transfer_id
required
stringVolume Transfer ID1ac231be-823b-4a4d-8ff0-aac503a7118a

Responses

NameDescriptionExample
idVolume Transfer ID1ac231be-823b-4a4d-8ff0-aac503a7118a
created_atCreated at2025-07-22T09:00:00Z
nameVolume namevolume01
volume_idVolume ID3f500f00-ed80-4566-a057-e31760226f9a

94.3 - 1.0

scpcli virtualserver volume transfer show
--transfer_id <value>

Description

Show volume transfer detail.

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
transfer_id
required
stringVolume Transfer ID1ac231be-823b-4a4d-8ff0-aac503a7118a

Responses

NameDescriptionExample
idVolume Transfer ID1ac231be-823b-4a4d-8ff0-aac503a7118a
created_atCreated at2025-07-22T09:00:00Z
nameVolume namevolume01
volume_idVolume ID3f500f00-ed80-4566-a057-e31760226f9a

95 - Show Volume type’s details

95.1 - 1.2

scpcli virtualserver volume type show
--volume_type_id <value>

Description

Show a Volume type’s details.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
volume_type_id
required
stringVolume type IDc643ac35-3aec-43e6-b97a-3d6f666c5207

Responses

NameDescriptionExample
idVolume type IDc643ac35-3aec-43e6-b97a-3d6f666c5207
descriptionVolume type descriptionVolume type description
extra_specsExtra specs
nameVolume type nameSSD

95.2 - 1.1

scpcli virtualserver volume type show
--volume_type_id <value>

Description

Show a Volume type’s details.

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
volume_type_id
required
stringVolume type IDc643ac35-3aec-43e6-b97a-3d6f666c5207

Responses

NameDescriptionExample
idVolume type IDc643ac35-3aec-43e6-b97a-3d6f666c5207
descriptionVolume type descriptionVolume type description
extra_specsExtra specs
nameVolume type nameSSD

95.3 - 1.0

scpcli virtualserver volume type show
--volume_type_id <value>

Description

Show a Volume type’s details.

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
volume_type_id
required
stringVolume type IDc643ac35-3aec-43e6-b97a-3d6f666c5207

Responses

NameDescriptionExample
idVolume type IDc643ac35-3aec-43e6-b97a-3d6f666c5207
descriptionVolume type descriptionVolume type description
extra_specsExtra specs
nameVolume type nameSSD

96 - Show Volume's details

96.1 - 1.2

scpcli virtualserver volume show
--volume_id <value>

Description

Show a Volume’s details.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a

Responses

NameDescriptionExample
idServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
attached_atThe time when the volume was attached to the server.
deviceDevice name such as, /dev/vda./dev/vda

96.2 - 1.1

scpcli virtualserver volume show
--volume_id <value>

Description

Show a Volume’s details.

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
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a

Responses

NameDescriptionExample
idServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
attached_atThe time when the volume was attached to the server.
deviceDevice name such as, /dev/vda./dev/vda

96.3 - 1.0

scpcli virtualserver volume show
--volume_id <value>

Description

Show a Volume’s details.

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
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a

Responses

NameDescriptionExample
idServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
attached_atThe time when the volume was attached to the server.
deviceDevice name such as, /dev/vda./dev/vda

97 - Start Virtual Server

97.1 - 1.2

scpcli virtualserver server start
--server_id <value>

Description

Start Virtual Server.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample

97.2 - 1.1

scpcli virtualserver server start
--server_id <value>

Description

Start Virtual Server.

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
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample

97.3 - 1.0

scpcli virtualserver server start
--server_id <value>

Description

Start Virtual Server.

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
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample

98 - Stop Virtual Server

98.1 - 1.2

scpcli virtualserver server stop
--server_id <value>

Description

Stop Virtual Server.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample

98.2 - 1.1

scpcli virtualserver server stop
--server_id <value>

Description

Stop Virtual Server.

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
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample

98.3 - 1.0

scpcli virtualserver server stop
--server_id <value>

Description

Stop Virtual Server.

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
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample

99 - Unlock Virtual Server

99.1 - 1.2

scpcli virtualserver server unlock
--server_id <value>

Description

Unlock Virtual Server.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample

99.2 - 1.1

scpcli virtualserver server unlock
--server_id <value>

Description

Unlock Virtual Server.

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
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample

99.3 - 1.0

scpcli virtualserver server unlock
--server_id <value>

Description

Unlock Virtual Server.

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
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample

100 - Update a snapshot

100.1 - 1.2

scpcli virtualserver volume snapshot set
--snapshot_id <value>
--name <value>
[--description <value>]

Description

Update a snapshot.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
snapshot_id
required
stringSnapshot IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790
name
required
stringSnapshot namesnapshot-1
description
optional
stringDescriptiondescription

100.2 - 1.1

scpcli virtualserver volume snapshot set
--snapshot_id <value>
--name <value>
[--description <value>]

Description

Update a snapshot.

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
snapshot_id
required
stringSnapshot IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790
name
required
stringSnapshot namesnapshot-1
description
optional
stringDescriptiondescription

100.3 - 1.0

scpcli virtualserver volume snapshot set
--snapshot_id <value>
--name <value>
[--description <value>]

Description

Update a snapshot.

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
snapshot_id
required
stringSnapshot IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790
name
required
stringSnapshot namesnapshot-1
description
optional
stringDescriptiondescription

101 - Update Auto-Scaling Group

101.1 - 1.2

scpcli virtualserver auto scaling group set
--auto_scaling_group_id <value>
[--desired_server_count_editable <value>]
[--drain_enabled <value>]
[--drain_timeout <value>]
[--launch_configuration_id <value>]
[--security_group_ids <value>]
[--state_check_delay_time <value>]
[--use_lb_state_check <value>]

Description

Update Auto-Scaling Group.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
desired_server_count_editable
optional
booleanDesired server count editableTrue
drain_enabled
optional
booleanDrain enabledTrue
drain_timeout
optional
integerDrain timeout300
launch_configuration_id
optional
stringLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f
security_group_ids
optional
arraySecurity Group ID listc09c3f05-03d9-443f-b27a-40e0f973c75f
state_check_delay_time
optional
integerThe delay time between ASG VM creation and state check operation300
use_lb_state_check
optional
booleanWhether LB state check operates or notTrue

101.2 - 1.1

scpcli virtualserver auto scaling group set
--auto_scaling_group_id <value>
[--desired_server_count_editable <value>]
[--drain_enabled <value>]
[--drain_timeout <value>]
[--launch_configuration_id <value>]
[--security_group_ids <value>]

Description

Update Auto-Scaling Group.

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
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
desired_server_count_editable
optional
booleanDesired server count editableTrue
drain_enabled
optional
booleanDrain enabledTrue
drain_timeout
optional
integerDrain timeout300
launch_configuration_id
optional
stringLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f
security_group_ids
optional
arraySecurity Group ID listc09c3f05-03d9-443f-b27a-40e0f973c75f

101.3 - 1.0

scpcli virtualserver auto scaling group set
--auto_scaling_group_id <value>
[--desired_server_count_editable <value>]
[--drain_enabled <value>]
[--drain_timeout <value>]
[--launch_configuration_id <value>]
[--security_group_ids <value>]

Description

Update Auto-Scaling Group.

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
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
desired_server_count_editable
optional
booleanDesired server count editableTrue
drain_enabled
optional
booleanDrain enabledTrue
drain_timeout
optional
integerDrain timeout300
launch_configuration_id
optional
stringLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f
security_group_ids
optional
arraySecurity Group ID listc09c3f05-03d9-443f-b27a-40e0f973c75f

102 - Update Auto-Scaling Group LB Server Groups

102.1 - 1.2

scpcli virtualserver auto scaling group lb server group set
--auto_scaling_group_id <value>
--lb_server_groups <value>

Description

Update Auto-Scaling Group LB Server Groups.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
lb_server_groups
required
arrayLB Server Group list'{"id": "d06e87d3-ca9a-461b-8e88-077a542a7335", "port": 8080}'

102.2 - 1.1

scpcli virtualserver auto scaling group lb server group set
--auto_scaling_group_id <value>
--lb_server_groups <value>

Description

Update Auto-Scaling Group LB Server 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
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
lb_server_groups
required
arrayLB Server Group list'{"id": "d06e87d3-ca9a-461b-8e88-077a542a7335", "port": 8080}'

102.3 - 1.0

scpcli virtualserver auto scaling group lb server group set
--auto_scaling_group_id <value>
--lb_server_groups <value>

Description

Update Auto-Scaling Group LB Server 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
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
lb_server_groups
required
arrayLB Server Group list'{"id": "d06e87d3-ca9a-461b-8e88-077a542a7335", "port": 8080}'

103 - Update Auto-Scaling Group Notification

103.1 - 1.2

scpcli virtualserver auto scaling group notification update
--notification_id <value>
--auto_scaling_group_id <value>
[--notification_events <value>]
[--notification_state <value>]

Description

Update Auto-Scaling Group notification.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
notification_id
required
stringAuto-Scaling Group notification IDfa7fd191410744cd810a290c0b4d22b9
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
notification_events
optional
arrayAuto-Scaling Group notification event list'{}'
notification_state
optional
stringAuto-Scaling Group notification stateACTIVE

103.2 - 1.1

scpcli virtualserver auto scaling group notification update
--notification_id <value>
--auto_scaling_group_id <value>
[--notification_events <value>]
[--notification_state <value>]

Description

Update Auto-Scaling Group notification.

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
notification_id
required
stringAuto-Scaling Group notification IDfa7fd191410744cd810a290c0b4d22b9
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
notification_events
optional
arrayAuto-Scaling Group notification event list'{}'
notification_state
optional
stringAuto-Scaling Group notification stateACTIVE

103.3 - 1.0

scpcli virtualserver auto scaling group notification update
--notification_id <value>
--auto_scaling_group_id <value>
[--notification_events <value>]
[--notification_state <value>]

Description

Update Auto-Scaling Group notification.

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
notification_id
required
stringAuto-Scaling Group notification IDfa7fd191410744cd810a290c0b4d22b9
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
notification_events
optional
arrayAuto-Scaling Group notification event list'{}'
notification_state
optional
stringAuto-Scaling Group notification stateACTIVE

104 - Update Auto-Scaling Group Policy

104.1 - 1.2

scpcli virtualserver auto scaling group policy set
--policy_id <value>
--auto_scaling_group_id <value>
[--comparison_operator <value>]
[--cooldown_seconds <value>]
[--evaluation_minutes <value>]
[--metric_method <value>]
[--metric_type <value>]
[--scale_method <value>]
[--scale_type <value>]
[--scale_value <value>]
[--state <value>]
[--threshold <value>]

Description

Update Auto-Scaling Group policy.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID0761d76085f54363bab07909baf69841
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
comparison_operator
optional
stringComparison operatorge
cooldown_seconds
optional
integerCooldown seconds300
evaluation_minutes
optional
integerEvaluation minutes5
metric_method
optional
stringMetric methodAVG
metric_type
optional
stringMetric typeCPU
scale_method
optional
stringScale methodAMOUNT
scale_type
optional
stringScale typeSCALE_OUT
scale_value
optional
integerScale value10
state
optional
stringPolicy stateACTIVE
threshold
optional
integerThreshold60

104.2 - 1.1

scpcli virtualserver auto scaling group policy set
--policy_id <value>
--auto_scaling_group_id <value>
[--comparison_operator <value>]
[--cooldown_seconds <value>]
[--evaluation_minutes <value>]
[--metric_method <value>]
[--metric_type <value>]
[--name <value>]
[--scale_method <value>]
[--scale_type <value>]
[--scale_value <value>]
[--state <value>]
[--threshold <value>]

Description

Update Auto-Scaling Group policy.

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
policy_id
required
stringPolicy ID0761d76085f54363bab07909baf69841
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
comparison_operator
optional
stringComparison operatorge
cooldown_seconds
optional
integerCooldown seconds300
evaluation_minutes
optional
integerEvaluation minutes5
metric_method
optional
stringMetric methodAVG
metric_type
optional
stringMetric typeCPU
name
optional
stringPolicy namepolicy-name
scale_method
optional
stringScale methodAMOUNT
scale_type
optional
stringScale typeSCALE_OUT
scale_value
optional
integerScale value10
state
optional
stringPolicy stateACTIVE
threshold
optional
integerThreshold60

104.3 - 1.0

scpcli virtualserver auto scaling group policy set
--policy_id <value>
--auto_scaling_group_id <value>
[--comparison_operator <value>]
[--cooldown_seconds <value>]
[--evaluation_minutes <value>]
[--metric_method <value>]
[--metric_type <value>]
[--name <value>]
[--scale_method <value>]
[--scale_type <value>]
[--scale_value <value>]
[--state <value>]
[--threshold <value>]

Description

Update Auto-Scaling Group policy.

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
policy_id
required
stringPolicy ID0761d76085f54363bab07909baf69841
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
comparison_operator
optional
stringComparison operatorge
cooldown_seconds
optional
integerCooldown seconds300
evaluation_minutes
optional
integerEvaluation minutes5
metric_method
optional
stringMetric methodAVG
metric_type
optional
stringMetric typeCPU
name
optional
stringPolicy namepolicy-name
scale_method
optional
stringScale methodAMOUNT
scale_type
optional
stringScale typeSCALE_OUT
scale_value
optional
integerScale value10
state
optional
stringPolicy stateACTIVE
threshold
optional
integerThreshold60

105 - Update Auto-Scaling Group Schedule

105.1 - 1.2

scpcli virtualserver auto scaling group schedule set
--schedule_id <value>
--auto_scaling_group_id <value>
[--day_of_month <value>]
[--day_of_week <value>]
[--description <value>]
[--desired_server_count <value>]
[--end_date <value>]
[--frequency <value>]
[--hour <value>]
[--max_server_count <value>]
[--min_server_count <value>]
[--minute <value>]
[--name <value>]
[--start_date <value>]
[--state <value>]
[--timezone <value>]

Description

Update Auto-Scaling Group schedule.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
schedule_id
required
stringSchedule ID43d4841abd404220af5f0904037aba71
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
day_of_month
optional
stringDay of the month-1,1
day_of_week
optional
stringDay of the weekSU,SA
description
optional
stringDescriptiondescription
desired_server_count
optional
integerDesired server count1
end_date
optional
stringEnd date2025-01-01
frequency
optional
****FrequencyWEEKLY
hour
optional
integerHour9
max_server_count
optional
integerMax server count2
min_server_count
optional
integerMin server count1
minute
optional
integerMinute0
name
optional
stringSchedule nameschedulename
start_date
optional
stringStart date2024-01-01
state
optional
stringSchedule stateACTIVE
timezone
optional
stringTimezoneAsia/Seoul

105.2 - 1.1

scpcli virtualserver auto scaling group schedule set
--schedule_id <value>
--auto_scaling_group_id <value>
[--day_of_month <value>]
[--day_of_week <value>]
[--description <value>]
[--desired_server_count <value>]
[--end_date <value>]
[--frequency <value>]
[--hour <value>]
[--max_server_count <value>]
[--min_server_count <value>]
[--minute <value>]
[--name <value>]
[--start_date <value>]
[--state <value>]
[--timezone <value>]

Description

Update Auto-Scaling Group schedule.

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
schedule_id
required
stringSchedule ID43d4841abd404220af5f0904037aba71
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
day_of_month
optional
stringDay of the month-1,1
day_of_week
optional
stringDay of the weekSU,SA
description
optional
stringDescriptiondescription
desired_server_count
optional
integerDesired server count1
end_date
optional
stringEnd date2025-01-01
frequency
optional
****FrequencyWEEKLY
hour
optional
integerHour9
max_server_count
optional
integerMax server count2
min_server_count
optional
integerMin server count1
minute
optional
integerMinute0
name
optional
stringSchedule nameschedulename
start_date
optional
stringStart date2024-01-01
state
optional
stringSchedule stateACTIVE
timezone
optional
stringTimezoneAsia/Seoul

105.3 - 1.0

scpcli virtualserver auto scaling group schedule set
--schedule_id <value>
--auto_scaling_group_id <value>
[--day_of_month <value>]
[--day_of_week <value>]
[--description <value>]
[--desired_server_count <value>]
[--end_date <value>]
[--frequency <value>]
[--hour <value>]
[--max_server_count <value>]
[--min_server_count <value>]
[--minute <value>]
[--name <value>]
[--start_date <value>]
[--state <value>]
[--timezone <value>]

Description

Update Auto-Scaling Group schedule.

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
schedule_id
required
stringSchedule ID43d4841abd404220af5f0904037aba71
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
day_of_month
optional
stringDay of the month-1,1
day_of_week
optional
stringDay of the weekSU,SA
description
optional
stringDescriptiondescription
desired_server_count
optional
integerDesired server count1
end_date
optional
stringEnd date2025-01-01
frequency
optional
****FrequencyWEEKLY
hour
optional
integerHour9
max_server_count
optional
integerMax server count2
min_server_count
optional
integerMin server count1
minute
optional
integerMinute0
name
optional
stringSchedule nameschedulename
start_date
optional
stringStart date2024-01-01
state
optional
stringSchedule stateACTIVE
timezone
optional
stringTimezoneAsia/Seoul

106 - Update Auto-Scaling Group server count

106.1 - 1.2

scpcli virtualserver auto scaling group server count set
--auto_scaling_group_id <value>
[--desired_server_count <value>]
[--max_server_count <value>]
[--min_server_count <value>]

Description

Update Auto-Scaling Group server count.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
desired_server_count
optional
integerDesired server count1
max_server_count
optional
integerMax server count2
min_server_count
optional
integerMin server count1

106.2 - 1.1

scpcli virtualserver auto scaling group server count set
--auto_scaling_group_id <value>
[--desired_server_count <value>]
[--max_server_count <value>]
[--min_server_count <value>]

Description

Update Auto-Scaling Group server count.

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
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
desired_server_count
optional
integerDesired server count1
max_server_count
optional
integerMax server count2
min_server_count
optional
integerMin server count1

106.3 - 1.0

scpcli virtualserver auto scaling group server count set
--auto_scaling_group_id <value>
[--desired_server_count <value>]
[--max_server_count <value>]
[--min_server_count <value>]

Description

Update Auto-Scaling Group server count.

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
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
desired_server_count
optional
integerDesired server count1
max_server_count
optional
integerMax server count2
min_server_count
optional
integerMin server count1

107 - Update Image

107.1 - 1.2

scpcli virtualserver image set
--image_id <value>
[--min_disk <value>]
[--min_ram <value>]
[--protected <value>]
[--visibility <value>]

Description

Update Image.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b
min_disk
optional
integerMinimum disk capacity (GB) of the Image to be created100
min_ram
optional
integerMinimum RAM capacity (GB) of the Image to be created0
protected
optional
booleanwhether Image deletion is prohibitedFalse
visibility
optional
stringIndicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accountsprivate

107.2 - 1.1

scpcli virtualserver image set
--image_id <value>
[--min_disk <value>]
[--min_ram <value>]
[--protected <value>]
[--visibility <value>]

Description

Update Image.

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
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b
min_disk
optional
integerMinimum disk capacity (GB) of the Image to be created100
min_ram
optional
integerMinimum RAM capacity (GB) of the Image to be created0
protected
optional
booleanwhether Image deletion is prohibitedFalse
visibility
optional
stringIndicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accountsprivate

107.3 - 1.0

scpcli virtualserver image set
--image_id <value>
[--min_disk <value>]
[--min_ram <value>]
[--protected <value>]
[--visibility <value>]

Description

Update Image.

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
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b
min_disk
optional
integerMinimum disk capacity (GB) of the Image to be created100
min_ram
optional
integerMinimum RAM capacity (GB) of the Image to be created0
protected
optional
booleanwhether Image deletion is prohibitedFalse
visibility
optional
stringIndicates access permissions for the Image. Private: Can be used only within the Account, Shared: Can be shared between Accountsprivate

108 - Update Image member

108.1 - 1.2

scpcli virtualserver image member set
--member_id <value>
--image_id <value>
--status <value>

Description

Update Image member.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
member_id
required
stringShared Image member IDa8f10467abfc4b87b64614ab36eb9ae4
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b
status
required
stringStatus of this Image member. Value of one of pending, accepted, rejected.pending

108.2 - 1.1

scpcli virtualserver image member set
--member_id <value>
--image_id <value>
--status <value>

Description

Update Image member.

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
member_id
required
stringShared Image member IDa8f10467abfc4b87b64614ab36eb9ae4
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b
status
required
stringStatus of this Image member. Value of one of pending, accepted, rejected.pending

108.3 - 1.0

scpcli virtualserver image member set
--member_id <value>
--image_id <value>
--status <value>

Description

Update Image member.

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
member_id
required
stringShared Image member IDa8f10467abfc4b87b64614ab36eb9ae4
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b
status
required
stringStatus of this Image member. Value of one of pending, accepted, rejected.pending

109 - Update Server Interface

109.1 - 1.2

scpcli virtualserver server interface set
--port_id <value>
--server_id <value>
[--fixed_ip_address <value>]
[--subnet_id <value>]

Description

Update Server Interface.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID91424c08-0b26-49fb-9808-ed042292ceef
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
fixed_ip_address
optional
stringIP address192.169.3.2
subnet_id
optional
stringSubnet ID-

109.2 - 1.1

scpcli virtualserver server interface set
--port_id <value>
--server_id <value>
[--fixed_ip_address <value>]
[--subnet_id <value>]

Description

Update Server Interface.

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
port_id
required
stringPort ID91424c08-0b26-49fb-9808-ed042292ceef
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
fixed_ip_address
optional
stringIP address192.169.3.2
subnet_id
optional
stringSubnet ID-

109.3 - 1.0

scpcli virtualserver server interface set
--port_id <value>
--server_id <value>
[--fixed_ip_address <value>]
[--subnet_id <value>]

Description

Update Server Interface.

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
port_id
required
stringPort ID91424c08-0b26-49fb-9808-ed042292ceef
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
fixed_ip_address
optional
stringIP address192.169.3.2
subnet_id
optional
stringSubnet ID-

110 - Update Server Volume

110.1 - 1.2

scpcli virtualserver server volume set
--volume_id <value>
--server_id <value>
--volume_id <value>
[--delete_on_termination <value>]

Description

Update Server Volume.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
delete_on_termination
optional
booleanDelete the boot volume when the server is terminated.False

110.2 - 1.1

scpcli virtualserver server volume set
--volume_id <value>
--server_id <value>
--volume_id <value>
[--delete_on_termination <value>]

Description

Update Server Volume.

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
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
delete_on_termination
optional
booleanDelete the boot volume when the server is terminated.False

110.3 - 1.0

scpcli virtualserver server volume set
--volume_id <value>
--server_id <value>
--volume_id <value>
[--delete_on_termination <value>]

Description

Update Server Volume.

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
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
delete_on_termination
optional
booleanDelete the boot volume when the server is terminated.False

111 - Update Virtual Server

111.1 - 1.2

scpcli virtualserver server set
--server_id <value>
--name <value>

Description

Update Virtual Server.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
name
required
stringServer nameservername

111.2 - 1.1

scpcli virtualserver server set
--server_id <value>
--name <value>

Description

Update Virtual Server.

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
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
name
required
stringServer nameservername

111.3 - 1.0

scpcli virtualserver server set
--server_id <value>
--name <value>

Description

Update Virtual Server.

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
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
name
required
stringServer nameservername

112 - Update Virtual Server type

112.1 - 1.2

scpcli virtualserver server type set
--server_id <value>
--server_type <value>

Description

Update Virtual Server type

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
server_type
required
stringServer types1v1m2

Responses

NameDescriptionExample

112.2 - 1.1

scpcli virtualserver server type set
--server_id <value>
--server_type <value>

Description

Update Virtual Server type

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
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
server_type
required
stringServer types1v1m2

Responses

NameDescriptionExample

112.3 - 1.0

scpcli virtualserver server type set
--server_id <value>
--server_type <value>

Description

Update Virtual Server type

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
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
server_type
required
stringServer types1v1m2

Responses

NameDescriptionExample

113 - Update Volume

113.1 - 1.2

scpcli virtualserver volume set
--volume_id <value>
[--name <value>]

Description

Update a Volume.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
name
optional
stringVolume namevolume01

113.2 - 1.1

scpcli virtualserver volume set
--volume_id <value>
[--name <value>]

Description

Update a Volume.

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
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
name
optional
stringVolume namevolume01

113.3 - 1.0

scpcli virtualserver volume set
--volume_id <value>
[--name <value>]

Description

Update a Volume.

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
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
name
optional
stringVolume namevolume01