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

Return to the regular view of this page.

Compute

1 - Bare Metal Server

Overview

Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of Bare Metal Server service and how to call CLI.

Version

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

VersionStatusNot Before
1.1CURRENT-
1.0DEPRECATED20251231

CLI Version History

1.1

Baremetal CLI v1.1 enhances command-line interface with new networking options and resource monitoring features.

Changes

  • [New] baremetal private-nat-ip create - CreateBaremetalPrivateNatIp command has been added.
  • [New] baremetal private-nat-ip delete - DeleteBaremetalPrivateNatIp command has been added.
  • [Updated] baremetal list - The following fields have been added/removed from the response.
    • Added: private_nat_info, public_nat_info
    • Removed: policy_nat, policy_use_nat, public_nat_status
  • [Updated] baremetal baremetal show - The following fields have been added/removed from the response.
    • Added: private_nat_info, public_nat_info
    • Removed: policy_nat, policy_use_nat, public_nat_status
  • [Updated] baremetal product list - The following fields have been added/removed from the response.
    • Added: os_disk_gb
    • Removed: attri_name, attri_value, compute_class_type_unit, cpu_generation, created_by, disk_name, infiniband_name, infiniband_unit, infiniband_value, modified_by, socket_name, socket_unit, socket_value

1.0

Baremetal CLI v1.0 provides command-line interface for bare metal server management operations.

Changes

  • [New] baremetal baremetal create - CreateBulkBaremetals command has been added.
  • [New] baremetal baremetal list - ListBaremetals command has been added.
  • [New] baremetal baremetal show - ShowBaremetal command has been added.
  • [New] baremetal baremetal delete - DeleteBulkBaremetals command has been added.
  • [New] baremetal baremetal start - StartBulkBaremetals command has been added.
  • [New] baremetal baremetal stop - StopBulkBaremetals command has been added.
  • [New] baremetal baremetal lock - CreateBaremetalLock command has been added.
  • [New] baremetal baremetal unlock - DeleteBaremetalLock command has been added.
  • [New] baremetal nat-ip create - CreateBaremetalNatIp command has been added.
  • [New] baremetal nat-ip delete - DeleteBaremetalNatIp command has been added.
  • [New] baremetal local-subnet create - CreateBaremetalLocalSubnetIp command has been added.
  • [New] baremetal local-subnet delete - DeleteBaremetalLocalSubnetIp command has been added.
  • [New] baremetal image list - ListBaremetalImages command has been added.
  • [New] baremetal product list - ListBaremetalProducts command has been added.

1.1 - CLIs

1.1.1 - Assign Baremetal Private NAT IP

1.1.1.1 - 1.1

scp-cli baremetal private-nat-ip create
--baremetal_id <value>
--private_nat_ip_id <value>
--private_nat_id <value>

Description

Assign Private NAT IP at Bare Metal Server.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
baremetal_id
required
stringBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac
private_nat_ip_id
required
stringPrivate NAT IP ID03cd065d8acc4e47b11a11dc1411323e
private_nat_id
required
stringPrivate NAT IDa4fd0216cd32442a82733bbb8be0e82b

Responses

NameDescriptionExample
nat_idNAT IDa4fd0216cd32442a82733bbb8be0e82b
nat_ipNAT IP192.170.2.10
nat_ip_idNAT IP ID20c507a036c447cdb3b19468d8ea62ac
stateStatic NAT stateACTIVE
static_nat_idStatic NAT IDa1b97ae4695b40b0866e86a19cb191d3

1.1.2 - Assign Baremetal Public NAT IP

1.1.2.1 - 1.1

scp-cli baremetal nat-ip create
--baremetal_id <value>
--public_ip_address_id <value>

Description

Assign Public NAT IP at Bare Metal Server.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
baremetal_id
required
stringBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac
public_ip_address_id
required
stringPublic IP ID20c507a036c447cdb3b19468d8ea62ac

Responses

NameDescriptionExample
baremetal_idBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac

1.1.2.2 - 1.0

scp-cli baremetal nat-ip create
--baremetal_id <value>
--public_ip_address_id <value>

Description

Assign Public NAT IP at Bare Metal 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
baremetal_id
required
stringBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac
public_ip_address_id
required
stringPublic IP ID20c507a036c447cdb3b19468d8ea62ac

Responses

NameDescriptionExample
baremetal_idBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac

1.1.3 - Attach Baremetal Local Subnet

1.1.3.1 - 1.1

scp-cli baremetal local-subnet create
--baremetal_id <value>
--local_subnet_id <value>
[--local_subnet_ip <value>]

Description

Attach Local Subnet for Bare Metal Server.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
baremetal_id
required
stringBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac
local_subnet_id
required
stringLocal Subnet IDab313c43291e4b678f4bacffe10768ae
local_subnet_ip
optional
stringPolicy Local Subnet IP192.168.0.1

1.1.3.2 - 1.0

scp-cli baremetal local-subnet create
--baremetal_id <value>
--local_subnet_id <value>
[--local_subnet_ip <value>]

Description

Attach Local Subnet for Bare Metal 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
baremetal_id
required
stringBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac
local_subnet_id
required
stringLocal Subnet IDab313c43291e4b678f4bacffe10768ae
local_subnet_ip
optional
stringPolicy Local Subnet IP192.168.0.1

1.1.4 - Create Baremetals

1.1.4.1 - 1.1

scp-cli baremetal baremetal create
--vpc_id <value>
--subnet_id <value>
--server_details <value>
--region_id <value>
--os_user_password <value>
--os_user_id <value>
--image_id <value>
[--init_script <value>]
[--lock_enabled <value>]
[--placement_group_name <value>]
[--tags <value>]
[--use_placement_group <value>]

Description

Create Bare Metal Servers.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC IDe58348b1bc9148e5af86500fd4ef99ca
subnet_id
required
stringSubnet IDab313c43291e4b678f4bacffe10768ae
server_details
required
arrayDetailed settings for each server'{"bare_metal_local_subnet_id": "ab313c43291e4b678f4bacffe10768ae", "bare_metal_local_subnet_ip_address": "192.168.0.1", "bare_metal_server_name": "bmserver-001", "ip_address": "192.168.0.1", "local_disk_partitions": [{"mount_point": "/mountpoint", "partition_name": "partitionname", "partition_size": 20, "partition_type": "ext4"}], "local_disk_type": "flat", "nat_enabled": true, "public_ip_address_id": "20c507a036c447cdb3b19468d8ea62ac", "server_type_id": "PRODUCT-0iT9dNiLr4lVoYmjlY2Vgg", "use_hyper_threading": true}'
region_id
required
stringRegion IDkr-west1
os_user_password
required
stringOS user passwordpassword
os_user_id
required
stringOS user IDuser001
image_id
required
stringImage IDIMAGE-7XFMaJpLsapKvskFMjCtmm
init_script
optional
stringInit scriptinit script
lock_enabled
optional
booleanUse LockTrue
placement_group_name
optional
stringPlacement Group Namepgtest
tags
optional
arrayTag'{"key": "key", "value": "value"}'
use_placement_group
optional
booleanUse Placement GroupFalse

Responses

NameDescriptionExample
account_idAccount IDf5c8e56a4d9b49a8bd89e14758a32d53
request_idRequest IDreq-002daa83-52d9-41e8-9b0f-d31d35610f65
resource_idResource ID20c507a036c447cdb3b19468d8ea62ac

1.1.4.2 - 1.0

scp-cli baremetal baremetal create
--vpc_id <value>
--subnet_id <value>
--server_details <value>
--region_id <value>
--os_user_password <value>
--os_user_id <value>
--image_id <value>
[--init_script <value>]
[--lock_enabled <value>]
[--placement_group_name <value>]
[--tags <value>]
[--use_placement_group <value>]

Description

Create Bare Metal 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
vpc_id
required
stringVPC IDe58348b1bc9148e5af86500fd4ef99ca
subnet_id
required
stringSubnet IDab313c43291e4b678f4bacffe10768ae
server_details
required
arrayDetailed settings for each server'{"bare_metal_local_subnet_id": "ab313c43291e4b678f4bacffe10768ae", "bare_metal_local_subnet_ip_address": "192.168.0.1", "bare_metal_server_name": "bmserver-001", "ip_address": "192.168.0.1", "local_disk_partitions": [{"mount_point": "/mountpoint", "partition_name": "partitionname", "partition_size": 20, "partition_type": "ext4"}], "local_disk_type": "flat", "nat_enabled": true, "public_ip_address_id": "20c507a036c447cdb3b19468d8ea62ac", "server_type_id": "PRODUCT-0iT9dNiLr4lVoYmjlY2Vgg", "use_hyper_threading": true}'
region_id
required
stringRegion IDkr-west1
os_user_password
required
stringOS user passwordpassword
os_user_id
required
stringOS user IDuser001
image_id
required
stringImage IDIMAGE-7XFMaJpLsapKvskFMjCtmm
init_script
optional
stringInit scriptinit script
lock_enabled
optional
booleanUse LockTrue
placement_group_name
optional
stringPlacement Group Namepgtest
tags
optional
arrayTag'{"key": "key", "value": "value"}'
use_placement_group
optional
booleanUse Placement GroupFalse

Responses

NameDescriptionExample
account_idAccount IDf5c8e56a4d9b49a8bd89e14758a32d53
request_idRequest IDreq-002daa83-52d9-41e8-9b0f-d31d35610f65
resource_idResource ID20c507a036c447cdb3b19468d8ea62ac

1.1.5 - Delete Baremetal Private NAT IP

1.1.5.1 - 1.1

scp-cli baremetal private-nat-ip delete
--baremetal_id <value>

Description

Delete Private NAT IP Bare Metal Server.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
baremetal_id
required
stringBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac

1.1.6 - Delete Baremetal Public NAT IP

1.1.6.1 - 1.1

scp-cli baremetal nat-ip delete
--baremetal_id <value>

Description

Delete Public NAT IP Bare Metal Server.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
baremetal_id
required
stringBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac

1.1.6.2 - 1.0

scp-cli baremetal nat-ip delete
--baremetal_id <value>

Description

Delete Public NAT IP Bare Metal 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
baremetal_id
required
stringBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac

1.1.7 - Delete Baremetals

1.1.7.1 - 1.1

scp-cli baremetal baremetal delete
--baremetal_id_list <value>

Description

Delete Bare Metal Servers.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
baremetal_id_list
required
arrayBare Metal Server IDs20c507a036c447cdb3b19468d8ea62ac

1.1.7.2 - 1.0

scp-cli baremetal baremetal delete
--baremetal_id_list <value>

Description

Delete Bare Metal 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
baremetal_id_list
required
arrayBare Metal Server IDs20c507a036c447cdb3b19468d8ea62ac

1.1.8 - Detach Baremetal Local Subnet

1.1.8.1 - 1.1

scp-cli baremetal local-subnet delete
--baremetal_id <value>
--local_subnet_ip <value>
--local_subnet_id <value>

Description

Detach Local Subnet for Bare Metal Server.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
baremetal_id
required
stringBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac
local_subnet_ip
required
stringPolicy Local Subnet IP192.168.0.1
local_subnet_id
required
stringLocal Subnet IDab313c43291e4b678f4bacffe10768ae

1.1.8.2 - 1.0

scp-cli baremetal local-subnet delete
--baremetal_id <value>
--local_subnet_ip <value>
--local_subnet_id <value>

Description

Detach Local Subnet for Bare Metal 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
baremetal_id
required
stringBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac
local_subnet_ip
required
stringPolicy Local Subnet IP192.168.0.1
local_subnet_id
required
stringLocal Subnet IDab313c43291e4b678f4bacffe10768ae

1.1.9 - List Baremetal Images

1.1.9.1 - 1.1

scp-cli baremetal image list
--region_id <value>

Description

List Bare Metal Server Images.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
region_id
required
stringRegion IDkr-west1

Responses

NameDescriptionExample
idImage IDIMAGE-7XFMaJpLsapKvskFMjCtmm
created_atCreated at2024-07-11 08:56:59
nameImage nameRHEL 8.8 for BM
os_distroOS typeRHEL
scp_image_typeImage TypeSTANDARD
scp_os_versionOS version8.7

1.1.9.2 - 1.0

scp-cli baremetal image list
--region_id <value>

Description

List Bare Metal Server 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
region_id
required
stringRegion IDkr-west1

Responses

NameDescriptionExample
idImage IDIMAGE-7XFMaJpLsapKvskFMjCtmm
created_atCreated at2024-07-11 08:56:59
nameImage nameRHEL 8.8 for BM
os_distroOS typeRHEL
scp_image_typeImage TypeSTANDARD
scp_os_versionOS version8.7

1.1.10 - List Baremetal Products

1.1.10.1 - 1.1

scp-cli baremetal product list
[--image_id <value>]

Description

List Bare Metal Server products.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
image_id
optional
stringImage IDIMAGE-7XFMaJpLsapKvskFMjCtmm

Responses

NameDescriptionExample
idIDPRODUCT-0iT9dNiLr4lVoYmjlY2Vgg
compute_class_type_nameCompute class type nameStandardMetal-2
compute_class_type_valueCompute class type values2_metal
cpu_nameCPU namecpu 16 vCore
cpu_unitCPU unitvCPU
cpu_valueCPU value64
created_atCreated At2024-05-17T00:23:17Z
descriptionDescriptionvCPU 16 │ Memory 128G │ Disk 480G
disk_unitDisk unitGB
disk_valueDisk value480
memory_nameMemory nameserver memory 128GB
memory_unitMemory unitGB
memory_valueMemory value128
modified_atModified At2024-05-17T00:23:17Z
nameNames2v16m128_metal
name_with_generationName with generations2v16m128_metal
os_disk_gbOS disk value480
stateStateAVAILABLE
typeTypeSCALE

1.1.10.2 - 1.0

scp-cli baremetal product list
[--image_id <value>]

Description

List Bare Metal Server products.

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
optional
stringImage IDIMAGE-7XFMaJpLsapKvskFMjCtmm

Responses

NameDescriptionExample
idIDPRODUCT-0iT9dNiLr4lVoYmjlY2Vgg
attri_nameAttribute nameattri name
attri_valueAttribute valueattri value
compute_class_type_nameCompute class type nameStandardMetal-2
compute_class_type_unitCompute class type unitcompute_class_type_unit
compute_class_type_valueCompute class type values2_metal
cpu_generationCPU generationcpu generation
cpu_nameCPU namecpu 16 vCore
cpu_unitCPU unitvCPU
cpu_valueCPU value64
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionvCPU 16 │ Memory 128G │ Disk 480G
disk_nameDisk namedisk_name
disk_unitDisk unitGB
disk_valueDisk value480
infiniband_nameInfiniBand nameinfiniband_name
infiniband_unitInfiniBand unitinfiniband_unit
infiniband_valueInfiniband valueinfiniband_value
memory_nameMemory nameserver memory 128GB
memory_unitMemory unitGB
memory_valueMemory value128
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameNames2v16m128_metal
name_with_generationName with generations2v16m128_metal
socket_nameSocket namesocket_name
socket_unitSocket unitsocket_unit
socket_valueSocket valuesocket_value
stateStateAVAILABLE
typeTypeSCALE

1.1.11 - List Baremetals

1.1.11.1 - 1.1

scp-cli baremetal baremetal list
[--size <value>]
[--page <value>]
[--sort <value>]
[--server_name <value>]
[--state <value>]
[--ip <value>]
[--vpc_id <value>]

Description

Get Bare Metal Servers list.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
server_name
optional
stringBare Metal Server namebmserver-001
state
optional
stringBare Metal Server stateRUNNING
ip
optional
stringBare Metal Server IP address192.168.0.1
vpc_id
optional
stringVPC IDe58348b1bc9148e5af86500fd4ef99ca

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
image_idImage IDIMAGE-7XFMaJpLsapKvskFMjCtmm
image_versionImage versionRHEL 8.7 for BM
lock_enabledUse LockTrue
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
network_idSubnet IDab313c43291e4b678f4bacffe10768ae
os_typeOS typeWINDOWS
placement_group_namePlacement Group Namepgtest
policy_ipPolicy IP192.168.0.1
product_type_idBare Metal Server scale IDPRODUCT-0iT9dNiLr4lVoYmjlY2Vgg
region_idRegion IDkr-west1
server_nameBare Metal Server namebmserver-001
server_typeBare Metal Server scale types1v8m32_metal
stateBare Metal Server stateRUNNING
vpc_idVPC IDe58348b1bc9148e5af86500fd4ef99ca

1.1.11.2 - 1.0

scp-cli baremetal baremetal list
[--size <value>]
[--page <value>]
[--sort <value>]
[--server_name <value>]
[--state <value>]
[--ip <value>]
[--vpc_id <value>]

Description

Get Bare Metal Servers 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
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
server_name
optional
stringBare Metal Server namebmserver-001
state
optional
stringBare Metal Server stateRUNNING
ip
optional
stringBare Metal Server IP address192.168.0.1
vpc_id
optional
stringVPC IDe58348b1bc9148e5af86500fd4ef99ca

Responses

NameDescriptionExample
idBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac
account_idAccount IDf5c8e56a4d9b49a8bd89e14758a32d53
created_atCreated At2024-05-17T00:23:17Z
created_byCreated byef716e80-1fac-4faa-892d-0132fc7f5583
hyper_threading_useUse Hyper ThreadingTrue
image_idImage IDIMAGE-7XFMaJpLsapKvskFMjCtmm
image_versionImage versionRHEL 8.7 for BM
init_scriptInit scriptinit script
local_subnet_infoLocal Subnet info
lock_enabledUse LockTrue
modified_atModified At2024-05-17T00:23:17Z
modified_byModified byef716e80-1fac-4faa-892d-0132fc7f5583
network_idSubnet IDab313c43291e4b678f4bacffe10768ae
os_typeOS typeWINDOWS
placement_group_namePlacement Group Namepgtest
policy_ipPolicy IP192.168.0.1
policy_natPublic NAT IP192.168.0.1
policy_use_natUse Public NATTrue
product_type_idBare Metal Server scale IDPRODUCT-0iT9dNiLr4lVoYmjlY2Vgg
public_nat_statusPublic NAT statusACTIVE
region_idRegion IDkr-west1
root_accountRoot Accountrootaccount
server_nameBare Metal Server namebmserver-001
server_typeBare Metal Server scale types1v8m32_metal
stateBare Metal Server stateRUNNING
time_zoneTime ZoneAsia/Seoul
use_local_subnetUse Local SubnetTrue
vpc_idVPC IDe58348b1bc9148e5af86500fd4ef99ca

1.1.12 - Lock Baremetal

1.1.12.1 - 1.1

scp-cli baremetal baremetal lock
--baremetal_id <value>

Description

Lock Bare Metal Server.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
baremetal_id
required
stringBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac

1.1.12.2 - 1.0

scp-cli baremetal baremetal lock
--baremetal_id <value>

Description

Lock Bare Metal 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
baremetal_id
required
stringBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac

1.1.13 - Show Baremetal

1.1.13.1 - 1.1

scp-cli baremetal baremetal show
--baremetal_id <value>

Description

Show Bare Metal Server.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
baremetal_id
required
stringBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac

Responses

NameDescriptionExample
idBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac
account_idAccount IDf5c8e56a4d9b49a8bd89e14758a32d53
created_atCreated At2024-05-17T00:23:17Z
created_byCreated byef716e80-1fac-4faa-892d-0132fc7f5583
hyper_threading_useUse Hyper ThreadingTrue
image_idImage IDIMAGE-7XFMaJpLsapKvskFMjCtmm
image_versionImage versionRHEL 8.7 for BM
init_scriptInit scriptinit script
local_subnet_infoLocal Subnet info[]
lock_enabledUse LockTrue
modified_atModified At2024-05-17T00:23:17Z
modified_byModified byef716e80-1fac-4faa-892d-0132fc7f5583
network_idSubnet IDab313c43291e4b678f4bacffe10768ae
os_typeOS typeWINDOWS
placement_group_namePlacement Group Namepgtest
policy_ipPolicy IP192.168.0.1
private_nat_infoPrivate NAT info{}
product_type_idBare Metal Server scale IDPRODUCT-0iT9dNiLr4lVoYmjlY2Vgg
public_nat_infoPublic NAT info{}
region_idRegion IDkr-west1
root_accountRoot Accountrootaccount
server_nameBare Metal Server namebmserver-001
server_typeBare Metal Server scale types1v8m32_metal
stateBare Metal Server stateRUNNING
time_zoneTime ZoneAsia/Seoul
use_local_subnetUse Local SubnetTrue
vpc_idVPC IDe58348b1bc9148e5af86500fd4ef99ca

1.1.13.2 - 1.0

scp-cli baremetal baremetal show
--baremetal_id <value>

Description

Show Bare Metal 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
baremetal_id
required
stringBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac

Responses

NameDescriptionExample
idBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac
account_idAccount IDf5c8e56a4d9b49a8bd89e14758a32d53
created_atCreated At2024-05-17T00:23:17Z
created_byCreated byef716e80-1fac-4faa-892d-0132fc7f5583
hyper_threading_useUse Hyper ThreadingTrue
image_idImage IDIMAGE-7XFMaJpLsapKvskFMjCtmm
image_versionImage versionRHEL 8.7 for BM
init_scriptInit scriptinit script
local_subnet_infoLocal Subnet info[]
lock_enabledUse LockTrue
modified_atModified At2024-05-17T00:23:17Z
modified_byModified byef716e80-1fac-4faa-892d-0132fc7f5583
network_idSubnet IDab313c43291e4b678f4bacffe10768ae
os_typeOS typeWINDOWS
placement_group_namePlacement Group Namepgtest
policy_ipPolicy IP192.168.0.1
policy_natPublic NAT IP192.168.0.1
policy_use_natUse Public NATTrue
product_type_idBare Metal Server scale IDPRODUCT-0iT9dNiLr4lVoYmjlY2Vgg
public_nat_statusPublic NAT statusACTIVE
region_idRegion IDkr-west1
root_accountRoot Accountrootaccount
server_nameBare Metal Server namebmserver-001
server_typeBare Metal Server scale types1v8m32_metal
stateBare Metal Server stateRUNNING
time_zoneTime ZoneAsia/Seoul
use_local_subnetUse Local SubnetTrue
vpc_idVPC IDe58348b1bc9148e5af86500fd4ef99ca

1.1.14 - Start Baremetals

1.1.14.1 - 1.1

scp-cli baremetal baremetal start
--bare_metal_server_ids <value>

Description

Start Bare Metal Servers.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
bare_metal_server_ids
required
arrayBare Metal Server IDs20c507a036c447cdb3b19468d8ea62ac

Responses

NameDescriptionExample
account_idAccount IDf5c8e56a4d9b49a8bd89e14758a32d53
request_idRequest IDreq-002daa83-52d9-41e8-9b0f-d31d35610f65
resource_idResource ID20c507a036c447cdb3b19468d8ea62ac

1.1.14.2 - 1.0

scp-cli baremetal baremetal start
--bare_metal_server_ids <value>

Description

Start Bare Metal 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
bare_metal_server_ids
required
arrayBare Metal Server IDs20c507a036c447cdb3b19468d8ea62ac

Responses

NameDescriptionExample
account_idAccount IDf5c8e56a4d9b49a8bd89e14758a32d53
request_idRequest IDreq-002daa83-52d9-41e8-9b0f-d31d35610f65
resource_idResource ID20c507a036c447cdb3b19468d8ea62ac

1.1.15 - Stop Baremetals

1.1.15.1 - 1.1

scp-cli baremetal baremetal stop
--bare_metal_server_ids <value>

Description

Stop Bare Metal Servers.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
bare_metal_server_ids
required
arrayBare Metal Server IDs20c507a036c447cdb3b19468d8ea62ac

Responses

NameDescriptionExample
account_idAccount IDf5c8e56a4d9b49a8bd89e14758a32d53
request_idRequest IDreq-002daa83-52d9-41e8-9b0f-d31d35610f65
resource_idResource ID20c507a036c447cdb3b19468d8ea62ac

1.1.15.2 - 1.0

scp-cli baremetal baremetal stop
--bare_metal_server_ids <value>

Description

Stop Bare Metal 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
bare_metal_server_ids
required
arrayBare Metal Server IDs20c507a036c447cdb3b19468d8ea62ac

Responses

NameDescriptionExample
account_idAccount IDf5c8e56a4d9b49a8bd89e14758a32d53
request_idRequest IDreq-002daa83-52d9-41e8-9b0f-d31d35610f65
resource_idResource ID20c507a036c447cdb3b19468d8ea62ac

1.1.16 - Unlock Baremetal

1.1.16.1 - 1.1

scp-cli baremetal baremetal unlock
--baremetal_id <value>

Description

Unlock Bare Metal Server.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
baremetal_id
required
stringBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac

1.1.16.2 - 1.0

scp-cli baremetal baremetal unlock
--baremetal_id <value>

Description

Unlock Bare Metal 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
baremetal_id
required
stringBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac

2 - Cloud Functions

Overview

Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of Cloud Function service and how to call CLI.

Version

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

VersionStatusNot Before
1.4CURRENT-
1.3SUPPORTED20260830
1.2DEPRECATED20260630
1.1DEPRECATED20260430
1.0DEPRECATED20251231

CLI Version History

1.4

Cloud Functions has been updated to version 1.4.

Changes

  • [Changed] scf cloud-function list - Cloud Functions list retrieval API has been changed.
  • Response model has been changed to CloudFunctionForListV1Dot4.
  • The following fields are added to the response:
    • eots_date
    • eots_state
  • [Changed] scf cloud-function show - Cloud Functions detail retrieval API has been changed.
  • Response model has been changed to CloudFunctionShowResponseV1Dot4.
  • The following fields are added to the response:
    • cloud_function.eots_date
    • cloud_function.eots_state
  • [Changed] scf cloud-function runtime list - Runtime list retrieval API has been changed.
  • Response model has been changed to RuntimeListResponseV1Dot4.
  • The following fields are added to the response:
    • runtimes.eots_date
    • runtimes.eots_state
  • [Changed] scf cloud-function sample-codes show - Blueprint list retrieval API has been changed.
  • Response model has been changed to SampleCodesListResponseV1Dot4.
  • The following fields are added to the response:
    • sample_codes.eots_date
    • sample_codes.eots_state

1.3

Cloud Functions has been updated to version 1.3.

Changes

  • [New] scf cloud-function config show - General config retrieval API has been added.
  • [Changed] cloud-function config set - General config update API has been changed.
  • Required action has been changed as follows:
    • scf:SetGeneralConfig
  • [New] scf cloud-function environment variables list - Environment variables list retrieval API has been added.
  • [Changed] scf cloud-function variables set - Environment variables update API has been changed.
  • Required action has been changed as follows:
    • scf:SetEnvConfig
  • [New] scf cloud-function url show - URL config retrieval API has been added.
  • [Changed] scf cloud-function url set - URL config update API has been changed.
  • Required action has been changed as follows:
    • scf:SetUrlConfig
  • Response model has been changed to FunctionUrlV1Dot3.
  • The following fields are added to the response:
    • state
  • [New] scf privatelink-service show - PrivateLink Service retrieval API has been added.
  • [Changed] scf privatelink-service set - PrivateLink Service update API has been changed.
  • Response model has been changed to PrivateLinkServiceV1Dot3.
  • The following fields are added to the response:
    • privatelink_service_state
    • privatelink_service_auth_type
  • [New] scf privatelink-endpoint list - PrivateLink Endpoint list retrieval API has been added.
  • [New] scf resource policy show - Resource Policy retrieval API has been added.
  • [New] scf resource policy set - Resource Policy setting API has been added.
  • [New] scf resource policy delete - Resource Policy deletion API has been added.

1.2

Cloud Functions has been updated to version 1.2.

Changes

  • [Changed] scf cloud-function configuration show - Show Cloud Function Configuration API has been changed.
  • Response model has been changed to ConfigurationV1Dot2.
  • The following fields are added to the response:
    • privatelink_service
    • privatelink_endpoints
  • [New] scf privatelink-service set - PrivateLink Service update API has been added.
  • [New] scf privatelink-endpoint create - PrivateLink Endpoint creation API has been added.
  • [New] scf privatelink-endpoint approve - PrivateLink Endpoint approval/rejection API has been added.
  • [New] scf privatelink-endpoint connect - PrivateLink Endpoint reconnection/disconnection API has been added.
  • [New] scf privatelink-endpoint request - PrivateLink Endpoint connection re-request/cancellation API has been added.
  • [New] scf privatelink-endpoint delete - PrivateLink Endpoint deletion API has been added.

1.1

Cloud Functions has been updated to version 1.1.

Changes

  • [New] scf cloud-function code-file set - Cloud function code file upload API has been added.

1.0

Cloud Functions version 1.0 has been released.

Changes

  • [New] scf cloud-function list - List Cloud Functions API has been added.
  • [New] scf cloud-function create - Create Cloud Function API has been added.
  • [New] scf cloud-function duplication show - Check Function Name Duplication API has been added.
  • [New] scf cloud-function runtime list - List Runtimes API has been added.
  • [New] scf cloud-function sample-codes show - List Sample Codes API has been added.
  • [New] scf cloud-function delete - Delete Cloud Function API has been added.
  • [New] scf cloud-function show - Show Cloud Function API has been added.
  • [New] scf cloud-function code show - Show Cloud Function Code API has been added.
  • [New] scf cloud-function code set - Update Cloud Function Code API has been added.
  • [New] scf cloud-function configuration show - Show Cloud Function Configuration API has been added.
  • [New] scf cloud-function config set - Update Cloud Function Config API has been added.
  • [New] scf cloud-function variables set - Update Cloud Function Variables API has been added.
  • [New] scf cloud-function url set - Update Cloud Function Url API has been added.
  • [New] scf cloud-function logs show - Show Cloud Function Logs API has been added.
  • [New] scf cloud-function metrics show - Show Cloud Function Metrics API has been added.
  • [New] scf cloud-function trigger list - List Cloud Function Triggers API has been added.
  • [New] scf cloud-function apigateway trigger create - Create Cloud Function Apigateway Trigger API has been added.
  • [New] scf cloud-function cronjob trigger create - Create Cloud Function Cronjob Trigger API has been added.
  • [New] scf cloud-function cronjob trigger set - Update Cloud Function Cronjob Trigger API has been added.
  • [New] scf cloud-function trigger delete - Delete Cloud Function Trigger API has been added.
  • [New] scf cloud-function trigger show - Show Cloud Function Trigger API has been added.

2.1 - CLIs

2.1.1 - Approve PrivateLink Endpoint

2.1.1.1 - 1.4

scp-cli scf privatelink-endpoint approve
--endpoint_id <value>
--cloud_function_id <value>
--type <value>

Description

approve PrivateLink Endpoint

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
endpoint_id
required
stringEndpoint Id8c9f6c1c928a45b4bbd1e4da5531d656
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
type
required
stringTypeAPPROVE

2.1.1.2 - 1.3

scp-cli scf privatelink-endpoint approve
--endpoint_id <value>
--cloud_function_id <value>
--type <value>

Description

approve PrivateLink Endpoint

State ACTIVE (SUPPORTED)

VersionNot Before
1.320260830

Parameters

NameTypeDescriptionExample
endpoint_id
required
stringEndpoint Id8c9f6c1c928a45b4bbd1e4da5531d656
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
type
required
stringTypeAPPROVE

2.1.1.3 - 1.2

scp-cli scf privatelink-endpoint approve
--endpoint_id <value>
--cloud_function_id <value>
--type <value>

Description

approve PrivateLink Endpoint

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

Parameters

NameTypeDescriptionExample
endpoint_id
required
stringEndpoint Id8c9f6c1c928a45b4bbd1e4da5531d656
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
type
required
stringTypeAPPROVE

2.1.2 - Check Function Name Duplication

2.1.2.1 - 1.4

scp-cli scf cloud-function duplication show
--name <value>

Description

check name duplication

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
name
required
stringNamesample-function-name

Responses

NameDescriptionExample
resultResultTrue

2.1.2.2 - 1.3

scp-cli scf cloud-function duplication show
--name <value>

Description

check name duplication

State ACTIVE (SUPPORTED)

VersionNot Before
1.320260830

Parameters

NameTypeDescriptionExample
name
required
stringNamesample-function-name

Responses

NameDescriptionExample
resultResultTrue

2.1.2.3 - 1.2

scp-cli scf cloud-function duplication show
--name <value>

Description

check name duplication

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

Parameters

NameTypeDescriptionExample
name
required
stringNamesample-function-name

Responses

NameDescriptionExample
resultResultTrue

2.1.2.4 - 1.1

scp-cli scf cloud-function duplication show
--name <value>

Description

check name duplication

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

Parameters

NameTypeDescriptionExample
name
required
stringNamesample-function-name

Responses

NameDescriptionExample
resultResultTrue

2.1.2.5 - 1.0

scp-cli scf cloud-function duplication show
--name <value>

Description

check name duplication

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
stringNamesample-function-name

Responses

NameDescriptionExample
resultResultTrue

2.1.3 - Connect PrivateLink Endpoint

2.1.3.1 - 1.4

scp-cli scf privatelink-endpoint connect
--endpoint_id <value>
--cloud_function_id <value>
--type <value>

Description

connect PrivateLink Endpoint

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
endpoint_id
required
stringEndpoint Id8c9f6c1c928a45b4bbd1e4da5531d656
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
type
required
stringTypeRECONNECT

2.1.3.2 - 1.3

scp-cli scf privatelink-endpoint connect
--endpoint_id <value>
--cloud_function_id <value>
--type <value>

Description

connect PrivateLink Endpoint

State ACTIVE (SUPPORTED)

VersionNot Before
1.320260830

Parameters

NameTypeDescriptionExample
endpoint_id
required
stringEndpoint Id8c9f6c1c928a45b4bbd1e4da5531d656
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
type
required
stringTypeRECONNECT

2.1.3.3 - 1.2

scp-cli scf privatelink-endpoint connect
--endpoint_id <value>
--cloud_function_id <value>
--type <value>

Description

connect PrivateLink Endpoint

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

Parameters

NameTypeDescriptionExample
endpoint_id
required
stringEndpoint Id8c9f6c1c928a45b4bbd1e4da5531d656
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
type
required
stringTypeRECONNECT

2.1.4 - Create Cloud Function

2.1.4.1 - 1.4

scp-cli scf cloud-function create
--runtime <value>
--name <value>
--content <value>
[--tags <value>]

Description

create a cloud_function

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
runtime
required
stringRuntimeNode.js:20
name
required
stringNamesample-function-name
content
required
stringCode contentsample
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
messageDescriptionDescription
stateCloud function stateREADY

2.1.4.2 - 1.3

scp-cli scf cloud-function create
--runtime <value>
--name <value>
--content <value>
[--tags <value>]

Description

create a cloud_function

State ACTIVE (SUPPORTED)

VersionNot Before
1.320260830

Parameters

NameTypeDescriptionExample
runtime
required
stringRuntimeNode.js:20
name
required
stringNamesample-function-name
content
required
stringCode contentsample
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
messageDescriptionDescription
stateCloud function stateREADY

2.1.4.3 - 1.2

scp-cli scf cloud-function create
--runtime <value>
--name <value>
--content <value>
[--tags <value>]

Description

create a cloud_function

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

Parameters

NameTypeDescriptionExample
runtime
required
stringRuntimeNode.js:20
name
required
stringNamesample-function-name
content
required
stringCode contentsample
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
messageDescriptionDescription
stateCloud function stateREADY

2.1.4.4 - 1.1

scp-cli scf cloud-function create
--runtime <value>
--name <value>
--content <value>
[--tags <value>]

Description

create a cloud_function

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

Parameters

NameTypeDescriptionExample
runtime
required
stringRuntimeNode.js:20
name
required
stringNamesample-function-name
content
required
stringCode contentsample
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
messageDescriptionDescription
stateCloud function stateREADY

2.1.4.5 - 1.0

scp-cli scf cloud-function create
--runtime <value>
--name <value>
--content <value>
[--tags <value>]

Description

create a cloud_function

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
runtime
required
stringRuntimeNode.js:20
name
required
stringNamesample-function-name
content
required
stringCode contentsample
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
messageDescriptionDescription
stateCloud function stateREADY

2.1.5 - Create Cloud Function Apigateway Trigger

2.1.5.1 - 1.4

scp-cli scf cloud-function apigateway trigger create
--cloud_function_id <value>
--apigateway_stage_name <value>
--apigateway_api_id <value>

Description

create cloud-function apigateway trigger

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
apigateway_stage_name
required
stringApigateway Stage Namesample
apigateway_api_id
required
stringApigateway API ID31e749b7b260868f441e862b

Responses

NameDescriptionExample
aliasAlias$LATEST
cloud_function_idCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
triggersTriggers[]

2.1.5.2 - 1.3

scp-cli scf cloud-function apigateway trigger create
--cloud_function_id <value>
--apigateway_stage_name <value>
--apigateway_api_id <value>

Description

create cloud-function apigateway trigger

State ACTIVE (SUPPORTED)

VersionNot Before
1.320260830

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
apigateway_stage_name
required
stringApigateway Stage Namesample
apigateway_api_id
required
stringApigateway API ID31e749b7b260868f441e862b

Responses

NameDescriptionExample
aliasAlias$LATEST
cloud_function_idCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
triggersTriggers[]

2.1.5.3 - 1.2

scp-cli scf cloud-function apigateway trigger create
--cloud_function_id <value>
--apigateway_stage_name <value>
--apigateway_api_id <value>

Description

create cloud-function apigateway trigger

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

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
apigateway_stage_name
required
stringApigateway Stage Namesample
apigateway_api_id
required
stringApigateway API ID31e749b7b260868f441e862b

Responses

NameDescriptionExample
aliasAlias$LATEST
cloud_function_idCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
triggersTriggers[]

2.1.5.4 - 1.1

scp-cli scf cloud-function apigateway trigger create
--cloud_function_id <value>
--apigateway_stage_name <value>
--apigateway_api_id <value>

Description

create cloud-function apigateway trigger

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

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
apigateway_stage_name
required
stringApigateway Stage Namesample
apigateway_api_id
required
stringApigateway API ID31e749b7b260868f441e862b

Responses

NameDescriptionExample
aliasAlias$LATEST
cloud_function_idCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
triggersTriggers[]

2.1.5.5 - 1.0

scp-cli scf cloud-function apigateway trigger create
--cloud_function_id <value>
--apigateway_stage_name <value>
--apigateway_api_id <value>

Description

create cloud-function apigateway trigger

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
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
apigateway_stage_name
required
stringApigateway Stage Namesample
apigateway_api_id
required
stringApigateway API ID31e749b7b260868f441e862b

Responses

NameDescriptionExample
aliasAlias$LATEST
cloud_function_idCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
triggersTriggers[]

2.1.6 - Create Cloud Function Cronjob Trigger

2.1.6.1 - 1.4

scp-cli scf cloud-function cronjob trigger create
--timezone <value>
--schedule <value>
--cloud_function_id <value>

Description

create cloud-function cronjob trigger

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
timezone
required
stringTimezoneAsia/Tokyo
schedule
required
stringSchedule* * * * 0
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
aliasAlias$LATEST
cloud_function_idCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
triggersTriggers[]

2.1.6.2 - 1.3

scp-cli scf cloud-function cronjob trigger create
--timezone <value>
--schedule <value>
--cloud_function_id <value>

Description

create cloud-function cronjob trigger

State ACTIVE (SUPPORTED)

VersionNot Before
1.320260830

Parameters

NameTypeDescriptionExample
timezone
required
stringTimezoneAsia/Tokyo
schedule
required
stringSchedule* * * * 0
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
aliasAlias$LATEST
cloud_function_idCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
triggersTriggers[]

2.1.6.3 - 1.2

scp-cli scf cloud-function cronjob trigger create
--timezone <value>
--schedule <value>
--cloud_function_id <value>

Description

create cloud-function cronjob trigger

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

Parameters

NameTypeDescriptionExample
timezone
required
stringTimezoneAsia/Tokyo
schedule
required
stringSchedule* * * * 0
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
aliasAlias$LATEST
cloud_function_idCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
triggersTriggers[]

2.1.6.4 - 1.1

scp-cli scf cloud-function cronjob trigger create
--timezone <value>
--schedule <value>
--cloud_function_id <value>

Description

create cloud-function cronjob trigger

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

Parameters

NameTypeDescriptionExample
timezone
required
stringTimezoneAsia/Tokyo
schedule
required
stringSchedule* * * * 0
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
aliasAlias$LATEST
cloud_function_idCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
triggersTriggers[]

2.1.6.5 - 1.0

scp-cli scf cloud-function cronjob trigger create
--timezone <value>
--schedule <value>
--cloud_function_id <value>

Description

create cloud-function cronjob trigger

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
timezone
required
stringTimezoneAsia/Tokyo
schedule
required
stringSchedule* * * * 0
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
aliasAlias$LATEST
cloud_function_idCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
triggersTriggers[]

2.1.7 - Create PrivateLink Endpoint

2.1.7.1 - 1.4

scp-cli scf privatelink-endpoint create
--cloud_function_id <value>
--service_id <value>
--alias <value>

Description

create privateLink endpoint

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
service_id
required
stringService Id8c9f6c1c928a45b4bbd1e4da5531d656
alias
required
stringAliassample

Responses

NameDescriptionExample
endpointEndpoint

2.1.7.2 - 1.3

scp-cli scf privatelink-endpoint create
--cloud_function_id <value>
--service_id <value>
--alias <value>

Description

create privateLink endpoint

State ACTIVE (SUPPORTED)

VersionNot Before
1.320260830

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
service_id
required
stringService Id8c9f6c1c928a45b4bbd1e4da5531d656
alias
required
stringAliassample

Responses

NameDescriptionExample
endpointEndpoint

2.1.7.3 - 1.2

scp-cli scf privatelink-endpoint create
--cloud_function_id <value>
--service_id <value>
--alias <value>

Description

create privateLink endpoint

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

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
service_id
required
stringService Id8c9f6c1c928a45b4bbd1e4da5531d656
alias
required
stringAliassample

Responses

NameDescriptionExample
endpointEndpoint

2.1.8 - Delete Cloud Function

2.1.8.1 - 1.4

scp-cli scf cloud-function delete
--cloud_function_id <value>

Description

delete a specific cloud_function

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

2.1.8.2 - 1.3

scp-cli scf cloud-function delete
--cloud_function_id <value>

Description

delete a specific cloud_function

State ACTIVE (SUPPORTED)

VersionNot Before
1.320260830

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

2.1.8.3 - 1.2

scp-cli scf cloud-function delete
--cloud_function_id <value>

Description

delete a specific cloud_function

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

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

2.1.8.4 - 1.1

scp-cli scf cloud-function delete
--cloud_function_id <value>

Description

delete a specific cloud_function

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

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

2.1.8.5 - 1.0

scp-cli scf cloud-function delete
--cloud_function_id <value>

Description

delete a specific cloud_function

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
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

2.1.9 - Delete Cloud Function Trigger

2.1.9.1 - 1.4

scp-cli scf cloud-function trigger delete
--trigger_id <value>
--trigger_type <value>
--cloud_function_id <value>

Description

delete a specific cloud function trigger

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
trigger_id
required
integerTrigger ID1
trigger_type
required
stringTrigger typeapigateway
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

2.1.9.2 - 1.3

scp-cli scf cloud-function trigger delete
--trigger_id <value>
--trigger_type <value>
--cloud_function_id <value>

Description

delete a specific cloud function trigger

State ACTIVE (SUPPORTED)

VersionNot Before
1.320260830

Parameters

NameTypeDescriptionExample
trigger_id
required
integerTrigger ID1
trigger_type
required
stringTrigger typeapigateway
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

2.1.9.3 - 1.2

scp-cli scf cloud-function trigger delete
--trigger_id <value>
--trigger_type <value>
--cloud_function_id <value>

Description

delete a specific cloud function trigger

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

Parameters

NameTypeDescriptionExample
trigger_id
required
integerTrigger ID1
trigger_type
required
stringTrigger typeapigateway
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

2.1.9.4 - 1.1

scp-cli scf cloud-function trigger delete
--trigger_id <value>
--trigger_type <value>
--cloud_function_id <value>

Description

delete a specific cloud function trigger

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

Parameters

NameTypeDescriptionExample
trigger_id
required
integerTrigger ID1
trigger_type
required
stringTrigger typeapigateway
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

2.1.9.5 - 1.0

scp-cli scf cloud-function trigger delete
--trigger_id <value>
--trigger_type <value>
--cloud_function_id <value>

Description

delete a specific cloud function trigger

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
trigger_id
required
integerTrigger ID1
trigger_type
required
stringTrigger typeapigateway
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

2.1.10 - Delete PrivateLink Endpoint

2.1.10.1 - 1.4

scp-cli scf privatelink-endpoint delete
--endpoint_id <value>
--cloud_function_id <value>

Description

delete privateLink endpoint

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
endpoint_id
required
stringEndpoint Id8c9f6c1c928a45b4bbd1e4da5531d656
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

2.1.10.2 - 1.3

scp-cli scf privatelink-endpoint delete
--endpoint_id <value>
--cloud_function_id <value>

Description

delete privateLink endpoint

State ACTIVE (SUPPORTED)

VersionNot Before
1.320260830

Parameters

NameTypeDescriptionExample
endpoint_id
required
stringEndpoint Id8c9f6c1c928a45b4bbd1e4da5531d656
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

2.1.10.3 - 1.2

scp-cli scf privatelink-endpoint delete
--endpoint_id <value>
--cloud_function_id <value>

Description

delete privateLink endpoint

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

Parameters

NameTypeDescriptionExample
endpoint_id
required
stringEndpoint Id8c9f6c1c928a45b4bbd1e4da5531d656
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

2.1.11 - Delete Resource Policy

2.1.11.1 - 1.4

scp-cli scf resource policy delete
--cloud_function_id <value>

Description

Delete resource policy

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

2.1.11.2 - 1.3

scp-cli scf resource policy delete
--cloud_function_id <value>

Description

Delete resource policy

State ACTIVE (SUPPORTED)

VersionNot Before
1.320260830

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

2.1.12 - List Cloud Function Triggers

2.1.12.1 - 1.4

scp-cli scf cloud-function trigger list
--cloud_function_id <value>
[--sort <value>]
[--page <value>]
[--size <value>]
[--trigger_name <value>]
[--trigger_type <value>]

Description

list cloud-function triggers

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
trigger_name
optional
stringTrigger name8c9f6c1c928a45b4bbd1e4da5531d656
trigger_type
optional
stringTrigger typeapigateway

Responses

NameDescriptionExample
scheduleSchedule* * * * 0
timezoneTimezoneAsia/Tokyo
trigger_idTrigger ID1
trigger_nameTrigger name8c9f6c1c928a45b4bbd1e4da5531d656
trigger_target_account_idTrigger target account ID617b3d0e90c24a5fa1f65a3824861354
trigger_target_srnTrigger target SRNsrn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuidTrigger target UUID8c9f6c1c928a45b4bbd1e4da5531d656
trigger_typeTrigger typeapigateway

2.1.12.2 - 1.3

scp-cli scf cloud-function trigger list
--cloud_function_id <value>
[--sort <value>]
[--page <value>]
[--size <value>]
[--trigger_name <value>]
[--trigger_type <value>]

Description

list cloud-function triggers

State ACTIVE (SUPPORTED)

VersionNot Before
1.320260830

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
trigger_name
optional
stringTrigger name8c9f6c1c928a45b4bbd1e4da5531d656
trigger_type
optional
stringTrigger typeapigateway

Responses

NameDescriptionExample
scheduleSchedule* * * * 0
timezoneTimezoneAsia/Tokyo
trigger_idTrigger ID1
trigger_nameTrigger name8c9f6c1c928a45b4bbd1e4da5531d656
trigger_target_account_idTrigger target account ID617b3d0e90c24a5fa1f65a3824861354
trigger_target_srnTrigger target SRNsrn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuidTrigger target UUID8c9f6c1c928a45b4bbd1e4da5531d656
trigger_typeTrigger typeapigateway

2.1.12.3 - 1.2

scp-cli scf cloud-function trigger list
--cloud_function_id <value>
[--sort <value>]
[--page <value>]
[--size <value>]
[--trigger_name <value>]
[--trigger_type <value>]

Description

list cloud-function triggers

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

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
trigger_name
optional
stringTrigger name8c9f6c1c928a45b4bbd1e4da5531d656
trigger_type
optional
stringTrigger typeapigateway

Responses

NameDescriptionExample
scheduleSchedule* * * * 0
timezoneTimezoneAsia/Tokyo
trigger_idTrigger ID1
trigger_nameTrigger name8c9f6c1c928a45b4bbd1e4da5531d656
trigger_target_account_idTrigger target account ID617b3d0e90c24a5fa1f65a3824861354
trigger_target_srnTrigger target SRNsrn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuidTrigger target UUID8c9f6c1c928a45b4bbd1e4da5531d656
trigger_typeTrigger typeapigateway

2.1.12.4 - 1.1

scp-cli scf cloud-function trigger list
--cloud_function_id <value>
[--sort <value>]
[--page <value>]
[--size <value>]
[--trigger_name <value>]
[--trigger_type <value>]

Description

list cloud-function triggers

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

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
trigger_name
optional
stringTrigger name8c9f6c1c928a45b4bbd1e4da5531d656
trigger_type
optional
stringTrigger typeapigateway

Responses

NameDescriptionExample
scheduleSchedule* * * * 0
timezoneTimezoneAsia/Tokyo
trigger_idTrigger ID1
trigger_nameTrigger name8c9f6c1c928a45b4bbd1e4da5531d656
trigger_target_account_idTrigger target account ID617b3d0e90c24a5fa1f65a3824861354
trigger_target_srnTrigger target SRNsrn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuidTrigger target UUID8c9f6c1c928a45b4bbd1e4da5531d656
trigger_typeTrigger typeapigateway

2.1.12.5 - 1.0

scp-cli scf cloud-function trigger list
--cloud_function_id <value>
[--sort <value>]
[--page <value>]
[--size <value>]
[--trigger_name <value>]
[--trigger_type <value>]

Description

list cloud-function triggers

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
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
trigger_name
optional
stringTrigger name8c9f6c1c928a45b4bbd1e4da5531d656
trigger_type
optional
stringTrigger typeapigateway

Responses

NameDescriptionExample
scheduleSchedule* * * * 0
timezoneTimezoneAsia/Tokyo
trigger_idTrigger ID1
trigger_nameTrigger name8c9f6c1c928a45b4bbd1e4da5531d656
trigger_target_account_idTrigger target account ID617b3d0e90c24a5fa1f65a3824861354
trigger_target_srnTrigger target SRNsrn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuidTrigger target UUID8c9f6c1c928a45b4bbd1e4da5531d656
trigger_typeTrigger typeapigateway

2.1.13 - List Cloud Functions

2.1.13.1 - 1.4

scp-cli scf cloud-function list
[--sort <value>]
[--page <value>]
[--size <value>]
[--name <value>]
[--state <value>]
[--runtime <value>]

Description

get cloud_functions list

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
name
optional
stringNamesample-function-name
state
optional
arrayCloud function stateR
runtime
optional
arrayRuntimeN

Responses

NameDescriptionExample
idCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
created_atCreated At2025-05-22T06:21:17.580522
eots_dateEoTS Date2026-05-31T14:59:59.999999Z
eots_stateEoTS StateAPPLIED
function_urlCloud function Urlhttps://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello
nameCloud Functions namesample
runtimeRuntimeNode.js:20
stateCloud function stateREADY
user_idUser ID617b3d0e90c24a5fa1f65a3824861354

2.1.13.2 - 1.3

scp-cli scf cloud-function list
[--sort <value>]
[--page <value>]
[--size <value>]
[--name <value>]
[--state <value>]
[--runtime <value>]

Description

get cloud_functions list

State ACTIVE (SUPPORTED)

VersionNot Before
1.320260830

Parameters

NameTypeDescriptionExample
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
name
optional
stringNamesample-function-name
state
optional
arrayCloud function stateR
runtime
optional
arrayRuntimeN

Responses

NameDescriptionExample
idCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
created_atCreated At2025-05-22T06:21:17.580522
function_urlCloud function Urlhttps://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello
nameCloud Functions namesample
runtimeRuntimeNode.js:20
stateCloud function stateREADY
user_idUser ID617b3d0e90c24a5fa1f65a3824861354

2.1.13.3 - 1.2

scp-cli scf cloud-function list
[--sort <value>]
[--page <value>]
[--size <value>]
[--name <value>]
[--state <value>]
[--runtime <value>]

Description

get cloud_functions 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.220260630

Parameters

NameTypeDescriptionExample
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
name
optional
stringNamesample-function-name
state
optional
arrayCloud function stateR
runtime
optional
arrayRuntimeN

Responses

NameDescriptionExample
idCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
created_atCreated At2025-05-22T06:21:17.580522
function_urlCloud function Urlhttps://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello
nameCloud Functions namesample
runtimeRuntimeNode.js:20
stateCloud function stateREADY
user_idUser ID617b3d0e90c24a5fa1f65a3824861354

2.1.13.4 - 1.1

scp-cli scf cloud-function list
[--sort <value>]
[--page <value>]
[--size <value>]
[--name <value>]
[--state <value>]
[--runtime <value>]

Description

get cloud_functions 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.120260430

Parameters

NameTypeDescriptionExample
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
name
optional
stringNamesample-function-name
state
optional
arrayCloud function stateR
runtime
optional
arrayRuntimeN

Responses

NameDescriptionExample
idCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
created_atCreated At2025-05-22T06:21:17.580522
function_urlCloud function Urlhttps://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello
nameCloud Functions namesample
runtimeRuntimeNode.js:20
stateCloud function stateREADY
user_idUser ID617b3d0e90c24a5fa1f65a3824861354

2.1.13.5 - 1.0

scp-cli scf cloud-function list
[--sort <value>]
[--page <value>]
[--size <value>]
[--name <value>]
[--state <value>]
[--runtime <value>]

Description

get cloud_functions 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
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
name
optional
stringNamesample-function-name
state
optional
arrayCloud function stateR
runtime
optional
arrayRuntimeN

Responses

NameDescriptionExample
idCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
created_atCreated At2025-05-22T06:21:17.580522
function_urlCloud function Urlhttps://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello
nameCloud Functions namesample
runtimeRuntimeNode.js:20
stateCloud function stateREADY
user_idUser ID617b3d0e90c24a5fa1f65a3824861354

2.1.14 - List Environment Variables

2.1.14.1 - 1.4

scp-cli scf cloud-function environment variables list
--cloud_function_id <value>
[--sort <value>]

Description

list environment variables

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
sort
optional
stringSortkey:asc

Responses

NameDescriptionExample
keyKeysample
valueValuesample

2.1.14.2 - 1.3

scp-cli scf cloud-function environment variables list
--cloud_function_id <value>
[--sort <value>]

Description

list environment variables

State ACTIVE (SUPPORTED)

VersionNot Before
1.320260830

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
sort
optional
stringSortkey:asc

Responses

NameDescriptionExample
keyKeysample
valueValuesample

2.1.15 - List PrivateLink Endpoint

2.1.15.1 - 1.4

scp-cli scf privatelink-endpoint list
--cloud_function_id <value>
[--sort <value>]

Description

list privateLink endpoint

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
sort
optional
stringSortendpoint_alias:asc

Responses

NameDescriptionExample
endpoint_aliasAliassample
endpoint_idEndpoint Id8c9f6c1c928a45b4bbd1e4da5531d656
service_idService Id8c9f6c1c928a45b4bbd1e4da5531d656
stateStateActive

2.1.15.2 - 1.3

scp-cli scf privatelink-endpoint list
--cloud_function_id <value>
[--sort <value>]

Description

list privateLink endpoint

State ACTIVE (SUPPORTED)

VersionNot Before
1.320260830

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
sort
optional
stringSortendpoint_alias:asc

Responses

NameDescriptionExample
endpoint_aliasAliassample
endpoint_idEndpoint Id8c9f6c1c928a45b4bbd1e4da5531d656
service_idService Id8c9f6c1c928a45b4bbd1e4da5531d656
stateStateActive

2.1.16 - List Runtimes

2.1.16.1 - 1.4

scp-cli scf cloud-function runtime list

Description

list runtimes

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Responses

NameDescriptionExample
base_image_seqBase image sequence3
eots_dateEoTS Date2026-05-31T14:59:59.999999Z
eots_stateEoTS StateAPPLIED
nameNamesample
versionVersion1.0.0

2.1.16.2 - 1.3

scp-cli scf cloud-function runtime list

Description

list runtimes

State ACTIVE (SUPPORTED)

VersionNot Before
1.320260830

Responses

NameDescriptionExample
base_image_seqBase image sequence3
nameNamesample
versionVersion1.0.0

2.1.16.3 - 1.2

scp-cli scf cloud-function runtime list

Description

list runtimes

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

Responses

NameDescriptionExample
base_image_seqBase image sequence3
nameNamesample
versionVersion1.0.0

2.1.16.4 - 1.1

scp-cli scf cloud-function runtime list

Description

list runtimes

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

Responses

NameDescriptionExample
base_image_seqBase image sequence3
nameNamesample
versionVersion1.0.0

2.1.16.5 - 1.0

scp-cli scf cloud-function runtime list

Description

list runtimes

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
base_image_seqBase image sequence3
nameNamesample
versionVersion1.0.0

2.1.17 - List Sample Codes

2.1.17.1 - 1.4

scp-cli scf cloud-function sample-codes show

Description

List sample codes

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Responses

NameDescriptionExample
contentCode contentsample
defaultDefaultFalse
descriptionDescriptionsample
eots_dateEoTS Date2026-05-31T14:59:59.999999Z
eots_stateEoTS StateAPPLIED
nameNamesample
runtimeRuntimeNode.js:20
seqSequence3
versionVersionsample

2.1.17.2 - 1.3

scp-cli scf cloud-function sample-codes show

Description

List sample codes

State ACTIVE (SUPPORTED)

VersionNot Before
1.320260830

Responses

NameDescriptionExample
contentCode contentsample
defaultDefaultFalse
descriptionDescriptionsample
nameNamesample
runtimeRuntimeNode.js:20
seqSequence3
versionVersionsample

2.1.17.3 - 1.2

scp-cli scf cloud-function sample-codes show

Description

List sample codes

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

Responses

NameDescriptionExample
contentCode contentsample
defaultDefaultFalse
descriptionDescriptionsample
nameNamesample
runtimeRuntimeNode.js:20
seqSequence3
versionVersionsample

2.1.17.4 - 1.1

scp-cli scf cloud-function sample-codes show

Description

List sample codes

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

Responses

NameDescriptionExample
contentCode contentsample
defaultDefaultFalse
descriptionDescriptionsample
nameNamesample
runtimeRuntimeNode.js:20
seqSequence3
versionVersionsample

2.1.17.5 - 1.0

scp-cli scf cloud-function sample-codes show

Description

List sample codes

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
contentCode contentsample
defaultDefaultFalse
descriptionDescriptionsample
nameNamesample
runtimeRuntimeNode.js:20
seqSequence3
versionVersionsample

2.1.18 - Request PrivateLink Endpoint

2.1.18.1 - 1.4

scp-cli scf privatelink-endpoint request
--endpoint_id <value>
--cloud_function_id <value>
--type <value>

Description

request privatelink endpoint

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
endpoint_id
required
stringEndpoint Id8c9f6c1c928a45b4bbd1e4da5531d656
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
type
required
stringTypeCANCEL

2.1.18.2 - 1.3

scp-cli scf privatelink-endpoint request
--endpoint_id <value>
--cloud_function_id <value>
--type <value>

Description

request privatelink endpoint

State ACTIVE (SUPPORTED)

VersionNot Before
1.320260830

Parameters

NameTypeDescriptionExample
endpoint_id
required
stringEndpoint Id8c9f6c1c928a45b4bbd1e4da5531d656
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
type
required
stringTypeCANCEL

2.1.18.3 - 1.2

scp-cli scf privatelink-endpoint request
--endpoint_id <value>
--cloud_function_id <value>
--type <value>

Description

request privatelink endpoint

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

Parameters

NameTypeDescriptionExample
endpoint_id
required
stringEndpoint Id8c9f6c1c928a45b4bbd1e4da5531d656
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
type
required
stringTypeCANCEL

2.1.19 - Set Resource Policy

2.1.19.1 - 1.4

scp-cli scf resource policy set
--cloud_function_id <value>
--version <value>
--statement <value>

Description

Set resource policy

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
version
required
stringVersion2024-07-01
statement
required
arrayStatement'{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}'

2.1.19.2 - 1.3

scp-cli scf resource policy set
--cloud_function_id <value>
--version <value>
--statement <value>

Description

Set resource policy

State ACTIVE (SUPPORTED)

VersionNot Before
1.320260830

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
version
required
stringVersion2024-07-01
statement
required
arrayStatement'{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}'

2.1.20 - Show Cloud Function

2.1.20.1 - 1.4

scp-cli scf cloud-function show
--cloud_function_id <value>

Description

show a specific cloud_function

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
idCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
eots_dateEoTS Date2026-05-31T14:59:59.999999Z
eots_stateEoTS StateAPPLIED
function_urlCloud function Urlhttps://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello
nameCloud Functions namesample
runtimeRuntimeNode.js:20
stateCloud function stateREADY
user_idUser ID617b3d0e90c24a5fa1f65a3824861354

2.1.20.2 - 1.3

scp-cli scf cloud-function show
--cloud_function_id <value>

Description

show a specific cloud_function

State ACTIVE (SUPPORTED)

VersionNot Before
1.320260830

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
idCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
function_urlCloud function Urlhttps://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello
nameCloud Functions namesample
runtimeRuntimeNode.js:20
stateCloud function stateREADY
user_idUser ID617b3d0e90c24a5fa1f65a3824861354

2.1.20.3 - 1.2

scp-cli scf cloud-function show
--cloud_function_id <value>

Description

show a specific cloud_function

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

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
idCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
function_urlCloud function Urlhttps://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello
nameCloud Functions namesample
runtimeRuntimeNode.js:20
stateCloud function stateREADY
user_idUser ID617b3d0e90c24a5fa1f65a3824861354

2.1.20.4 - 1.1

scp-cli scf cloud-function show
--cloud_function_id <value>

Description

show a specific cloud_function

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

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
idCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
function_urlCloud function Urlhttps://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello
nameCloud Functions namesample
runtimeRuntimeNode.js:20
stateCloud function stateREADY
user_idUser ID617b3d0e90c24a5fa1f65a3824861354

2.1.20.5 - 1.0

scp-cli scf cloud-function show
--cloud_function_id <value>

Description

show a specific cloud_function

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
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
idCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
function_urlCloud function Urlhttps://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello
nameCloud Functions namesample
runtimeRuntimeNode.js:20
stateCloud function stateREADY
user_idUser ID617b3d0e90c24a5fa1f65a3824861354

2.1.21 - Show Cloud Function Code

2.1.21.1 - 1.4

scp-cli scf cloud-function code show
--cloud_function_id <value>

Description

show a specific cloud_function code

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
class_nameClass Namecom.example.Handler
code_textCode TextZXhwb3J0cy5oYW5kbGVSZXF1ZXN0ID0gYXN5bmM==
code_typeCode Typetext
file_nameFile Namesample
file_transfer_statusFile Transfer Statussample
file_upload_atFile Upload At2025-05-17 00:23:17
method_nameMethod NamehandleRequest
runtimeRuntimeNode.js:20

2.1.21.2 - 1.3

scp-cli scf cloud-function code show
--cloud_function_id <value>

Description

show a specific cloud_function code

State ACTIVE (SUPPORTED)

VersionNot Before
1.320260830

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
class_nameClass Namecom.example.Handler
code_textCode TextZXhwb3J0cy5oYW5kbGVSZXF1ZXN0ID0gYXN5bmM==
code_typeCode Typetext
file_nameFile Namesample
file_transfer_statusFile Transfer Statussample
file_upload_atFile Upload At2025-05-17 00:23:17
method_nameMethod NamehandleRequest
runtimeRuntimeNode.js:20

2.1.21.3 - 1.2

scp-cli scf cloud-function code show
--cloud_function_id <value>

Description

show a specific cloud_function code

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

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
class_nameClass Namecom.example.Handler
code_textCode TextZXhwb3J0cy5oYW5kbGVSZXF1ZXN0ID0gYXN5bmM==
code_typeCode Typetext
file_nameFile Namesample
file_transfer_statusFile Transfer Statussample
file_upload_atFile Upload At2025-05-17 00:23:17
method_nameMethod NamehandleRequest
runtimeRuntimeNode.js:20

2.1.21.4 - 1.1

scp-cli scf cloud-function code show
--cloud_function_id <value>

Description

show a specific cloud_function code

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

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
class_nameClass Namecom.example.Handler
code_textCode TextZXhwb3J0cy5oYW5kbGVSZXF1ZXN0ID0gYXN5bmM==
code_typeCode Typetext
file_nameFile Namesample
file_transfer_statusFile Transfer Statussample
file_upload_atFile Upload At2025-05-17 00:23:17
method_nameMethod NamehandleRequest
runtimeRuntimeNode.js:20

2.1.21.5 - 1.0

scp-cli scf cloud-function code show
--cloud_function_id <value>

Description

show a specific cloud_function code

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
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
class_nameClass Namecom.example.Handler
code_textCode TextZXhwb3J0cy5oYW5kbGVSZXF1ZXN0ID0gYXN5bmM==
code_typeCode Typetext
file_nameFile Namesample
file_transfer_statusFile Transfer Statussample
file_upload_atFile Upload At2025-05-17 00:23:17
method_nameMethod NamehandleRequest
runtimeRuntimeNode.js:20

2.1.22 - Show Cloud Function Configuration

2.1.22.1 - 1.4

scp-cli scf cloud-function configuration show
--cloud_function_id <value>

Description

show a specific cloud-function configuration

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
configConfiguration
privatelink_endpointsEndpoints[]
privatelink_servicePrivateLink Service{}
urlFunction URL
variablesEnvironment Variables[]

2.1.22.2 - 1.3

scp-cli scf cloud-function configuration show
--cloud_function_id <value>

Description

show a specific cloud-function configuration

State ACTIVE (SUPPORTED)

VersionNot Before
1.320260830

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
configConfiguration
privatelink_endpointsEndpoints[]
privatelink_servicePrivateLink Service{}
urlFunction URL
variablesEnvironment Variables[]

2.1.22.3 - 1.2

scp-cli scf cloud-function configuration show
--cloud_function_id <value>

Description

show a specific cloud-function 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.220260630

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
configConfiguration
privatelink_endpointsEndpoints[]
privatelink_servicePrivateLink Service{}
urlFunction URL
variablesEnvironment Variables[]

2.1.22.4 - 1.1

scp-cli scf cloud-function configuration show
--cloud_function_id <value>

Description

show a specific cloud-function 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.120260430

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
configConfiguration
urlFunction URL
variablesEnvironment Variables[]

2.1.22.5 - 1.0

scp-cli scf cloud-function configuration show
--cloud_function_id <value>

Description

show a specific cloud-function 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
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
configConfiguration
urlFunction URL
variablesEnvironment Variables[]

2.1.23 - Show Cloud Function Logs

2.1.23.1 - 1.4

scp-cli scf cloud-function logs show
--cloud_function_id <value>
[--time <value>]
[--start <value>]
[--end <value>]

Description

show a specific cloud-function logs

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
time
optional
integerTime3
start
optional
stringStart20250517
end
optional
stringEnd20250517

Responses

NameDescriptionExample
countCount3
logsLog[]

2.1.23.2 - 1.3

scp-cli scf cloud-function logs show
--cloud_function_id <value>
[--time <value>]
[--start <value>]
[--end <value>]

Description

show a specific cloud-function logs

State ACTIVE (SUPPORTED)

VersionNot Before
1.320260830

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
time
optional
integerTime3
start
optional
stringStart20250517
end
optional
stringEnd20250517

Responses

NameDescriptionExample
countCount3
logsLog[]

2.1.23.3 - 1.2

scp-cli scf cloud-function logs show
--cloud_function_id <value>
[--time <value>]
[--start <value>]
[--end <value>]

Description

show a specific cloud-function logs

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

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
time
optional
integerTime3
start
optional
stringStart20250517
end
optional
stringEnd20250517

Responses

NameDescriptionExample
countCount3
logsLog[]

2.1.23.4 - 1.1

scp-cli scf cloud-function logs show
--cloud_function_id <value>
[--time <value>]
[--start <value>]
[--end <value>]

Description

show a specific cloud-function logs

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

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
time
optional
integerTime3
start
optional
stringStart20250517
end
optional
stringEnd20250517

Responses

NameDescriptionExample
countCount3
logsLog[]

2.1.23.5 - 1.0

scp-cli scf cloud-function logs show
--cloud_function_id <value>
[--time <value>]
[--start <value>]
[--end <value>]

Description

show a specific cloud-function logs

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
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
time
optional
integerTime3
start
optional
stringStart20250517
end
optional
stringEnd20250517

Responses

NameDescriptionExample
countCount3
logsLog[]

2.1.24 - Show Cloud Function Metrics

2.1.24.1 - 1.3

scp-cli scf cloud-function metrics show
--cloud_function_id <value>
[--time <value>]
[--start <value>]
[--end <value>]

Description

show a specific cloud-function metrics

State ACTIVE (SUPPORTED)

VersionNot Before
1.320260830

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
time
optional
integerTime3
start
optional
stringStart20250517
end
optional
stringEnd20250517

Responses

NameDescriptionExample
actual_podsActual pods[]
fail_countFail count[]
function_memoryFunction memory[]
request_countRequest count[]
request_latencyRequest latency[]
success_countSuccess count[]

2.1.24.2 - 1.2

scp-cli scf cloud-function metrics show
--cloud_function_id <value>
[--time <value>]
[--start <value>]
[--end <value>]

Description

show a specific cloud-function metrics

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

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
time
optional
integerTime3
start
optional
stringStart20250517
end
optional
stringEnd20250517

Responses

NameDescriptionExample
actual_podsActual pods[]
fail_countFail count[]
function_memoryFunction memory[]
request_countRequest count[]
request_latencyRequest latency[]
success_countSuccess count[]

2.1.24.3 - 1.1

scp-cli scf cloud-function metrics show
--cloud_function_id <value>
[--time <value>]
[--start <value>]
[--end <value>]

Description

show a specific cloud-function metrics

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

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
time
optional
integerTime3
start
optional
stringStart20250517
end
optional
stringEnd20250517

Responses

NameDescriptionExample
actual_podsActual pods[]
fail_countFail count[]
function_memoryFunction memory[]
request_countRequest count[]
request_latencyRequest latency[]
success_countSuccess count[]

2.1.24.4 - 1.0

scp-cli scf cloud-function metrics show
--cloud_function_id <value>
[--time <value>]
[--start <value>]
[--end <value>]

Description

show a specific cloud-function metrics

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
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
time
optional
integerTime3
start
optional
stringStart20250517
end
optional
stringEnd20250517

Responses

NameDescriptionExample
actual_podsActual pods[]
fail_countFail count[]
function_memoryFunction memory[]
request_countRequest count[]
request_latencyRequest latency[]
success_countSuccess count[]

2.1.25 - Show Cloud Function Trigger

2.1.25.1 - 1.4

scp-cli scf cloud-function trigger show
--trigger_id <value>

Description

show a specific cloud-function trigger

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
trigger_id
required
integerTrigger ID1

Responses

NameDescriptionExample
aliasAlias$LATEST
scheduleSchedule* * * * 0
timezoneTimezoneAsia/Tokyo
trigger_idTrigger ID1
trigger_nameTrigger name8c9f6c1c928a45b4bbd1e4da5531d656
trigger_sidTrigger target account ID617b3d0e90c24a5fa1f65a3824861354
trigger_target_account_idTrigger target account ID617b3d0e90c24a5fa1f65a3824861354
trigger_target_srnTrigger target SRNsrn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuidTrigger target UUID8c9f6c1c928a45b4bbd1e4da5531d656
trigger_typeTrigger typeapigateway

2.1.25.2 - 1.3

scp-cli scf cloud-function trigger show
--trigger_id <value>

Description

show a specific cloud-function trigger

State ACTIVE (SUPPORTED)

VersionNot Before
1.320260830

Parameters

NameTypeDescriptionExample
trigger_id
required
integerTrigger ID1

Responses

NameDescriptionExample
aliasAlias$LATEST
scheduleSchedule* * * * 0
timezoneTimezoneAsia/Tokyo
trigger_idTrigger ID1
trigger_nameTrigger name8c9f6c1c928a45b4bbd1e4da5531d656
trigger_sidTrigger target account ID617b3d0e90c24a5fa1f65a3824861354
trigger_target_account_idTrigger target account ID617b3d0e90c24a5fa1f65a3824861354
trigger_target_srnTrigger target SRNsrn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuidTrigger target UUID8c9f6c1c928a45b4bbd1e4da5531d656
trigger_typeTrigger typeapigateway

2.1.25.3 - 1.2

scp-cli scf cloud-function trigger show
--trigger_id <value>

Description

show a specific cloud-function trigger

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

Parameters

NameTypeDescriptionExample
trigger_id
required
integerTrigger ID1

Responses

NameDescriptionExample
aliasAlias$LATEST
scheduleSchedule* * * * 0
timezoneTimezoneAsia/Tokyo
trigger_idTrigger ID1
trigger_nameTrigger name8c9f6c1c928a45b4bbd1e4da5531d656
trigger_sidTrigger target account ID617b3d0e90c24a5fa1f65a3824861354
trigger_target_account_idTrigger target account ID617b3d0e90c24a5fa1f65a3824861354
trigger_target_srnTrigger target SRNsrn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuidTrigger target UUID8c9f6c1c928a45b4bbd1e4da5531d656
trigger_typeTrigger typeapigateway

2.1.25.4 - 1.1

scp-cli scf cloud-function trigger show
--trigger_id <value>

Description

show a specific cloud-function trigger

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

Parameters

NameTypeDescriptionExample
trigger_id
required
integerTrigger ID1

Responses

NameDescriptionExample
aliasAlias$LATEST
scheduleSchedule* * * * 0
timezoneTimezoneAsia/Tokyo
trigger_idTrigger ID1
trigger_nameTrigger name8c9f6c1c928a45b4bbd1e4da5531d656
trigger_sidTrigger target account ID617b3d0e90c24a5fa1f65a3824861354
trigger_target_account_idTrigger target account ID617b3d0e90c24a5fa1f65a3824861354
trigger_target_srnTrigger target SRNsrn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuidTrigger target UUID8c9f6c1c928a45b4bbd1e4da5531d656
trigger_typeTrigger typeapigateway

2.1.25.5 - 1.0

scp-cli scf cloud-function trigger show
--trigger_id <value>

Description

show a specific cloud-function trigger

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
trigger_id
required
integerTrigger ID1

Responses

NameDescriptionExample
aliasAlias$LATEST
scheduleSchedule* * * * 0
timezoneTimezoneAsia/Tokyo
trigger_idTrigger ID1
trigger_nameTrigger name8c9f6c1c928a45b4bbd1e4da5531d656
trigger_sidTrigger target account ID617b3d0e90c24a5fa1f65a3824861354
trigger_target_account_idTrigger target account ID617b3d0e90c24a5fa1f65a3824861354
trigger_target_srnTrigger target SRNsrn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuidTrigger target UUID8c9f6c1c928a45b4bbd1e4da5531d656
trigger_typeTrigger typeapigateway

2.1.26 - Show General Config

2.1.26.1 - 1.4

scp-cli scf cloud-function config show
--cloud_function_id <value>

Description

show general config

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
max_scaleMax Scale5
memoryMemory256
min_scaleMin Scale1
timeoutTimeout100

2.1.26.2 - 1.3

scp-cli scf cloud-function config show
--cloud_function_id <value>

Description

show general config

State ACTIVE (SUPPORTED)

VersionNot Before
1.320260830

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
max_scaleMax Scale5
memoryMemory256
min_scaleMin Scale1
timeoutTimeout100

2.1.27 - Show PrivateLink Service

2.1.27.1 - 1.4

scp-cli scf privatelink-service show
--cloud_function_id <value>
[--sort <value>]

Description

show PrivateLink Service

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
sort
optional
stringSortendpoint_id:asc

Responses

NameDescriptionExample
private_urlPrivate Urlhttps://sample.scf.private.kr-west1.e.samsungsdscloud.com
privatelink_service_auth_typePrivateLink Service Auth TypeSCP_IAM
privatelink_service_enabledPrivateLink Service EnabledTrue
privatelink_service_idPrivateLink Service IDba30549f550141ef9af6546543s
privatelink_service_namePrivateLink Service Name68216f8f56
privatelink_service_stateStateActive
requested_endpointsEndpoint[]

2.1.27.2 - 1.3

scp-cli scf privatelink-service show
--cloud_function_id <value>
[--sort <value>]

Description

show PrivateLink Service

State ACTIVE (SUPPORTED)

VersionNot Before
1.320260830

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
sort
optional
stringSortendpoint_id:asc

Responses

NameDescriptionExample
private_urlPrivate Urlhttps://sample.scf.private.kr-west1.e.samsungsdscloud.com
privatelink_service_auth_typePrivateLink Service Auth TypeSCP_IAM
privatelink_service_enabledPrivateLink Service EnabledTrue
privatelink_service_idPrivateLink Service IDba30549f550141ef9af6546543s
privatelink_service_namePrivateLink Service Name68216f8f56
privatelink_service_stateStateActive
requested_endpointsEndpoint[]

2.1.28 - Show Resource Policy

2.1.28.1 - 1.4

scp-cli scf resource policy show
--cloud_function_id <value>

Description

Show resource policy

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
StatementStatement{‘Statement’: [{‘Action’: [‘scf:InvokeFunction’], ‘Condition’: {‘StringEquals’: {‘scf:CloudFunctionAuthType’: [‘SCP_IAM’]}}, ‘Effect’: ‘Allow’, ‘Principal’: ‘*’, ‘Resource’: [‘srn:e::27bb070b564349f8a31cc60734cc36a5:kr-west1::scf:cloud-function/1a2afa4bfb854a828602c93009cf4447’], ‘Sid’: ‘Statement1’}], ‘Version’: ‘2024-07-01’}
VersionVersion2024-07-01

2.1.28.2 - 1.3

scp-cli scf resource policy show
--cloud_function_id <value>

Description

Show resource policy

State ACTIVE (SUPPORTED)

VersionNot Before
1.320260830

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
StatementStatement{‘Statement’: [{‘Action’: [‘scf:InvokeFunction’], ‘Condition’: {‘StringEquals’: {‘scf:CloudFunctionAuthType’: [‘SCP_IAM’]}}, ‘Effect’: ‘Allow’, ‘Principal’: ‘*’, ‘Resource’: [‘srn:e::27bb070b564349f8a31cc60734cc36a5:kr-west1::scf:cloud-function/1a2afa4bfb854a828602c93009cf4447’], ‘Sid’: ‘Statement1’}], ‘Version’: ‘2024-07-01’}
VersionVersion2024-07-01

2.1.29 - Show Url Config

2.1.29.1 - 1.4

scp-cli scf cloud-function url show
--cloud_function_id <value>

Description

show url config

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
allow_ipsAllow Ips
auth_typeAuth TypeNONE
public_endpoint_urlPublic Endpoint Urlhttps://scf.33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/sample-function
public_ip_acl_enabledPublic IP ACL EnabledTrue
stateFunction URL StateCREATING
url_enabledURL EnabledTrue

2.1.29.2 - 1.3

scp-cli scf cloud-function url show
--cloud_function_id <value>

Description

show url config

State ACTIVE (SUPPORTED)

VersionNot Before
1.320260830

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
allow_ipsAllow Ips
auth_typeAuth TypeNONE
public_endpoint_urlPublic Endpoint Urlhttps://scf.33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/sample-function
public_ip_acl_enabledPublic IP ACL EnabledTrue
stateFunction URL StateCREATING
url_enabledURL EnabledTrue

2.1.30 - Update Cloud Function Code

2.1.30.1 - 1.4

scp-cli scf cloud-function code set
--cloud_function_id <value>
--content <value>

Description

update cloud-function code

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
content
required
stringCode contentprint("Hello World")

2.1.30.2 - 1.3

scp-cli scf cloud-function code set
--cloud_function_id <value>
--content <value>

Description

update cloud-function code

State ACTIVE (SUPPORTED)

VersionNot Before
1.320260830

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
content
required
stringCode contentprint("Hello World")

2.1.30.3 - 1.2

scp-cli scf cloud-function code set
--cloud_function_id <value>
--content <value>

Description

update cloud-function code

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

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
content
required
stringCode contentprint("Hello World")

2.1.30.4 - 1.1

scp-cli scf cloud-function code set
--cloud_function_id <value>
--content <value>

Description

update cloud-function code

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

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
content
required
stringCode contentprint("Hello World")

2.1.30.5 - 1.0

scp-cli scf cloud-function code set
--cloud_function_id <value>
--content <value>

Description

update cloud-function code

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
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
content
required
stringCode contentprint("Hello World")

2.1.31 - Update Cloud Function Code File

2.1.31.1 - 1.4

scp-cli scf cloud-function code-file set
--cloud_function_id <value>
--method_name <value>
--class_name <value>
[--obs_url <value>]

Description

update a specific cloud_function code file

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
method_name
required
stringMethod NamehandleRequest
class_name
required
stringClass Namecom.example.Handler
obs_url
optional
stringObject Storage URLhttps://obs.kr-east1.scp-in.com:8443/sample/java-sample-1.0-SNAPSHOT.jar

2.1.31.2 - 1.3

scp-cli scf cloud-function code-file set
--cloud_function_id <value>
--method_name <value>
--class_name <value>
[--obs_url <value>]

Description

update a specific cloud_function code file

State ACTIVE (SUPPORTED)

VersionNot Before
1.320260830

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
method_name
required
stringMethod NamehandleRequest
class_name
required
stringClass Namecom.example.Handler
obs_url
optional
stringObject Storage URLhttps://obs.kr-east1.scp-in.com:8443/sample/java-sample-1.0-SNAPSHOT.jar

2.1.31.3 - 1.2

scp-cli scf cloud-function code-file set
--cloud_function_id <value>
--method_name <value>
--class_name <value>
[--obs_url <value>]

Description

update a specific cloud_function code file

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

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
method_name
required
stringMethod NamehandleRequest
class_name
required
stringClass Namecom.example.Handler
obs_url
optional
stringObject Storage URLhttps://obs.kr-east1.scp-in.com:8443/sample/java-sample-1.0-SNAPSHOT.jar

2.1.31.4 - 1.1

scp-cli scf cloud-function code-file set
--cloud_function_id <value>
--method_name <value>
--class_name <value>
[--obs_url <value>]

Description

update a specific cloud_function code file

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

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
method_name
required
stringMethod NamehandleRequest
class_name
required
stringClass Namecom.example.Handler
obs_url
optional
stringObject Storage URLhttps://obs.kr-east1.scp-in.com:8443/sample/java-sample-1.0-SNAPSHOT.jar

2.1.32 - Update Cloud Function Config

2.1.32.1 - 1.4

scp-cli scf cloud-function config set
--cloud_function_id <value>
--timeout <value>
--min_scale <value>
--memory <value>
--max_scale <value>

Description

update cloud-function config

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
timeout
required
integerTimeout100
min_scale
required
integerMin Scale1
memory
required
integerMemory256
max_scale
required
integerMax Scale5

2.1.32.2 - 1.3

scp-cli scf cloud-function config set
--cloud_function_id <value>
--timeout <value>
--min_scale <value>
--memory <value>
--max_scale <value>

Description

update cloud-function config

State ACTIVE (SUPPORTED)

VersionNot Before
1.320260830

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
timeout
required
integerTimeout100
min_scale
required
integerMin Scale1
memory
required
integerMemory256
max_scale
required
integerMax Scale5

2.1.32.3 - 1.2

scp-cli scf cloud-function config set
--cloud_function_id <value>
--timeout <value>
--min_scale <value>
--memory <value>
--max_scale <value>

Description

update cloud-function config

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

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
timeout
required
integerTimeout100
min_scale
required
integerMin Scale1
memory
required
integerMemory256
max_scale
required
integerMax Scale5

2.1.32.4 - 1.1

scp-cli scf cloud-function config set
--cloud_function_id <value>
--timeout <value>
--min_scale <value>
--memory <value>
--max_scale <value>

Description

update cloud-function config

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

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
timeout
required
integerTimeout100
min_scale
required
integerMin Scale1
memory
required
integerMemory256
max_scale
required
integerMax Scale5

2.1.32.5 - 1.0

scp-cli scf cloud-function config set
--cloud_function_id <value>
--timeout <value>
--min_scale <value>
--memory <value>
--max_scale <value>

Description

update cloud-function config

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
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
timeout
required
integerTimeout100
min_scale
required
integerMin Scale1
memory
required
integerMemory256
max_scale
required
integerMax Scale5

2.1.33 - Update Cloud Function Cronjob Trigger

2.1.33.1 - 1.4

scp-cli scf cloud-function cronjob trigger set
--trigger_id <value>
--timezone <value>
--schedule <value>
--cloud_function_id <value>

Description

update cloud-function cronjob trigger

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
trigger_id
required
integerTrigger ID1
timezone
required
stringTimezoneAsia/Tokyo
schedule
required
stringSchedule* * * * 0
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

2.1.33.2 - 1.3

scp-cli scf cloud-function cronjob trigger set
--trigger_id <value>
--timezone <value>
--schedule <value>
--cloud_function_id <value>

Description

update cloud-function cronjob trigger

State ACTIVE (SUPPORTED)

VersionNot Before
1.320260830

Parameters

NameTypeDescriptionExample
trigger_id
required
integerTrigger ID1
timezone
required
stringTimezoneAsia/Tokyo
schedule
required
stringSchedule* * * * 0
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

2.1.33.3 - 1.2

scp-cli scf cloud-function cronjob trigger set
--trigger_id <value>
--timezone <value>
--schedule <value>
--cloud_function_id <value>

Description

update cloud-function cronjob trigger

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

Parameters

NameTypeDescriptionExample
trigger_id
required
integerTrigger ID1
timezone
required
stringTimezoneAsia/Tokyo
schedule
required
stringSchedule* * * * 0
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

2.1.33.4 - 1.1

scp-cli scf cloud-function cronjob trigger set
--trigger_id <value>
--timezone <value>
--schedule <value>
--cloud_function_id <value>

Description

update cloud-function cronjob trigger

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

Parameters

NameTypeDescriptionExample
trigger_id
required
integerTrigger ID1
timezone
required
stringTimezoneAsia/Tokyo
schedule
required
stringSchedule* * * * 0
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

2.1.33.5 - 1.0

scp-cli scf cloud-function cronjob trigger set
--trigger_id <value>
--timezone <value>
--schedule <value>
--cloud_function_id <value>

Description

update cloud-function cronjob trigger

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
trigger_id
required
integerTrigger ID1
timezone
required
stringTimezoneAsia/Tokyo
schedule
required
stringSchedule* * * * 0
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

2.1.34 - Update Cloud Function Url

2.1.34.1 - 1.4

scp-cli scf cloud-function url set
--cloud_function_id <value>
--url_enabled <value>
--public_ip_acl_enabled <value>
[--allow_ips <value>]
[--auth_type <value>]

Description

update cloud-function url

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
url_enabled
required
booleanURL EnabledTrue
public_ip_acl_enabled
required
booleanPublic IP ACL EnabledTrue
allow_ips
optional
arrayAllow Ips-
auth_type
optional
stringAuth TypeNONE

2.1.34.2 - 1.3

scp-cli scf cloud-function url set
--cloud_function_id <value>
--url_enabled <value>
--public_ip_acl_enabled <value>
[--allow_ips <value>]
[--auth_type <value>]

Description

update cloud-function url

State ACTIVE (SUPPORTED)

VersionNot Before
1.320260830

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
url_enabled
required
booleanURL EnabledTrue
public_ip_acl_enabled
required
booleanPublic IP ACL EnabledTrue
allow_ips
optional
arrayAllow Ips-
auth_type
optional
stringAuth TypeNONE

2.1.34.3 - 1.2

scp-cli scf cloud-function url set
--cloud_function_id <value>
--url_enabled <value>
--public_ip_acl_enabled <value>
[--allow_ips <value>]
[--auth_type <value>]

Description

update cloud-function url

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

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
url_enabled
required
booleanURL EnabledTrue
public_ip_acl_enabled
required
booleanPublic IP ACL EnabledTrue
allow_ips
optional
arrayAllow Ips-
auth_type
optional
stringAuth TypeNONE

2.1.34.4 - 1.1

scp-cli scf cloud-function url set
--cloud_function_id <value>
--url_enabled <value>
--public_ip_acl_enabled <value>
[--allow_ips <value>]
[--auth_type <value>]

Description

update cloud-function url

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

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
url_enabled
required
booleanURL EnabledTrue
public_ip_acl_enabled
required
booleanPublic IP ACL EnabledTrue
allow_ips
optional
arrayAllow Ips-
auth_type
optional
stringAuth TypeNONE

2.1.34.5 - 1.0

scp-cli scf cloud-function url set
--cloud_function_id <value>
--url_enabled <value>
--public_ip_acl_enabled <value>
[--allow_ips <value>]
[--auth_type <value>]

Description

update cloud-function url

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
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
url_enabled
required
booleanURL EnabledTrue
public_ip_acl_enabled
required
booleanPublic IP ACL EnabledTrue
allow_ips
optional
arrayAllow Ips-
auth_type
optional
stringAuth TypeNONE

2.1.35 - Update Cloud Function Variables

2.1.35.1 - 1.4

scp-cli scf cloud-function variables set
--cloud_function_id <value>
--variables <value>

Description

update cloud-function variables

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
variables
required
arrayEnvironment Variables'{"key": "sample", "value": "sample"}'

2.1.35.2 - 1.3

scp-cli scf cloud-function variables set
--cloud_function_id <value>
--variables <value>

Description

update cloud-function variables

State ACTIVE (SUPPORTED)

VersionNot Before
1.320260830

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
variables
required
arrayEnvironment Variables'{"key": "sample", "value": "sample"}'

2.1.35.3 - 1.2

scp-cli scf cloud-function variables set
--cloud_function_id <value>
--variables <value>

Description

update cloud-function variables

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

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
variables
required
arrayEnvironment Variables'{"key": "sample", "value": "sample"}'

2.1.35.4 - 1.1

scp-cli scf cloud-function variables set
--cloud_function_id <value>
--variables <value>

Description

update cloud-function variables

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

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
variables
required
arrayEnvironment Variables'{"key": "sample", "value": "sample"}'

2.1.35.5 - 1.0

scp-cli scf cloud-function variables set
--cloud_function_id <value>
--variables <value>

Description

update cloud-function variables

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
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
variables
required
arrayEnvironment Variables'{"key": "sample", "value": "sample"}'

2.1.36 - Update PrivateLink Service

2.1.36.1 - 1.4

scp-cli scf privatelink-service set
--cloud_function_id <value>
--privatelink_service_enabled <value>

Description

update PrivateLink Service

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
privatelink_service_enabled
required
booleanPrivateLink Service EnabledTrue

2.1.36.2 - 1.3

scp-cli scf privatelink-service set
--cloud_function_id <value>
--privatelink_service_enabled <value>

Description

update PrivateLink Service

State ACTIVE (SUPPORTED)

VersionNot Before
1.320260830

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
privatelink_service_enabled
required
booleanPrivateLink Service EnabledTrue

2.1.36.3 - 1.2

scp-cli scf privatelink-service set
--cloud_function_id <value>
--privatelink_service_enabled <value>

Description

update PrivateLink Service

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

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
privatelink_service_enabled
required
booleanPrivateLink Service EnabledTrue

3 - Virtual Server

Overview

Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of Virtual Server service and how to call CLI.

Version

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

VersionStatusNot Before
1.3CURRENT-
1.2SUPPORTED20260831
1.1DEPRECATED20260531
1.0DEPRECATED20251231

CLI Version History

1.3

Virtual Server CLI has been updated to allow querying the server type groups supported by GPU images.

Changes

  • [New] virtualserver image list - The following fields have been added/removed from the response.
    • Added: scp_supported_class_types

1.2

Virtual Server CLI has been released.

Changes

  • [New] virtualserver auto scaling group list - command has been added.
  • [New] virtualserver auto scaling group create - command has been added.
  • [New] virtualserver auto scaling group delete - command has been added.
  • [New] virtualserver auto scaling group show - command has been added.
  • [New] virtualserver auto scaling group set - command has been added.
  • [New] virtualserver auto scaling group lb server group list - command has been added.
  • [New] virtualserver auto scaling group lb server group set - command has been added.
  • [New] virtualserver auto scaling group notification list - command has been added.
  • [New] virtualserver auto scaling group notification create - command has been added.
  • [New] virtualserver auto scaling group notification delete - command has been added.
  • [New] virtualserver auto scaling group notification show - command has been added.
  • [New] virtualserver auto scaling group notification update - command has been added.
  • [New] virtualserver auto scaling group policy list - command has been added.
  • [New] virtualserver auto scaling group policy create - command has been added.
  • [New] virtualserver auto scaling group policy delete - command has been added.
  • [New] virtualserver auto scaling group policy show - command has been added.
  • [New] virtualserver auto scaling group policy set - command has been added.
  • [New] virtualserver auto scaling group schedule list - command has been added.
  • [New] virtualserver auto scaling group schedule create - command has been added.
  • [New] virtualserver auto scaling group schedule delete - command has been added.
  • [New] virtualserver auto scaling group schedule show - command has been added.
  • [New] virtualserver auto scaling group schedule set - command has been added.
  • [New] virtualserver auto scaling group server count set - command has been added.
  • [New] virtualserver auto scaling group server list - command has been added.
  • [New] virtualserver default config list - command has been added.
  • [New] virtualserver image list - command has been added.
  • [New] virtualserver image create - command has been added.
  • [New] virtualserver image delete - command has been added.
  • [New] virtualserver image show - command has been added.
  • [New] virtualserver image set - command has been added.
  • [New] virtualserver image import - command has been added.
  • [New] virtualserver image member list - command has been added.
  • [New] virtualserver image add member - command has been added.
  • [New] virtualserver image remove member - command has been added.
  • [New] virtualserver image member show - command has been added.
  • [New] virtualserver image member set - command has been added.
  • [New] virtualserver sharing image create - command has been added.
  • [New] virtualserver image pending list - command has been added.
  • [New] virtualserver keypair list - command has been added.
  • [New] virtualserver keypair create - command has been added.
  • [New] virtualserver keypair delete - command has been added.
  • [New] virtualserver keypair show - command has been added.
  • [New] virtualserver server type list - command has been added.
  • [New] virtualserver server type show - command has been added.
  • [New] virtualserver server list - command has been added.
  • [New] virtualserver server create - command has been added.
  • [New] virtualserver server delete - command has been added.
  • [New] virtualserver server show - command has been added.
  • [New] virtualserver server set - command has been added.
  • [New] virtualserver server console log show - command has been added.
  • [New] virtualserver server dump create - command has been added.
  • [New] virtualserver server image create - command has been added.
  • [New] virtualserver server lock - command has been added.
  • [New] virtualserver server password show - command has been added.
  • [New] virtualserver server reboot - command has been added.
  • [New] virtualserver server rebuild - command has been added.
  • [New] virtualserver server security group list - command has been added.
  • [New] virtualserver server add security group - command has been added.
  • [New] virtualserver server remove security group - command has been added.
  • [New] virtualserver server type set - command has been added.
  • [New] virtualserver server start - command has been added.
  • [New] virtualserver server stop - command has been added.
  • [New] virtualserver server unlock - command has been added.
  • [New] virtualserver volume snapshot list - command has been added.
  • [New] virtualserver volume snapshot create - command has been added.
  • [New] virtualserver volume snapshot delete - command has been added.
  • [New] virtualserver volume snapshot show - command has been added.
  • [New] virtualserver volume snapshot set - command has been added.
  • [New] virtualserver volume list - command has been added.
  • [New] virtualserver volume create - command has been added.
  • [New] virtualserver volume delete - command has been added.
  • [New] virtualserver volume show - command has been added.
  • [New] virtualserver volume set - command has been added.
  • [New] virtualserver volume revert - command has been added.
  • [New] virtualserver volume resize - command has been added.
  • [New] virtualserver launch configuration list - command has been added.
  • [New] virtualserver launch configuration create - command has been added.
  • [New] virtualserver launch configuration delete - command has been added.
  • [New] virtualserver launch configuration show - command has been added.
  • [New] virtualserver quota set show - command has been added.
  • [New] virtualserver volume quota set show - command has been added.
  • [New] virtualserver server group list - command has been added.
  • [New] virtualserver server group create - command has been added.
  • [New] virtualserver server group maximum partition size - command has been added.
  • [New] virtualserver server group delete - command has been added.
  • [New] virtualserver server group show - command has been added.
  • [New] virtualserver server interface list - command has been added.
  • [New] virtualserver server add interface - command has been added.
  • [New] virtualserver server remove interface - command has been added.
  • [New] virtualserver server interface show - command has been added.
  • [New] virtualserver server interface set - command has been added.
  • [New] virtualserver server interface add private static nat - command has been added.
  • [New] virtualserver server interface remove private static nat - command has been added.
  • [New] virtualserver server interface add static nat - command has been added.
  • [New] virtualserver server interface remove static nat - command has been added.
  • [New] virtualserver server ip list - command has been added.
  • [New] virtualserver server ip show - command has been added.
  • [New] virtualserver server volume list - command has been added.
  • [New] virtualserver server add volume - command has been added.
  • [New] virtualserver server remove volume - command has been added.
  • [New] virtualserver server volume show - command has been added.
  • [New] virtualserver server volume set - command has been added.
  • [New] virtualserver volume transfer list - command has been added.
  • [New] virtualserver volume transfer create - command has been added.
  • [New] virtualserver volume transfer delete - command has been added.
  • [New] virtualserver volume transfer show - command has been added.
  • [New] virtualserver volume transfer accept - command has been added.` - command has been added.
  • [New] virtualserver volume type list - command has been added.
  • [New] virtualserver volume type default show - command has been added.
  • [New] virtualserver volume type show - command has been added.
  • [New] virtualserver volume attach server - command has been added.
  • [New] virtualserver volume detach server - command has been added.

3.1 - CLIs

3.1.1 - Accept a volume transfer

3.1.1.1 - 1.3

scp-cli virtualserver volume transfer accept
--transfer_id <value>
--auth_key <value>

Description

Accept a volume transfer.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

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

3.1.1.2 - 1.2

scp-cli virtualserver volume transfer accept
--transfer_id <value>
--auth_key <value>

Description

Accept a volume transfer.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.1.3 - 1.1

scp-cli 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

3.1.1.4 - 1.0

scp-cli 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

3.1.2 - Attach Virtual Server Security Group

3.1.2.1 - 1.0

scp-cli 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.1.3 - Attach Volume to Virtual Server

3.1.3.1 - 1.3

scp-cli 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.3-

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.1.3.2 - 1.2

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

Description

Attach Volume to Virtual Server.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

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.1.3.3 - 1.1

scp-cli 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.1.3.4 - 1.0

scp-cli 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

3.1.4 - Create a snapshot

3.1.4.1 - 1.3

scp-cli 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.3-

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

3.1.4.2 - 1.2

scp-cli 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 (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.4.3 - 1.1

scp-cli 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

3.1.4.4 - 1.0

scp-cli 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

3.1.5 - Create a volume transfer

3.1.5.1 - 1.3

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

Description

Create a volume transfer.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

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

3.1.5.2 - 1.2

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

Description

Create a volume transfer.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.5.3 - 1.1

scp-cli 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

3.1.5.4 - 1.0

scp-cli 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

3.1.6 - Create Auto-Scaling Group

3.1.6.1 - 1.3

scp-cli 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.3-

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
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
desired_server_countDesired server count1
desired_server_count_editableDesired server count editableTrue
drain_enabledDrain enabledTrue
drain_timeoutDrain timeout300
launch_configuration_idLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f
launch_configuration_nameLaunch Configuration namelaunch-configuration-name
lb_server_groupsLB Server Group list[]
max_server_countMax server count2
min_server_countMin server count1
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameAuto-Scaling Group nameauto-scaling-group-name
security_group_idsSecurity Group ID list[‘c09c3f05-03d9-443f-b27a-40e0f973c75f’]
server_name_prefixServer name prefixserver-name-prefix
stateAuto-Scaling Group stateIN_SERVICE
state_check_delay_timeThe delay time between ASG VM creation and state check operation300
subnet_idsSubnet ID list[]
total_server_countTotal server count1
use_lb_state_checkWhether LB state check operates or notTrue
vpc_idVPC IDcc976b621087484ea5fd527f4b78708b

3.1.6.2 - 1.2

scp-cli 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 (SUPPORTED)

VersionNot Before
1.220260831

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
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
desired_server_countDesired server count1
desired_server_count_editableDesired server count editableTrue
drain_enabledDrain enabledTrue
drain_timeoutDrain timeout300
launch_configuration_idLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f
launch_configuration_nameLaunch Configuration namelaunch-configuration-name
lb_server_groupsLB Server Group list[]
max_server_countMax server count2
min_server_countMin server count1
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameAuto-Scaling Group nameauto-scaling-group-name
security_group_idsSecurity Group ID list[‘c09c3f05-03d9-443f-b27a-40e0f973c75f’]
server_name_prefixServer name prefixserver-name-prefix
stateAuto-Scaling Group stateIN_SERVICE
state_check_delay_timeThe delay time between ASG VM creation and state check operation300
subnet_idsSubnet ID list[]
total_server_countTotal server count1
use_lb_state_checkWhether LB state check operates or notTrue
vpc_idVPC IDcc976b621087484ea5fd527f4b78708b

3.1.6.3 - 1.1

scp-cli 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
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
desired_server_countDesired server count1
desired_server_count_editableDesired server count editableTrue
drain_enabledDrain enabledTrue
drain_timeoutDrain timeout300
launch_configuration_idLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f
launch_configuration_nameLaunch Configuration namelaunch-configuration-name
lb_server_groupsLB Server Group list[]
max_server_countMax server count2
min_server_countMin server count1
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameAuto-Scaling Group nameauto-scaling-group-name
security_group_idsSecurity Group ID list[‘c09c3f05-03d9-443f-b27a-40e0f973c75f’]
server_name_prefixServer name prefixserver-name-prefix
stateAuto-Scaling Group stateIN_SERVICE
subnet_idsSubnet ID list[]
total_server_countTotal server count1
vpc_idVPC IDcc976b621087484ea5fd527f4b78708b

3.1.6.4 - 1.0

scp-cli 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
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
desired_server_countDesired server count1
desired_server_count_editableDesired server count editableTrue
drain_enabledDrain enabledTrue
drain_timeoutDrain timeout300
launch_configuration_idLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f
launch_configuration_nameLaunch Configuration namelaunch-configuration-name
lb_server_groupsLB Server Group list[]
max_server_countMax server count2
min_server_countMin server count1
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameAuto-Scaling Group nameauto-scaling-group-name
security_group_idsSecurity Group ID list[‘c09c3f05-03d9-443f-b27a-40e0f973c75f’]
server_name_prefixServer name prefixserver-name-prefix
stateAuto-Scaling Group stateIN_SERVICE
subnet_idsSubnet ID list[]
total_server_countTotal server count1
vpc_idVPC IDcc976b621087484ea5fd527f4b78708b

3.1.7 - Create Auto-Scaling Group Notification

3.1.7.1 - 1.3

scp-cli 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.3-

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
countcount20
notificationsAuto-Scaling Group notification list[]

3.1.7.2 - 1.2

scp-cli 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 (SUPPORTED)

VersionNot Before
1.220260831

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
countcount20
notificationsAuto-Scaling Group notification list[]

3.1.7.3 - 1.1

scp-cli 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
countcount20
notificationsAuto-Scaling Group notification list[]

3.1.7.4 - 1.0

scp-cli 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
countcount20
notificationsAuto-Scaling Group notification list[]

3.1.8 - Create Auto-Scaling Group Policy

3.1.8.1 - 1.3

scp-cli 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.3-

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%

3.1.8.2 - 1.2

scp-cli 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 (SUPPORTED)

VersionNot Before
1.220260831

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%

3.1.8.3 - 1.1

scp-cli 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%

3.1.8.4 - 1.0

scp-cli 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%

3.1.9 - Create Auto-Scaling Group Schedule

3.1.9.1 - 1.3

scp-cli 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.3-

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

3.1.9.2 - 1.2

scp-cli 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 (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.9.3 - 1.1

scp-cli 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

3.1.9.4 - 1.0

scp-cli 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

3.1.10 - Create Image

3.1.10.1 - 1.3

scp-cli 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.3-

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}]

3.1.10.2 - 1.2

scp-cli 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 (SUPPORTED)

VersionNot Before
1.220260831

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}]

3.1.10.3 - 1.1

scp-cli 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}]

3.1.10.4 - 1.0

scp-cli 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}]

3.1.11 - Create Image member

3.1.11.1 - 1.3

scp-cli 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.3-

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

3.1.11.2 - 1.2

scp-cli virtualserver image add member
--image_id <value>
--member_id <value>

Description

Add account ID as a shared Image member.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.11.3 - 1.1

scp-cli 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

3.1.11.4 - 1.0

scp-cli 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

3.1.12 - Create Keypair

3.1.12.1 - 1.3

scp-cli 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.3-

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

3.1.12.2 - 1.2

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

Description

Create a new Keypair or Import a Public Key.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.12.3 - 1.1

scp-cli 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

3.1.12.4 - 1.0

scp-cli 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

3.1.13 - Create Launch Configuration

3.1.13.1 - 1.3

scp-cli 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.3-

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
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_countNumber of Auto-Scaling Group attached to Launch Configuration1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
file_storage_idsFile Storage ID list
image_idImage ID70a599e0-31e7-49b7-b260-868f441e862b
image_nameImage nameimagename
keypair_nameKeypair namekeypairname
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameLaunch Configuration namelaunch-configuration-name
public_keyPublic Keyssh-rsa fakeKey Generated-by-SCP
server_type_idServer type IDs1v1m2
stateLaunch Configuration stateACTIVE
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.IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==
volumesVolumes[]

3.1.13.2 - 1.2

scp-cli 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 (SUPPORTED)

VersionNot Before
1.220260831

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
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_countNumber of Auto-Scaling Group attached to Launch Configuration1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
file_storage_idsFile Storage ID list
image_idImage ID70a599e0-31e7-49b7-b260-868f441e862b
image_nameImage nameimagename
keypair_nameKeypair namekeypairname
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameLaunch Configuration namelaunch-configuration-name
public_keyPublic Keyssh-rsa fakeKey Generated-by-SCP
server_type_idServer type IDs1v1m2
stateLaunch Configuration stateACTIVE
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.IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==
volumesVolumes[]

3.1.13.3 - 1.1

scp-cli 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
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_countNumber of Auto-Scaling Group attached to Launch Configuration1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
image_idImage ID70a599e0-31e7-49b7-b260-868f441e862b
image_nameImage nameimagename
keypair_nameKeypair namekeypairname
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameLaunch Configuration namelaunch-configuration-name
public_keyPublic Keyssh-rsa fakeKey Generated-by-SCP
server_type_idServer type IDs1v1m2
stateLaunch Configuration stateACTIVE
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.IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==
volumesVolumes[]

3.1.13.4 - 1.0

scp-cli 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
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_countNumber of Auto-Scaling Group attached to Launch Configuration1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
image_idImage ID70a599e0-31e7-49b7-b260-868f441e862b
image_nameImage nameimagename
keypair_nameKeypair namekeypairname
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameLaunch Configuration namelaunch-configuration-name
public_keyPublic Keyssh-rsa fakeKey Generated-by-SCP
server_type_idServer type IDs1v1m2
stateLaunch Configuration stateACTIVE
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.IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==
volumesVolumes[]

3.1.14 - Create Server Group

3.1.14.1 - 1.3

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

Description

Create server group.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

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

3.1.14.2 - 1.2

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

Description

Create server group.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.14.3 - 1.1

scp-cli 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

3.1.14.4 - 1.0

scp-cli 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

3.1.15 - Create Server Interface

3.1.15.1 - 1.3

scp-cli 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.3-

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

3.1.15.2 - 1.2

scp-cli 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 (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.15.3 - 1.1

scp-cli 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
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

3.1.15.4 - 1.0

scp-cli 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
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

3.1.16 - Create Server Interface Nat

3.1.16.1 - 1.3

scp-cli 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.3-

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

3.1.16.2 - 1.2

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

Description

Create Server Interface Public Nat.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.16.3 - 1.1

scp-cli 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

3.1.16.4 - 1.0

scp-cli 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

3.1.17 - Create Server Interface Private Nat

3.1.17.1 - 1.3

scp-cli 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.3-

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

3.1.17.2 - 1.2

scp-cli 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 (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.17.3 - 1.1

scp-cli 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

3.1.17.4 - 1.0

scp-cli 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

3.1.18 - Create Server Volume

3.1.18.1 - 1.3

scp-cli 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.3-

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

3.1.18.2 - 1.2

scp-cli 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 (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.18.3 - 1.1

scp-cli 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

3.1.18.4 - 1.0

scp-cli 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

3.1.19 - Create Sharing Image

3.1.19.1 - 1.3

scp-cli virtualserver sharing image create
--image_id <value>

Description

Create Sharing Image.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

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

Responses

NameDescriptionExample

3.1.19.2 - 1.2

scp-cli virtualserver sharing image create
--image_id <value>

Description

Create Sharing Image.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

Parameters

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

Responses

NameDescriptionExample

3.1.19.3 - 1.1

scp-cli 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

3.1.19.4 - 1.0

scp-cli 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

3.1.20 - Create Virtual Server

3.1.20.1 - 1.3

scp-cli 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.3-

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

3.1.20.2 - 1.2

scp-cli 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 (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.20.3 - 1.1

scp-cli 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

3.1.20.4 - 1.0

scp-cli 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

3.1.21 - Create Virtual Server Custom Image

3.1.21.1 - 1.3

scp-cli virtualserver server image create
--server_id <value>
--image_name <value>

Description

Create Virtual Server Custom Image.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

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

3.1.21.2 - 1.2

scp-cli virtualserver server image create
--server_id <value>
--image_name <value>

Description

Create Virtual Server Custom Image.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.21.3 - 1.1

scp-cli 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

3.1.21.4 - 1.0

scp-cli 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

3.1.22 - Create Virtual Server Dump

3.1.22.1 - 1.3

scp-cli virtualserver server dump create
--server_id <value>

Description

Create Virtual Server Dump.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

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

Responses

NameDescriptionExample

3.1.22.2 - 1.2

scp-cli virtualserver server dump create
--server_id <value>

Description

Create Virtual Server Dump.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

Parameters

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

Responses

NameDescriptionExample

3.1.22.3 - 1.1

scp-cli 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

3.1.22.4 - 1.0

scp-cli 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

3.1.23 - Create Volume

3.1.23.1 - 1.3

scp-cli 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.3-

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
idVolume ID3f500f00-ed80-4566-a057-e31760226f9a
bootableBootableFalse
created_atCreated at
encryptedEncryptedTrue
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
modified_atModified at2025-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.False
nameVolume namevolume01
serversAttached servers[]
sizeVolume size104
snapshot_idSnapshot IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790
stateVolume stateavailable
user_idUser ID570907805e5447be84b618450ef52o0t
volume_image_metadataVolume Image metadata{}
volume_typeVolume typeSSD
volume_type_idVolume type IDc643ac35-3aec-43e6-b97a-3d6f666c5207

3.1.23.2 - 1.2

scp-cli 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 (SUPPORTED)

VersionNot Before
1.220260831

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
idVolume ID3f500f00-ed80-4566-a057-e31760226f9a
bootableBootableFalse
created_atCreated at
encryptedEncryptedTrue
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
modified_atModified at2025-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.False
nameVolume namevolume01
serversAttached servers[]
sizeVolume size104
snapshot_idSnapshot IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790
stateVolume stateavailable
user_idUser ID570907805e5447be84b618450ef52o0t
volume_image_metadataVolume Image metadata{}
volume_typeVolume typeSSD
volume_type_idVolume type IDc643ac35-3aec-43e6-b97a-3d6f666c5207

3.1.23.3 - 1.1

scp-cli 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
idVolume ID3f500f00-ed80-4566-a057-e31760226f9a
bootableBootableFalse
created_atCreated at
encryptedEncryptedTrue
modified_atModified at2025-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.False
nameVolume namevolume01
serversAttached servers[]
sizeVolume size104
snapshot_idSnapshot IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790
stateVolume stateavailable
user_idUser ID570907805e5447be84b618450ef52o0t
volume_image_metadataVolume Image metadata{}
volume_typeVolume typeSSD
volume_type_idVolume type IDc643ac35-3aec-43e6-b97a-3d6f666c5207

3.1.23.4 - 1.0

scp-cli 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
idVolume ID3f500f00-ed80-4566-a057-e31760226f9a
bootableBootableFalse
created_atCreated at
encryptedEncryptedTrue
modified_atModified at2025-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.False
nameVolume namevolume01
serversAttached servers[]
sizeVolume size104
snapshot_idSnapshot IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790
stateVolume stateavailable
user_idUser ID570907805e5447be84b618450ef52o0t
volume_image_metadataVolume Image metadata{}
volume_typeVolume typeSSD
volume_type_idVolume type IDc643ac35-3aec-43e6-b97a-3d6f666c5207

3.1.24 - Delete a snapshot

3.1.24.1 - 1.3

scp-cli virtualserver volume snapshot delete
--snapshot_id <value>

Description

Delete a snapshot.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

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

3.1.24.2 - 1.2

scp-cli virtualserver volume snapshot delete
--snapshot_id <value>

Description

Delete a snapshot.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

Parameters

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

3.1.24.3 - 1.1

scp-cli 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

3.1.24.4 - 1.0

scp-cli 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

3.1.25 - Delete a volume transfer

3.1.25.1 - 1.3

scp-cli virtualserver volume transfer delete
--transfer_id <value>

Description

Delete a volume transfer.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

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

3.1.25.2 - 1.2

scp-cli virtualserver volume transfer delete
--transfer_id <value>

Description

Delete a volume transfer.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

Parameters

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

3.1.25.3 - 1.1

scp-cli 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

3.1.25.4 - 1.0

scp-cli 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

3.1.26 - Delete Auto-Scaling Group

3.1.26.1 - 1.3

scp-cli virtualserver auto scaling group delete
--auto_scaling_group_id <value>

Description

Delete Auto-Scaling Group.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

3.1.26.2 - 1.2

scp-cli virtualserver auto scaling group delete
--auto_scaling_group_id <value>

Description

Delete Auto-Scaling Group.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

3.1.26.3 - 1.1

scp-cli 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

3.1.26.4 - 1.0

scp-cli 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

3.1.27 - Delete Auto-Scaling Group Notification

3.1.27.1 - 1.3

scp-cli 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.3-

Parameters

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

3.1.27.2 - 1.2

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

Description

Delete Auto-Scaling Group notification.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

Parameters

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

3.1.27.3 - 1.1

scp-cli 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

3.1.27.4 - 1.0

scp-cli 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

3.1.28 - Delete Auto-Scaling Group Policy

3.1.28.1 - 1.3

scp-cli 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.3-

Parameters

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

3.1.28.2 - 1.2

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

Description

Delete Auto-Scaling Group policy.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

Parameters

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

3.1.28.3 - 1.1

scp-cli 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

3.1.28.4 - 1.0

scp-cli 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

3.1.29 - Delete Auto-Scaling Group Schedule

3.1.29.1 - 1.3

scp-cli 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.3-

Parameters

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

3.1.29.2 - 1.2

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

Description

Delete Auto-Scaling Group schedule.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

Parameters

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

3.1.29.3 - 1.1

scp-cli 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

3.1.29.4 - 1.0

scp-cli 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

3.1.30 - Delete Image

3.1.30.1 - 1.3

scp-cli virtualserver image delete
--image_id <value>

Description

Delete Image.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

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

3.1.30.2 - 1.2

scp-cli virtualserver image delete
--image_id <value>

Description

Delete Image.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

Parameters

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

3.1.30.3 - 1.1

scp-cli 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

3.1.30.4 - 1.0

scp-cli 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

3.1.31 - Delete Image member

3.1.31.1 - 1.3

scp-cli virtualserver image remove member
--member_id <value>
--image_id <value>

Description

Delete Image member.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

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

3.1.31.2 - 1.2

scp-cli virtualserver image remove member
--member_id <value>
--image_id <value>

Description

Delete Image member.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

Parameters

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

3.1.31.3 - 1.1

scp-cli 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

3.1.31.4 - 1.0

scp-cli 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

3.1.32 - Delete Keypair

3.1.32.1 - 1.3

scp-cli virtualserver keypair delete
--keypair_name <value>

Description

Delete keypair.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
keypair_name
required
stringKeypair namekeypairname

3.1.32.2 - 1.2

scp-cli virtualserver keypair delete
--keypair_name <value>

Description

Delete keypair.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

Parameters

NameTypeDescriptionExample
keypair_name
required
stringKeypair namekeypairname

3.1.32.3 - 1.1

scp-cli 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

3.1.32.4 - 1.0

scp-cli 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

3.1.33 - Delete Launch Configuration

3.1.33.1 - 1.3

scp-cli virtualserver launch configuration delete
--launch_configuration_id <value>

Description

Delete Launch Configuration.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
launch_configuration_id
required
stringLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f

3.1.33.2 - 1.2

scp-cli virtualserver launch configuration delete
--launch_configuration_id <value>

Description

Delete Launch Configuration.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

Parameters

NameTypeDescriptionExample
launch_configuration_id
required
stringLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f

3.1.33.3 - 1.1

scp-cli 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

3.1.33.4 - 1.0

scp-cli 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

3.1.34 - Delete Server Group

3.1.34.1 - 1.3

scp-cli virtualserver server group delete
--server_group_id <value>

Description

Delete server group

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

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

3.1.34.2 - 1.2

scp-cli virtualserver server group delete
--server_group_id <value>

Description

Delete server group

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

Parameters

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

3.1.34.3 - 1.1

scp-cli 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

3.1.34.4 - 1.0

scp-cli 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

3.1.35 - Delete Server Interface

3.1.35.1 - 1.3

scp-cli virtualserver server remove interface
--port_id <value>
--server_id <value>

Description

Delete Server Interface.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

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

3.1.35.2 - 1.2

scp-cli virtualserver server remove interface
--port_id <value>
--server_id <value>

Description

Delete Server Interface.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

Parameters

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

3.1.35.3 - 1.1

scp-cli 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

3.1.35.4 - 1.0

scp-cli 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

3.1.36 - Delete Server Interface Nat

3.1.36.1 - 1.3

scp-cli 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.3-

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

3.1.36.2 - 1.2

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

Description

Delete Server Interface Public Nat.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.36.3 - 1.1

scp-cli 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

3.1.36.4 - 1.0

scp-cli 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

3.1.37 - Delete Server Interface Private Nat

3.1.37.1 - 1.3

scp-cli 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.3-

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

3.1.37.2 - 1.2

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

Description

Delete Server Interface Private Nat.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.37.3 - 1.1

scp-cli 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

3.1.37.4 - 1.0

scp-cli 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

3.1.38 - Delete Server Volume

3.1.38.1 - 1.3

scp-cli virtualserver server remove volume
--volume_id <value>
--server_id <value>

Description

Delete Server Volume.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

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

3.1.38.2 - 1.2

scp-cli virtualserver server remove volume
--volume_id <value>
--server_id <value>

Description

Delete Server Volume.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

Parameters

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

3.1.38.3 - 1.1

scp-cli 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

3.1.38.4 - 1.0

scp-cli 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

3.1.39 - Delete Virtual Server

3.1.39.1 - 1.3

scp-cli 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.3-

Parameters

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

3.1.39.2 - 1.2

scp-cli 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 (SUPPORTED)

VersionNot Before
1.220260831

Parameters

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

3.1.39.3 - 1.1

scp-cli 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

3.1.39.4 - 1.0

scp-cli 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

3.1.40 - Delete Volume

3.1.40.1 - 1.3

scp-cli 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.3-

Parameters

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

3.1.40.2 - 1.2

scp-cli 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 (SUPPORTED)

VersionNot Before
1.220260831

Parameters

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

3.1.40.3 - 1.1

scp-cli 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

3.1.40.4 - 1.0

scp-cli 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

3.1.41 - Detach Virtual Server Security Group

3.1.41.1 - 1.0

scp-cli 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

3.1.42 - Detach Volume from Virtual Server

3.1.42.1 - 1.3

scp-cli 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.3-

Parameters

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

3.1.42.2 - 1.2

scp-cli 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 (SUPPORTED)

VersionNot Before
1.220260831

Parameters

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

3.1.42.3 - 1.1

scp-cli 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

3.1.42.4 - 1.0

scp-cli 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

3.1.43 - Extend Volume

3.1.43.1 - 1.3

scp-cli 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.3-

Parameters

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

3.1.43.2 - 1.2

scp-cli 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 (SUPPORTED)

VersionNot Before
1.220260831

Parameters

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

3.1.43.3 - 1.1

scp-cli 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

3.1.43.4 - 1.0

scp-cli 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

3.1.44 - Get region's maximum partition size.

3.1.44.1 - 1.3

scp-cli virtualserver server group maximum partition size

Description

Get region’s maximum partition size

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Responses

NameDescriptionExample
partition_size

3.1.44.2 - 1.2

scp-cli virtualserver server group maximum partition size

Description

Get region’s maximum partition size

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

Responses

NameDescriptionExample
partition_size

3.1.44.3 - 1.1

scp-cli 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

3.1.44.4 - 1.0

scp-cli 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

3.1.45 - Import Image

3.1.45.1 - 1.3

scp-cli 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.3-

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

3.1.45.2 - 1.2

scp-cli 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 (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.45.3 - 1.1

scp-cli 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

3.1.45.4 - 1.0

scp-cli 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

3.1.46 - List Auto-Scaling Group LB Server Groups

3.1.46.1 - 1.3

scp-cli 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.3-

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

3.1.46.2 - 1.2

scp-cli 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 (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.46.3 - 1.1

scp-cli 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

3.1.46.4 - 1.0

scp-cli 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

3.1.47 - List Auto-Scaling Group Notifications

3.1.47.1 - 1.3

scp-cli 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.3-

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

3.1.47.2 - 1.2

scp-cli 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 (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.47.3 - 1.1

scp-cli 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

3.1.47.4 - 1.0

scp-cli 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

3.1.48 - List Auto-Scaling Group Policies

3.1.48.1 - 1.3

scp-cli 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.3-

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%

3.1.48.2 - 1.2

scp-cli 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 (SUPPORTED)

VersionNot Before
1.220260831

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%

3.1.48.3 - 1.1

scp-cli 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%

3.1.48.4 - 1.0

scp-cli 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%

3.1.49 - List Auto-Scaling Group Schedules

3.1.49.1 - 1.3

scp-cli 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.3-

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

3.1.49.2 - 1.2

scp-cli 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 (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.49.3 - 1.1

scp-cli 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

3.1.49.4 - 1.0

scp-cli 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

3.1.50 - List Auto-Scaling Group Virtual Servers

3.1.50.1 - 1.3

scp-cli 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.3-

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

3.1.50.2 - 1.2

scp-cli 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 (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.50.3 - 1.1

scp-cli 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

3.1.50.4 - 1.0

scp-cli 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

3.1.51 - List Auto-Scaling Groups

3.1.51.1 - 1.3

scp-cli 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.3-

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

3.1.51.2 - 1.2

scp-cli 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 (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.51.3 - 1.1

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

Description

List Auto-Scaling Groups.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260531

Parameters

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

Responses

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

3.1.51.4 - 1.0

scp-cli 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

3.1.52 - List Default Configs

3.1.52.1 - 1.3

scp-cli 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.3-

Parameters

NameTypeDescriptionExample
name
optional
stringNamekey
category
optional
stringCategoryAUTO_SCALING_GROUP

Responses

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

3.1.52.2 - 1.2

scp-cli 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 (SUPPORTED)

VersionNot Before
1.220260831

Parameters

NameTypeDescriptionExample
name
optional
stringNamekey
category
optional
stringCategoryAUTO_SCALING_GROUP

Responses

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

3.1.52.3 - 1.1

scp-cli 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

3.1.52.4 - 1.0

scp-cli 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

3.1.53 - List Image members

3.1.53.1 - 1.3

scp-cli 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.3-

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

3.1.53.2 - 1.2

scp-cli 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 (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.53.3 - 1.1

scp-cli 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

3.1.53.4 - 1.0

scp-cli 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

3.1.54 - List Images

3.1.54.1 - 1.3

scp-cli 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.3-

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
scp_supported_class_typesList of available server types
Requires --long option
GPU-A100-1,GPU-H100-2
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}]

3.1.54.2 - 1.2

scp-cli 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 (SUPPORTED)

VersionNot Before
1.220260831

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}]

3.1.54.3 - 1.1

scp-cli 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}]

3.1.54.4 - 1.0

scp-cli 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}]

3.1.55 - List Keypairs

3.1.55.1 - 1.3

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

Description

Get keypair list.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

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

3.1.55.2 - 1.2

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

Description

Get keypair list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.55.3 - 1.1

scp-cli 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

3.1.55.4 - 1.0

scp-cli 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

3.1.56 - List Launch Configurations

3.1.56.1 - 1.3

scp-cli 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.3-

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

3.1.56.2 - 1.2

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

Description

List Launch Configurations.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.56.3 - 1.1

scp-cli 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

3.1.56.4 - 1.0

scp-cli 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

3.1.57 - List pending Images

3.1.57.1 - 1.3

scp-cli 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.3-

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}]

3.1.57.2 - 1.2

scp-cli 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 (SUPPORTED)

VersionNot Before
1.220260831

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}]

3.1.57.3 - 1.1

scp-cli 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}]

3.1.57.4 - 1.0

scp-cli 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}]

3.1.58 - List Server Groups

3.1.58.1 - 1.3

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

Description

Get server group list.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

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

3.1.58.2 - 1.2

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

Description

Get server group list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.58.3 - 1.1

scp-cli 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

3.1.58.4 - 1.0

scp-cli 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

3.1.59 - List Server Interfaces

3.1.59.1 - 1.3

scp-cli virtualserver server interface list
--server_id <value>

Description

List Server Interfaces.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

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

3.1.59.2 - 1.2

scp-cli virtualserver server interface list
--server_id <value>

Description

List Server Interfaces.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.59.3 - 1.1

scp-cli 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

3.1.59.4 - 1.0

scp-cli 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

3.1.60 - List Server Ips

3.1.60.1 - 1.3

scp-cli virtualserver server ip list
--server_id <value>

Description

List Server Ips.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

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

Responses

NameDescriptionExample
ip_addressesIP addresses
subnet_nameSubnet namesubnetname

3.1.60.2 - 1.2

scp-cli virtualserver server ip list
--server_id <value>

Description

List Server Ips.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

Parameters

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

Responses

NameDescriptionExample
ip_addressesIP addresses
subnet_nameSubnet namesubnetname

3.1.60.3 - 1.1

scp-cli 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

3.1.60.4 - 1.0

scp-cli 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

3.1.61 - List Server Types

3.1.61.1 - 1.3

scp-cli 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.3-

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

3.1.61.2 - 1.2

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

Description

Get server type list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.61.3 - 1.1

scp-cli 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

3.1.61.4 - 1.0

scp-cli 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

3.1.62 - List Server Volumes

3.1.62.1 - 1.3

scp-cli virtualserver server volume list
--server_id <value>

Description

List Server Volumes.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

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

3.1.62.2 - 1.2

scp-cli virtualserver server volume list
--server_id <value>

Description

List Server Volumes.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.62.3 - 1.1

scp-cli 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

3.1.62.4 - 1.0

scp-cli 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

3.1.63 - List snapshots

3.1.63.1 - 1.3

scp-cli 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.3-

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

3.1.63.2 - 1.2

scp-cli 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 (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.63.3 - 1.1

scp-cli 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

3.1.63.4 - 1.0

scp-cli 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

3.1.64 - List Virtual Server Security Group

3.1.64.1 - 1.3

scp-cli virtualserver server security group list
--server_id <value>

Description

List Virtual Server Security Group.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

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

3.1.64.2 - 1.2

scp-cli virtualserver server security group list
--server_id <value>

Description

List Virtual Server Security Group.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.64.3 - 1.1

scp-cli 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

3.1.64.4 - 1.0

scp-cli 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

3.1.65 - List Virtual Servers

3.1.65.1 - 1.3

scp-cli 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.3-

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

3.1.65.2 - 1.2

scp-cli 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 (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.65.3 - 1.1

scp-cli 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

3.1.65.4 - 1.0

scp-cli 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

3.1.66 - List volume transfers

3.1.66.1 - 1.3

scp-cli virtualserver volume transfer list

Description

List volume transfers.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Responses

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

3.1.66.2 - 1.2

scp-cli virtualserver volume transfer list

Description

List volume transfers.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

Responses

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

3.1.66.3 - 1.1

scp-cli 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

3.1.66.4 - 1.0

scp-cli 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

3.1.67 - List volume types

3.1.67.1 - 1.3

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

Description

List volume types.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

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

3.1.67.2 - 1.2

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

Description

List volume types.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.67.3 - 1.1

scp-cli 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

3.1.67.4 - 1.0

scp-cli 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

3.1.68 - List volumes

3.1.68.1 - 1.3

scp-cli 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.3-

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

3.1.68.2 - 1.2

scp-cli 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 (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.68.3 - 1.1

scp-cli 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

3.1.68.4 - 1.0

scp-cli 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

3.1.69 - Lock Virtual Server

3.1.69.1 - 1.3

scp-cli 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.3-

Parameters

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

Responses

NameDescriptionExample

3.1.69.2 - 1.2

scp-cli 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 (SUPPORTED)

VersionNot Before
1.220260831

Parameters

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

Responses

NameDescriptionExample

3.1.69.3 - 1.1

scp-cli 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

3.1.69.4 - 1.0

scp-cli 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

3.1.70 - Reboot Virtual Server

3.1.70.1 - 1.3

scp-cli virtualserver server reboot
--server_id <value>
[--reboot_type <value>]

Description

Reboot Virtual Server.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

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

3.1.70.2 - 1.2

scp-cli virtualserver server reboot
--server_id <value>
[--reboot_type <value>]

Description

Reboot Virtual Server.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.70.3 - 1.1

scp-cli 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

3.1.70.4 - 1.0

scp-cli 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

3.1.71 - Rebuild Virtual Server

3.1.71.1 - 1.3

scp-cli virtualserver server rebuild
--server_id <value>

Description

Rebuild Virtual Server.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

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

Responses

NameDescriptionExample

3.1.71.2 - 1.2

scp-cli virtualserver server rebuild
--server_id <value>

Description

Rebuild Virtual Server.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

Parameters

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

Responses

NameDescriptionExample

3.1.71.3 - 1.1

scp-cli 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

3.1.71.4 - 1.0

scp-cli 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

3.1.72 - Revert Volume to snapshot

3.1.72.1 - 1.3

scp-cli 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.3-

Parameters

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

Responses

NameDescriptionExample

3.1.72.2 - 1.2

scp-cli 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 (SUPPORTED)

VersionNot Before
1.220260831

Parameters

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

Responses

NameDescriptionExample

3.1.72.3 - 1.1

scp-cli 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

3.1.72.4 - 1.0

scp-cli 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

3.1.73 - Set Volume Qos

3.1.73.1 - 1.3

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

Description

Set Volume Qos

State ACTIVE (CURRENT)

VersionNot Before
1.3-

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

3.1.73.2 - 1.2

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

Description

Set Volume Qos

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.74 - Show a snapshot’s details

3.1.74.1 - 1.3

scp-cli virtualserver volume snapshot show
--snapshot_id <value>

Description

Show a snapshot’s details.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

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

3.1.74.2 - 1.2

scp-cli virtualserver volume snapshot show
--snapshot_id <value>

Description

Show a snapshot’s details.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.74.3 - 1.1

scp-cli 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

3.1.74.4 - 1.0

scp-cli 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

3.1.75 - Show Auto-Scaling Group

3.1.75.1 - 1.3

scp-cli virtualserver auto scaling group show
--auto_scaling_group_id <value>

Description

Show Auto-Scaling Group.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
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
desired_server_countDesired server count1
desired_server_count_editableDesired server count editableTrue
drain_enabledDrain enabledTrue
drain_timeoutDrain timeout300
launch_configuration_idLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f
launch_configuration_nameLaunch Configuration namelaunch-configuration-name
lb_server_groupsLB Server Group list[]
max_server_countMax server count2
min_server_countMin server count1
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameAuto-Scaling Group nameauto-scaling-group-name
security_group_idsSecurity Group ID list[‘c09c3f05-03d9-443f-b27a-40e0f973c75f’]
server_name_prefixServer name prefixserver-name-prefix
stateAuto-Scaling Group stateIN_SERVICE
state_check_delay_timeThe delay time between ASG VM creation and state check operation300
subnet_idsSubnet ID list[]
total_server_countTotal server count1
use_lb_state_checkWhether LB state check operates or notTrue
vpc_idVPC IDcc976b621087484ea5fd527f4b78708b

3.1.75.2 - 1.2

scp-cli virtualserver auto scaling group show
--auto_scaling_group_id <value>

Description

Show Auto-Scaling Group.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

Parameters

NameTypeDescriptionExample
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
desired_server_countDesired server count1
desired_server_count_editableDesired server count editableTrue
drain_enabledDrain enabledTrue
drain_timeoutDrain timeout300
launch_configuration_idLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f
launch_configuration_nameLaunch Configuration namelaunch-configuration-name
lb_server_groupsLB Server Group list[]
max_server_countMax server count2
min_server_countMin server count1
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameAuto-Scaling Group nameauto-scaling-group-name
security_group_idsSecurity Group ID list[‘c09c3f05-03d9-443f-b27a-40e0f973c75f’]
server_name_prefixServer name prefixserver-name-prefix
stateAuto-Scaling Group stateIN_SERVICE
state_check_delay_timeThe delay time between ASG VM creation and state check operation300
subnet_idsSubnet ID list[]
total_server_countTotal server count1
use_lb_state_checkWhether LB state check operates or notTrue
vpc_idVPC IDcc976b621087484ea5fd527f4b78708b

3.1.75.3 - 1.1

scp-cli 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
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
desired_server_countDesired server count1
desired_server_count_editableDesired server count editableTrue
drain_enabledDrain enabledTrue
drain_timeoutDrain timeout300
launch_configuration_idLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f
launch_configuration_nameLaunch Configuration namelaunch-configuration-name
lb_server_groupsLB Server Group list[]
max_server_countMax server count2
min_server_countMin server count1
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameAuto-Scaling Group nameauto-scaling-group-name
security_group_idsSecurity Group ID list[‘c09c3f05-03d9-443f-b27a-40e0f973c75f’]
server_name_prefixServer name prefixserver-name-prefix
stateAuto-Scaling Group stateIN_SERVICE
subnet_idsSubnet ID list[]
total_server_countTotal server count1
vpc_idVPC IDcc976b621087484ea5fd527f4b78708b

3.1.75.4 - 1.0

scp-cli 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
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
desired_server_countDesired server count1
desired_server_count_editableDesired server count editableTrue
drain_enabledDrain enabledTrue
drain_timeoutDrain timeout300
launch_configuration_idLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f
launch_configuration_nameLaunch Configuration namelaunch-configuration-name
lb_server_groupsLB Server Group list[]
max_server_countMax server count2
min_server_countMin server count1
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameAuto-Scaling Group nameauto-scaling-group-name
security_group_idsSecurity Group ID list[‘c09c3f05-03d9-443f-b27a-40e0f973c75f’]
server_name_prefixServer name prefixserver-name-prefix
stateAuto-Scaling Group stateIN_SERVICE
subnet_idsSubnet ID list[]
total_server_countTotal server count1
vpc_idVPC IDcc976b621087484ea5fd527f4b78708b

3.1.76 - Show Auto-Scaling Group Notification

3.1.76.1 - 1.3

scp-cli 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.3-

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

3.1.76.2 - 1.2

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

Description

Show Auto-Scaling Group notification.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.76.3 - 1.1

scp-cli 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

3.1.76.4 - 1.0

scp-cli 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

3.1.77 - Show Auto-Scaling Group Policy

3.1.77.1 - 1.3

scp-cli 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.3-

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%

3.1.77.2 - 1.2

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

Description

Show Auto-Scaling Group policy.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

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%

3.1.77.3 - 1.1

scp-cli 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%

3.1.77.4 - 1.0

scp-cli 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%

3.1.78 - Show Auto-Scaling Group Schedule

3.1.78.1 - 1.3

scp-cli 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.3-

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

3.1.78.2 - 1.2

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

Description

Show Auto-Scaling Group schedule.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.78.3 - 1.1

scp-cli 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

3.1.78.4 - 1.0

scp-cli 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

3.1.79 - Show default Volume type’s details

3.1.79.1 - 1.3

scp-cli virtualserver volume type default show

Description

Show a default Volume type’s details.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Responses

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

3.1.79.2 - 1.2

scp-cli virtualserver volume type default show

Description

Show a default Volume type’s details.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

Responses

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

3.1.79.3 - 1.1

scp-cli 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

3.1.79.4 - 1.0

scp-cli 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

3.1.80 - Show Image

3.1.80.1 - 1.3

scp-cli virtualserver image show
--image_id <value>

Description

Show Image.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

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}]

3.1.80.2 - 1.2

scp-cli virtualserver image show
--image_id <value>

Description

Show Image.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

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}]

3.1.80.3 - 1.1

scp-cli 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}]

3.1.80.4 - 1.0

scp-cli 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}]

3.1.81 - Show Image member

3.1.81.1 - 1.3

scp-cli virtualserver image member show
--member_id <value>
--image_id <value>

Description

Show Image member.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

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

3.1.81.2 - 1.2

scp-cli virtualserver image member show
--member_id <value>
--image_id <value>

Description

Show Image member.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.81.3 - 1.1

scp-cli 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

3.1.81.4 - 1.0

scp-cli 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

3.1.82 - Show Keypair

3.1.82.1 - 1.3

scp-cli virtualserver keypair show
--keypair_name <value>

Description

Show keypair.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

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

3.1.82.2 - 1.2

scp-cli virtualserver keypair show
--keypair_name <value>

Description

Show keypair.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.82.3 - 1.1

scp-cli 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

3.1.82.4 - 1.0

scp-cli 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

3.1.83 - Show Launch Configuration

3.1.83.1 - 1.3

scp-cli virtualserver launch configuration show
--launch_configuration_id <value>

Description

Show Launch Configuration.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
launch_configuration_id
required
stringLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_countNumber of Auto-Scaling Group attached to Launch Configuration1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
file_storage_idsFile Storage ID list
image_idImage ID70a599e0-31e7-49b7-b260-868f441e862b
image_nameImage nameimagename
keypair_nameKeypair namekeypairname
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameLaunch Configuration namelaunch-configuration-name
public_keyPublic Keyssh-rsa fakeKey Generated-by-SCP
server_type_idServer type IDs1v1m2
stateLaunch Configuration stateACTIVE
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.IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==
volumesVolumes[]

3.1.83.2 - 1.2

scp-cli virtualserver launch configuration show
--launch_configuration_id <value>

Description

Show Launch Configuration.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

Parameters

NameTypeDescriptionExample
launch_configuration_id
required
stringLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_countNumber of Auto-Scaling Group attached to Launch Configuration1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
file_storage_idsFile Storage ID list
image_idImage ID70a599e0-31e7-49b7-b260-868f441e862b
image_nameImage nameimagename
keypair_nameKeypair namekeypairname
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameLaunch Configuration namelaunch-configuration-name
public_keyPublic Keyssh-rsa fakeKey Generated-by-SCP
server_type_idServer type IDs1v1m2
stateLaunch Configuration stateACTIVE
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.IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==
volumesVolumes[]

3.1.83.3 - 1.1

scp-cli 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
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_countNumber of Auto-Scaling Group attached to Launch Configuration1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
image_idImage ID70a599e0-31e7-49b7-b260-868f441e862b
image_nameImage nameimagename
keypair_nameKeypair namekeypairname
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameLaunch Configuration namelaunch-configuration-name
public_keyPublic Keyssh-rsa fakeKey Generated-by-SCP
server_type_idServer type IDs1v1m2
stateLaunch Configuration stateACTIVE
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.IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==
volumesVolumes[]

3.1.83.4 - 1.0

scp-cli 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
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_countNumber of Auto-Scaling Group attached to Launch Configuration1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
image_idImage ID70a599e0-31e7-49b7-b260-868f441e862b
image_nameImage nameimagename
keypair_nameKeypair namekeypairname
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameLaunch Configuration namelaunch-configuration-name
public_keyPublic Keyssh-rsa fakeKey Generated-by-SCP
server_type_idServer type IDs1v1m2
stateLaunch Configuration stateACTIVE
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.IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==
volumesVolumes[]

3.1.84 - Show Server Group

3.1.84.1 - 1.3

scp-cli virtualserver server group show
--server_group_id <value>

Description

Show server group.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

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

3.1.84.2 - 1.2

scp-cli virtualserver server group show
--server_group_id <value>

Description

Show server group.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.84.3 - 1.1

scp-cli 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

3.1.84.4 - 1.0

scp-cli 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

3.1.85 - Show Server Interface

3.1.85.1 - 1.3

scp-cli virtualserver server interface show
--port_id <value>
--server_id <value>

Description

Show Server Interface.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

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

3.1.85.2 - 1.2

scp-cli virtualserver server interface show
--port_id <value>
--server_id <value>

Description

Show Server Interface.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.85.3 - 1.1

scp-cli 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

3.1.85.4 - 1.0

scp-cli 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

3.1.86 - Show Server Ip

3.1.86.1 - 1.3

scp-cli virtualserver server ip show
--subnet_id <value>
--server_id <value>

Description

Show Server Ip.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

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

Responses

NameDescriptionExample
ip_addressesIP addresses[]
subnet_nameSubnet namesubnetname

3.1.86.2 - 1.2

scp-cli virtualserver server ip show
--subnet_id <value>
--server_id <value>

Description

Show Server Ip.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

Parameters

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

Responses

NameDescriptionExample
ip_addressesIP addresses[]
subnet_nameSubnet namesubnetname

3.1.86.3 - 1.1

scp-cli 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_addressesIP addresses[]
subnet_nameSubnet namesubnetname

3.1.86.4 - 1.0

scp-cli 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_addressesIP addresses[]
subnet_nameSubnet namesubnetname

3.1.87 - Show Server Quota Set

3.1.87.1 - 1.3

scp-cli virtualserver quota set show

Description

Show server quota Set.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

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

3.1.87.2 - 1.2

scp-cli virtualserver quota set show

Description

Show server quota Set.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.87.3 - 1.1

scp-cli 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

3.1.87.4 - 1.0

scp-cli 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

3.1.88 - Show Server Type

3.1.88.1 - 1.3

scp-cli virtualserver server type show
--server_type_id <value>

Description

Show server type.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

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

3.1.88.2 - 1.2

scp-cli virtualserver server type show
--server_type_id <value>

Description

Show server type.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.88.3 - 1.1

scp-cli 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

3.1.88.4 - 1.0

scp-cli 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

3.1.89 - Show Server Volume

3.1.89.1 - 1.3

scp-cli virtualserver server volume show
--volume_id <value>
--server_id <value>

Description

Show Server Volume.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

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

3.1.89.2 - 1.2

scp-cli virtualserver server volume show
--volume_id <value>
--server_id <value>

Description

Show Server Volume.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.89.3 - 1.1

scp-cli 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

3.1.89.4 - 1.0

scp-cli 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

3.1.90 - Show Virtual Server

3.1.90.1 - 1.3

scp-cli virtualserver server show
--server_id <value>

Description

Show Virtual Server.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

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

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

3.1.90.2 - 1.2

scp-cli virtualserver server show
--server_id <value>

Description

Show Virtual Server.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

Parameters

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

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

3.1.90.3 - 1.1

scp-cli 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
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
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

3.1.90.4 - 1.0

scp-cli 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
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
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

3.1.91 - Show Virtual Server Console Log

3.1.91.1 - 1.3

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

Description

Show Virtual Server Console Log.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

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

3.1.91.2 - 1.2

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

Description

Show Virtual Server Console Log.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.91.3 - 1.1

scp-cli 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

3.1.91.4 - 1.0

scp-cli 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

3.1.92 - Show Virtual Server Password

3.1.92.1 - 1.3

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

Description

Show Virtual Server Password.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

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

3.1.92.2 - 1.2

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

Description

Show Virtual Server Password.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.92.3 - 1.1

scp-cli 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

3.1.92.4 - 1.0

scp-cli 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

3.1.93 - Show Volume Quota Set

3.1.93.1 - 1.3

scp-cli virtualserver volume quota set show

Description

Show volume quota set.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Responses

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

3.1.93.2 - 1.2

scp-cli virtualserver volume quota set show

Description

Show volume quota set.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

Responses

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

3.1.93.3 - 1.1

scp-cli 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

3.1.93.4 - 1.0

scp-cli 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

3.1.94 - Show volume transfer detail

3.1.94.1 - 1.3

scp-cli virtualserver volume transfer show
--transfer_id <value>

Description

Show volume transfer detail.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

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

3.1.94.2 - 1.2

scp-cli virtualserver volume transfer show
--transfer_id <value>

Description

Show volume transfer detail.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.94.3 - 1.1

scp-cli 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

3.1.94.4 - 1.0

scp-cli 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

3.1.95 - Show Volume type’s details

3.1.95.1 - 1.3

scp-cli virtualserver volume type show
--volume_type_id <value>

Description

Show a Volume type’s details.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

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

3.1.95.2 - 1.2

scp-cli virtualserver volume type show
--volume_type_id <value>

Description

Show a Volume type’s details.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.95.3 - 1.1

scp-cli 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

3.1.95.4 - 1.0

scp-cli 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

3.1.96 - Show Volume's details

3.1.96.1 - 1.3

scp-cli virtualserver volume show
--volume_id <value>

Description

Show a Volume’s details.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

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

Responses

NameDescriptionExample
idVolume ID3f500f00-ed80-4566-a057-e31760226f9a
bootableBootableFalse
created_atCreated at
encryptedEncryptedTrue
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
modified_atModified at2025-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.False
nameVolume namevolume01
serversAttached servers[]
sizeVolume size104
snapshot_idSnapshot IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790
stateVolume stateavailable
user_idUser ID570907805e5447be84b618450ef52o0t
volume_image_metadataVolume Image metadata{}
volume_typeVolume typeSSD
volume_type_idVolume type IDc643ac35-3aec-43e6-b97a-3d6f666c5207

3.1.96.2 - 1.2

scp-cli virtualserver volume show
--volume_id <value>

Description

Show a Volume’s details.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

Parameters

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

Responses

NameDescriptionExample
idVolume ID3f500f00-ed80-4566-a057-e31760226f9a
bootableBootableFalse
created_atCreated at
encryptedEncryptedTrue
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
modified_atModified at2025-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.False
nameVolume namevolume01
serversAttached servers[]
sizeVolume size104
snapshot_idSnapshot IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790
stateVolume stateavailable
user_idUser ID570907805e5447be84b618450ef52o0t
volume_image_metadataVolume Image metadata{}
volume_typeVolume typeSSD
volume_type_idVolume type IDc643ac35-3aec-43e6-b97a-3d6f666c5207

3.1.96.3 - 1.1

scp-cli 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
idVolume ID3f500f00-ed80-4566-a057-e31760226f9a
bootableBootableFalse
created_atCreated at
encryptedEncryptedTrue
modified_atModified at2025-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.False
nameVolume namevolume01
serversAttached servers[]
sizeVolume size104
snapshot_idSnapshot IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790
stateVolume stateavailable
user_idUser ID570907805e5447be84b618450ef52o0t
volume_image_metadataVolume Image metadata{}
volume_typeVolume typeSSD
volume_type_idVolume type IDc643ac35-3aec-43e6-b97a-3d6f666c5207

3.1.96.4 - 1.0

scp-cli 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
idVolume ID3f500f00-ed80-4566-a057-e31760226f9a
bootableBootableFalse
created_atCreated at
encryptedEncryptedTrue
modified_atModified at2025-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.False
nameVolume namevolume01
serversAttached servers[]
sizeVolume size104
snapshot_idSnapshot IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790
stateVolume stateavailable
user_idUser ID570907805e5447be84b618450ef52o0t
volume_image_metadataVolume Image metadata{}
volume_typeVolume typeSSD
volume_type_idVolume type IDc643ac35-3aec-43e6-b97a-3d6f666c5207

3.1.97 - Start Virtual Server

3.1.97.1 - 1.3

scp-cli virtualserver server start
--server_id <value>

Description

Start Virtual Server.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

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

Responses

NameDescriptionExample

3.1.97.2 - 1.2

scp-cli virtualserver server start
--server_id <value>

Description

Start Virtual Server.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

Parameters

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

Responses

NameDescriptionExample

3.1.97.3 - 1.1

scp-cli 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

3.1.97.4 - 1.0

scp-cli 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

3.1.98 - Stop Virtual Server

3.1.98.1 - 1.3

scp-cli virtualserver server stop
--server_id <value>

Description

Stop Virtual Server.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

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

Responses

NameDescriptionExample

3.1.98.2 - 1.2

scp-cli virtualserver server stop
--server_id <value>

Description

Stop Virtual Server.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

Parameters

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

Responses

NameDescriptionExample

3.1.98.3 - 1.1

scp-cli 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

3.1.98.4 - 1.0

scp-cli 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

3.1.99 - Unlock Virtual Server

3.1.99.1 - 1.3

scp-cli virtualserver server unlock
--server_id <value>

Description

Unlock Virtual Server.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

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

Responses

NameDescriptionExample

3.1.99.2 - 1.2

scp-cli virtualserver server unlock
--server_id <value>

Description

Unlock Virtual Server.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

Parameters

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

Responses

NameDescriptionExample

3.1.99.3 - 1.1

scp-cli 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

3.1.99.4 - 1.0

scp-cli 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

3.1.100 - Update a snapshot

3.1.100.1 - 1.3

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

Description

Update a snapshot.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

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

3.1.100.2 - 1.2

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

Description

Update a snapshot.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

Parameters

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

3.1.100.3 - 1.1

scp-cli 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

3.1.100.4 - 1.0

scp-cli 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

3.1.101 - Update Auto-Scaling Group

3.1.101.1 - 1.3

scp-cli 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.3-

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

3.1.101.2 - 1.2

scp-cli 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 (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.101.3 - 1.1

scp-cli 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

3.1.101.4 - 1.0

scp-cli 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

3.1.102 - Update Auto-Scaling Group LB Server Groups

3.1.102.1 - 1.3

scp-cli 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.3-

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}'

3.1.102.2 - 1.2

scp-cli 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 (SUPPORTED)

VersionNot Before
1.220260831

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}'

3.1.102.3 - 1.1

scp-cli 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}'

3.1.102.4 - 1.0

scp-cli 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}'

3.1.103 - Update Auto-Scaling Group Notification

3.1.103.1 - 1.3

scp-cli 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.3-

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

3.1.103.2 - 1.2

scp-cli 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 (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.103.3 - 1.1

scp-cli 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

3.1.103.4 - 1.0

scp-cli 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

3.1.104 - Update Auto-Scaling Group Policy

3.1.104.1 - 1.3

scp-cli 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.3-

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

3.1.104.2 - 1.2

scp-cli 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 (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.104.3 - 1.1

scp-cli 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

3.1.104.4 - 1.0

scp-cli 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

3.1.105 - Update Auto-Scaling Group Schedule

3.1.105.1 - 1.3

scp-cli 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.3-

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

3.1.105.2 - 1.2

scp-cli 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 (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.105.3 - 1.1

scp-cli 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

3.1.105.4 - 1.0

scp-cli 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

3.1.106 - Update Auto-Scaling Group server count

3.1.106.1 - 1.3

scp-cli 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.3-

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

3.1.106.2 - 1.2

scp-cli 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 (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.106.3 - 1.1

scp-cli 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

3.1.106.4 - 1.0

scp-cli 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

3.1.107 - Update Image

3.1.107.1 - 1.3

scp-cli 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.3-

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

3.1.107.2 - 1.2

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

Description

Update Image.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.107.3 - 1.1

scp-cli 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

3.1.107.4 - 1.0

scp-cli 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

3.1.108 - Update Image member

3.1.108.1 - 1.3

scp-cli virtualserver image member set
--member_id <value>
--image_id <value>
--status <value>

Description

Update Image member.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

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

3.1.108.2 - 1.2

scp-cli virtualserver image member set
--member_id <value>
--image_id <value>
--status <value>

Description

Update Image member.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.108.3 - 1.1

scp-cli 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

3.1.108.4 - 1.0

scp-cli 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

3.1.109 - Update Server Interface

3.1.109.1 - 1.3

scp-cli 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.3-

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-

3.1.109.2 - 1.2

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

Description

Update Server Interface.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

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-

3.1.109.3 - 1.1

scp-cli 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-

3.1.109.4 - 1.0

scp-cli 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-

3.1.110 - Update Server Volume

3.1.110.1 - 1.3

scp-cli 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.3-

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

3.1.110.2 - 1.2

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

Description

Update Server Volume.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

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

3.1.110.3 - 1.1

scp-cli 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

3.1.110.4 - 1.0

scp-cli 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

3.1.111 - Update Virtual Server

3.1.111.1 - 1.3

scp-cli virtualserver server set
--server_id <value>
--name <value>

Description

Update Virtual Server.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

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

3.1.111.2 - 1.2

scp-cli virtualserver server set
--server_id <value>
--name <value>

Description

Update Virtual Server.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

Parameters

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

3.1.111.3 - 1.1

scp-cli 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

3.1.111.4 - 1.0

scp-cli 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

3.1.112 - Update Virtual Server type

3.1.112.1 - 1.3

scp-cli virtualserver server type set
--server_id <value>
--server_type <value>

Description

Update Virtual Server type

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

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

Responses

NameDescriptionExample

3.1.112.2 - 1.2

scp-cli virtualserver server type set
--server_id <value>
--server_type <value>

Description

Update Virtual Server type

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

Parameters

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

Responses

NameDescriptionExample

3.1.112.3 - 1.1

scp-cli 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

3.1.112.4 - 1.0

scp-cli 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

3.1.113 - Update Volume

3.1.113.1 - 1.3

scp-cli virtualserver volume set
--volume_id <value>
[--name <value>]

Description

Update a Volume.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

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

3.1.113.2 - 1.2

scp-cli virtualserver volume set
--volume_id <value>
[--name <value>]

Description

Update a Volume.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260831

Parameters

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

3.1.113.3 - 1.1

scp-cli 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

3.1.113.4 - 1.0

scp-cli 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