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
| Version | Status | Supported Until |
|---|
| 1.0 | DEPRECATED | 20251231 |
| 1.1 | CURRENT | - |
1 - CLIs
1.1 - Accept a volume transfer
1.1.1 - 1.1
scpcli virtualserver volume transfer accept
--transfer_id <value>
--auth_key <value>
Description
Accept a volume transfer.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
transfer_id required | string | Transfer ID | 1ac231be-823b-4a4d-8ff0-aac503a7118a |
auth_key required | string | Auth key | f5972fdb456897eb |
Responses
| Name | Description | Example |
|---|
| id | Transfer ID | 1ac231be-823b-4a4d-8ff0-aac503a7118a |
| name | Volume name | volume01 |
| volume_id | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
1.1.2 - 1.0
scpcli virtualserver volume transfer accept
--transfer_id <value>
--auth_key <value>
Description
Accept a volume transfer.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
transfer_id required | string | Transfer ID | 1ac231be-823b-4a4d-8ff0-aac503a7118a |
auth_key required | string | Auth key | f5972fdb456897eb |
Responses
| Name | Description | Example |
|---|
| id | Transfer ID | 1ac231be-823b-4a4d-8ff0-aac503a7118a |
| name | Volume name | volume01 |
| volume_id | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
1.2 - Attach Virtual Server Security Group
1.2.1 - 1.0
scpcli virtualserver server add security group
--server_id <value>
--security_group_id <value>
Description
Attach Virtual Server Security Group.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
security_group_id required | string | Security Group ID | c09c3f05-03d9-443f-b27a-40e0f973c75f |
Responses
1.3 - Attach Volume to Virtual Server
1.3.1 - 1.1
scpcli virtualserver volume attach server
--volume_id <value>
--server_id <value>
[--delete_on_termination <value>]
Description
Attach Volume to Virtual Server.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
delete_on_termination optional | boolean | Delete on termination | False |
Responses
| Name | Description | Example |
|---|
| delete_on_termination | Delete on termination | False |
| device | Device name | /dev/vda |
| server_id | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| volume_id | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
1.3.2 - 1.0
scpcli virtualserver volume attach server
--volume_id <value>
--server_id <value>
[--delete_on_termination <value>]
Description
Attach Volume to Virtual Server.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
delete_on_termination optional | boolean | Delete on termination | False |
Responses
| Name | Description | Example |
|---|
| delete_on_termination | Delete on termination | False |
| device | Device name | /dev/vda |
| server_id | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| volume_id | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
1.4 - Create a snapshot
1.4.1 - 1.1
scpcli virtualserver volume snapshot create
--volume_id <value>
--name <value>
[--description <value>]
[--force <value>]
[--metadata <value>]
Description
Create a snapshot.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
name required | string | Snapshot name | snapshot-1 |
description optional | string | Description | description |
force optional | boolean | Force | True |
metadata optional | **** | Snapshot metadata | - |
Responses
| Name | Description | Example |
|---|
| id | Snapshot ID | cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 |
| created_at | Created at | 2025-07-22T09:00:00Z |
| description | Description | description |
| metadata | Snapshot metadata | |
| name | Snapshot name | snapshot-1 |
| size | Volume size | 104 |
| status | Volume state | available |
| updated_at | Updated at | 2025-07-26T12:00:00Z |
| user_id | User ID | 570907805e5447be84b618450ef52o0t |
| volume_id | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
1.4.2 - 1.0
scpcli virtualserver volume snapshot create
--volume_id <value>
--name <value>
[--description <value>]
[--force <value>]
[--metadata <value>]
Description
Create a snapshot.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
name required | string | Snapshot name | snapshot-1 |
description optional | string | Description | description |
force optional | boolean | Force | True |
metadata optional | **** | Snapshot metadata | - |
Responses
| Name | Description | Example |
|---|
| id | Snapshot ID | cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 |
| created_at | Created at | 2025-07-22T09:00:00Z |
| description | Description | description |
| metadata | Snapshot metadata | |
| name | Snapshot name | snapshot-1 |
| size | Volume size | 104 |
| status | Volume state | available |
| updated_at | Updated at | 2025-07-26T12:00:00Z |
| user_id | User ID | 570907805e5447be84b618450ef52o0t |
| volume_id | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
1.5 - Create a volume transfer
1.5.1 - 1.1
scpcli virtualserver volume transfer create
--volume_id <value>
[--name <value>]
Description
Create a volume transfer.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
name optional | string | Volume name | volume01 |
Responses
| Name | Description | Example |
|---|
| id | Transfer ID | 1ac231be-823b-4a4d-8ff0-aac503a7118a |
| auth_key | Auth key | f5972fdb456897eb |
| created_at | Created at | |
| name | Volume name | volume01 |
| volume_id | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
1.5.2 - 1.0
scpcli virtualserver volume transfer create
--volume_id <value>
[--name <value>]
Description
Create a volume transfer.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
name optional | string | Volume name | volume01 |
Responses
| Name | Description | Example |
|---|
| id | Transfer ID | 1ac231be-823b-4a4d-8ff0-aac503a7118a |
| auth_key | Auth key | f5972fdb456897eb |
| created_at | Created at | |
| name | Volume name | volume01 |
| volume_id | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
1.6 - Create Auto-Scaling Group
1.6.1 - 1.1
scpcli virtualserver auto scaling group create
--subnet_ids <value>
--server_name_prefix <value>
--name <value>
--min_server_count <value>
--max_server_count <value>
--launch_configuration_id <value>
--desired_server_count_editable <value>
--desired_server_count <value>
[--drain_enabled <value>]
[--drain_timeout <value>]
[--lb_server_groups <value>]
[--notifications <value>]
[--scaling_policies <value>]
[--security_group_ids <value>]
[--tags <value>]
Description
Create Auto-Scaling Group.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
subnet_ids required | array | Subnet ID list | - |
server_name_prefix required | string | Server name prefix | server-name-prefix |
name required | string | Auto-Scaling Group name | auto-scaling-group-name |
min_server_count required | integer | Min server count | 1 |
max_server_count required | integer | Max server count | 2 |
launch_configuration_id required | string | Launch Configuration ID | b5aea5a675fc4f6b9e0fcd1288354c5f |
desired_server_count_editable required | boolean | Desired server count editable | True |
desired_server_count required | integer | Desired server count | 1 |
drain_enabled optional | boolean | Drain enabled | True |
drain_timeout optional | integer | Drain timeout | 300 |
lb_server_groups optional | array | LB Server Group list | '{"id": "d06e87d3-ca9a-461b-8e88-077a542a7335", "port": 8080}' |
notifications optional | array | Notifications | '{"notification_events": ["SCALE_OUT", "SCALE_OUT_FAIL"], "user_ids": ["570907805e5447be84b618450ef52o0t"]}' |
scaling_policies optional | array | Scaling policy list | '{"comparison_operator": "ge", "cooldown_seconds": 300, "evaluation_minutes": 1, "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 | array | Security Group ID list | [ |
tags optional | array | Tags | '{"key": "Key", "value": "Value"}' |
Responses
| Name | Description | Example |
|---|
| id | LB Server Group ID | d06e87d3-ca9a-461b-8e88-077a542a7335 |
| port | LB Server Group port | 8080 |
1.6.2 - 1.0
scpcli virtualserver auto scaling group create
--subnet_ids <value>
--server_name_prefix <value>
--name <value>
--min_server_count <value>
--max_server_count <value>
--launch_configuration_id <value>
--desired_server_count_editable <value>
--desired_server_count <value>
[--drain_enabled <value>]
[--drain_timeout <value>]
[--lb_server_groups <value>]
[--notifications <value>]
[--scaling_policies <value>]
[--security_group_ids <value>]
[--tags <value>]
Description
Create Auto-Scaling Group.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
subnet_ids required | array | Subnet ID list | - |
server_name_prefix required | string | Server name prefix | server-name-prefix |
name required | string | Auto-Scaling Group name | auto-scaling-group-name |
min_server_count required | integer | Min server count | 1 |
max_server_count required | integer | Max server count | 2 |
launch_configuration_id required | string | Launch Configuration ID | b5aea5a675fc4f6b9e0fcd1288354c5f |
desired_server_count_editable required | boolean | Desired server count editable | True |
desired_server_count required | integer | Desired server count | 1 |
drain_enabled optional | boolean | Drain enabled | True |
drain_timeout optional | integer | Drain timeout | 300 |
lb_server_groups optional | array | LB Server Group list | '{"id": "d06e87d3-ca9a-461b-8e88-077a542a7335", "port": 8080}' |
notifications optional | array | Notifications | '{"notification_events": ["SCALE_OUT", "SCALE_OUT_FAIL"], "user_ids": ["570907805e5447be84b618450ef52o0t"]}' |
scaling_policies optional | array | Scaling policy list | '{"comparison_operator": "ge", "cooldown_seconds": 300, "evaluation_minutes": 1, "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 | array | Security Group ID list | [ |
tags optional | array | Tags | '{"key": "Key", "value": "Value"}' |
Responses
| Name | Description | Example |
|---|
| id | LB Server Group ID | d06e87d3-ca9a-461b-8e88-077a542a7335 |
| port | LB Server Group port | 8080 |
1.7 - Create Auto-Scaling Group Notification
1.7.1 - 1.1
scpcli virtualserver auto scaling group notification create
--auto_scaling_group_id <value>
--user_ids <value>
--notification_events <value>
Description
Create Auto-Scaling Group notification.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
user_ids required | array | User ID list | 570907805e5447be84b618450ef52o0t |
notification_events required | array | Auto-Scaling Group notification events | SCALE_OUT |
Responses
| Name | Description | Example |
|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| auto_scaling_group_id | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| notification_events | Auto-Scaling Group notification events | [‘SCALE_OUT’, ‘SCALE_OUT_FAIL’] |
| notification_state | Auto-Scaling Group notification state | ACTIVE |
| user_id | User ID | 570907805e5447be84b618450ef52o0t |
| user_name | User name | scpuser |
1.7.2 - 1.0
scpcli virtualserver auto scaling group notification create
--auto_scaling_group_id <value>
--user_ids <value>
--notification_events <value>
Description
Create Auto-Scaling Group notification.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
user_ids required | array | User ID list | 570907805e5447be84b618450ef52o0t |
notification_events required | array | Auto-Scaling Group notification events | SCALE_OUT |
Responses
| Name | Description | Example |
|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| auto_scaling_group_id | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| notification_events | Auto-Scaling Group notification events | [‘SCALE_OUT’, ‘SCALE_OUT_FAIL’] |
| notification_state | Auto-Scaling Group notification state | ACTIVE |
| user_id | User ID | 570907805e5447be84b618450ef52o0t |
| user_name | User name | scpuser |
1.8 - Create Auto-Scaling Group Policy
1.8.1 - 1.1
scpcli virtualserver auto scaling group policy create
--auto_scaling_group_id <value>
--threshold <value>
--scale_value <value>
--scale_type <value>
--scale_method <value>
--name <value>
--metric_type <value>
--metric_method <value>
--evaluation_minutes <value>
--cooldown_seconds <value>
--comparison_operator <value>
Description
Create Auto-Scaling Group policy.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
threshold required | integer | Threshold | 60 |
scale_value required | integer | Scale value | 10 |
scale_type required | string | Scale type | SCALE_OUT |
scale_method required | string | Scale method | AMOUNT |
name required | string | Policy name | policy-name |
metric_type required | string | Metric type | CPU |
metric_method required | string | Metric method | AVG |
evaluation_minutes required | integer | Evaluation minutes | 1 |
cooldown_seconds required | integer | Cooldown seconds | 300 |
comparison_operator required | string | Comparison operator | ge |
Responses
| Name | Description | Example |
|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| auto_scaling_group_id | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| comparison_operator | Comparison operator | ge |
| cooldown_seconds | Cooldown seconds | 300 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| evaluation_minutes | Evaluation minutes | 1 |
| metric_method | Metric method | AVG |
| metric_type | Metric type | CPU |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Policy name | policy-name |
| scale_method | Scale method | AMOUNT |
| scale_type | Scale type | SCALE_OUT |
| scale_value | Scale value | 10 |
| state | Policy state | ACTIVE |
| threshold | Threshold | 60 |
| threshold_unit | Threshold unit | % |
1.8.2 - 1.0
scpcli virtualserver auto scaling group policy create
--auto_scaling_group_id <value>
--threshold <value>
--scale_value <value>
--scale_type <value>
--scale_method <value>
--name <value>
--metric_type <value>
--metric_method <value>
--evaluation_minutes <value>
--cooldown_seconds <value>
--comparison_operator <value>
Description
Create Auto-Scaling Group policy.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
threshold required | integer | Threshold | 60 |
scale_value required | integer | Scale value | 10 |
scale_type required | string | Scale type | SCALE_OUT |
scale_method required | string | Scale method | AMOUNT |
name required | string | Policy name | policy-name |
metric_type required | string | Metric type | CPU |
metric_method required | string | Metric method | AVG |
evaluation_minutes required | integer | Evaluation minutes | 1 |
cooldown_seconds required | integer | Cooldown seconds | 300 |
comparison_operator required | string | Comparison operator | ge |
Responses
| Name | Description | Example |
|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| auto_scaling_group_id | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| comparison_operator | Comparison operator | ge |
| cooldown_seconds | Cooldown seconds | 300 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| evaluation_minutes | Evaluation minutes | 1 |
| metric_method | Metric method | AVG |
| metric_type | Metric type | CPU |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Policy name | policy-name |
| scale_method | Scale method | AMOUNT |
| scale_type | Scale type | SCALE_OUT |
| scale_value | Scale value | 10 |
| state | Policy state | ACTIVE |
| threshold | Threshold | 60 |
| threshold_unit | Threshold unit | % |
1.9 - Create Auto-Scaling Group Schedule
1.9.1 - 1.1
scpcli virtualserver auto scaling group schedule create
--auto_scaling_group_id <value>
--timezone <value>
--start_date <value>
--name <value>
--minute <value>
--hour <value>
--frequency <value>
[--day_of_month <value>]
[--day_of_week <value>]
[--description <value>]
[--desired_server_count <value>]
[--end_date <value>]
[--max_server_count <value>]
[--min_server_count <value>]
[--state <value>]
Description
Create Auto-Scaling Group schedule.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
timezone required | string | Timezone | Asia/Seoul |
start_date required | string | Start date | 2024-01-01 |
name required | string | Schedule name | schedulename |
minute required | integer | Minute | 0 |
hour required | integer | Hour | 9 |
frequency required | string | Frequency | WEEKLY |
day_of_month optional | string | Day of the month | -1,1 |
day_of_week optional | string | Day of the week | SU,SA |
description optional | string | Description | description |
desired_server_count optional | integer | Desired server count | 1 |
end_date optional | string | End date | 2025-01-01 |
max_server_count optional | integer | Max server count | 2 |
min_server_count optional | integer | Min server count | 1 |
state optional | string | Schedule state | ACTIVE |
Responses
| Name | Description | Example |
|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| day_of_month | Day of the month | -1,1 |
| day_of_week | Day of the week | SU,SA |
| description | Description | description |
| desired_server_count | Desired server count | 1 |
| end_date | End date | 2025-01-01 |
| frequency | Frequency | WEEKLY |
| hour | Hour | 9 |
| max_server_count | Max server count | 2 |
| min_server_count | Min server count | 1 |
| minute | Minute | 0 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Schedule name | schedulename |
| start_date | Start date | 2024-01-01 |
| state | Schedule state | ACTIVE |
| timezone | Timezone | Asia/Seoul |
1.9.2 - 1.0
scpcli virtualserver auto scaling group schedule create
--auto_scaling_group_id <value>
--timezone <value>
--start_date <value>
--name <value>
--minute <value>
--hour <value>
--frequency <value>
[--day_of_month <value>]
[--day_of_week <value>]
[--description <value>]
[--desired_server_count <value>]
[--end_date <value>]
[--max_server_count <value>]
[--min_server_count <value>]
[--state <value>]
Description
Create Auto-Scaling Group schedule.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
timezone required | string | Timezone | Asia/Seoul |
start_date required | string | Start date | 2024-01-01 |
name required | string | Schedule name | schedulename |
minute required | integer | Minute | 0 |
hour required | integer | Hour | 9 |
frequency required | string | Frequency | WEEKLY |
day_of_month optional | string | Day of the month | -1,1 |
day_of_week optional | string | Day of the week | SU,SA |
description optional | string | Description | description |
desired_server_count optional | integer | Desired server count | 1 |
end_date optional | string | End date | 2025-01-01 |
max_server_count optional | integer | Max server count | 2 |
min_server_count optional | integer | Min server count | 1 |
state optional | string | Schedule state | ACTIVE |
Responses
| Name | Description | Example |
|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| day_of_month | Day of the month | -1,1 |
| day_of_week | Day of the week | SU,SA |
| description | Description | description |
| desired_server_count | Desired server count | 1 |
| end_date | End date | 2025-01-01 |
| frequency | Frequency | WEEKLY |
| hour | Hour | 9 |
| max_server_count | Max server count | 2 |
| min_server_count | Min server count | 1 |
| minute | Minute | 0 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Schedule name | schedulename |
| start_date | Start date | 2024-01-01 |
| state | Schedule state | ACTIVE |
| timezone | Timezone | Asia/Seoul |
1.10 - Create Image
1.10.1 - 1.1
scpcli virtualserver image create
--url <value>
--os_distro <value>
--name <value>
[--container_format <value>]
[--disk_format <value>]
[--min_disk <value>]
[--min_ram <value>]
[--protected <value>]
[--tags <value>]
[--visibility <value>]
Description
Create Image.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
url required | string | Object Storage URL for Image file (only qcow2 format allowed) | https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2 |
os_distro required | string | OS distribution | alma |
name required | string | Image name | imagename |
container_format optional | string | Container format | bare |
disk_format optional | string | Disk format | qcow2 |
min_disk optional | integer | Minimum disk | 100 |
min_ram optional | integer | Minimum RAM | 0 |
protected optional | boolean | Protected | False |
tags optional | array | Tags | '{"key": "Key", "value": "Value"}' |
visibility optional | string | Visibility | private |
Responses
| Name | Description | Example |
|---|
| id | Image ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| checksum | Checksum | 7538e0fcb56e0e272cfd89eb384d6613 |
| container_format | Container format | bare |
| created_at | Created at | 2025-07-22T09:00:00Z |
| disk_format | Disk format | qcow2 |
| file | File | /v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file |
| min_disk | Minimum disk | 100 |
| min_ram | Minimum RAM | 0 |
| name | Image name | imagename |
| os_distro | OS distribution | alma |
| os_hash_algo | OS hash algorithm | sha512 |
| os_hash_value | OS hash value | c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99 |
| os_hidden | OS hidden | False |
| owner | Owner account ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| owner_account_name | Owner account name | AccountName |
| owner_user_name | Owner user name | user@samsung.com |
| protected | Protected | False |
| root_device_name | Root device name | /dev/vda |
| scp_image_type | Image type | custom |
| scp_k8s_version | K8S version | v1.28.7 |
| scp_original_image_type | Original Image type | standard |
| scp_os_build_version | OS build version | 20250101 |
| scp_os_version | OS version | 8.8 |
| size | Size | 2429747200 |
| status | Status | active |
| updated_at | Updated at | 2025-07-26T12:00:00Z |
| url | Object Storage URL for Image file (only qcow2 format allowed) | https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2 |
| virtual_size | Virtual size | 17179869184 |
| visibility | Visibility | private |
| volumes | Volumes | [{“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}] |
1.10.2 - 1.0
scpcli virtualserver image create
--url <value>
--os_distro <value>
--name <value>
[--container_format <value>]
[--disk_format <value>]
[--min_disk <value>]
[--min_ram <value>]
[--protected <value>]
[--tags <value>]
[--visibility <value>]
Description
Create Image.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
url required | string | Object Storage URL for Image file (only qcow2 format allowed) | https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2 |
os_distro required | string | OS distribution | alma |
name required | string | Image name | imagename |
container_format optional | string | Container format | bare |
disk_format optional | string | Disk format | qcow2 |
min_disk optional | integer | Minimum disk | 100 |
min_ram optional | integer | Minimum RAM | 0 |
protected optional | boolean | Protected | False |
tags optional | array | Tags | '{"key": "Key", "value": "Value"}' |
visibility optional | string | Visibility | private |
Responses
| Name | Description | Example |
|---|
| id | Image ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| checksum | Checksum | 7538e0fcb56e0e272cfd89eb384d6613 |
| container_format | Container format | bare |
| created_at | Created at | 2025-07-22T09:00:00Z |
| disk_format | Disk format | qcow2 |
| file | File | /v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file |
| min_disk | Minimum disk | 100 |
| min_ram | Minimum RAM | 0 |
| name | Image name | imagename |
| os_distro | OS distribution | alma |
| os_hash_algo | OS hash algorithm | sha512 |
| os_hash_value | OS hash value | c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99 |
| os_hidden | OS hidden | False |
| owner | Owner account ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| owner_account_name | Owner account name | AccountName |
| owner_user_name | Owner user name | user@samsung.com |
| protected | Protected | False |
| root_device_name | Root device name | /dev/vda |
| scp_image_type | Image type | custom |
| scp_k8s_version | K8S version | v1.28.7 |
| scp_original_image_type | Original Image type | standard |
| scp_os_build_version | OS build version | 20250101 |
| scp_os_version | OS version | 8.8 |
| size | Size | 2429747200 |
| status | Status | active |
| updated_at | Updated at | 2025-07-26T12:00:00Z |
| url | Object Storage URL for Image file (only qcow2 format allowed) | https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2 |
| virtual_size | Virtual size | 17179869184 |
| visibility | Visibility | private |
| volumes | Volumes | [{“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}] |
1.11 - Create Image member
1.11.1 - 1.1
scpcli virtualserver image add member
--image_id <value>
--member_id <value>
Description
Create Image member.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
image_id required | string | Image ID | 70a599e0-31e7-49b7-b260-868f441e862b |
member_id required | string | Member ID | a8f10467abfc4b87b64614ab36eb9ae4 |
Responses
| Name | Description | Example |
|---|
| created_at | Created at | 2025-07-22T09:00:00Z |
| image_id | Image ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| member_id | Member ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| status | Member status | pending |
| updated_at | Updated at | 2025-07-26T12:00:00Z |
1.11.2 - 1.0
scpcli virtualserver image add member
--image_id <value>
--member_id <value>
Description
Create Image member.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
image_id required | string | Image ID | 70a599e0-31e7-49b7-b260-868f441e862b |
member_id required | string | Member ID | a8f10467abfc4b87b64614ab36eb9ae4 |
Responses
| Name | Description | Example |
|---|
| created_at | Created at | 2025-07-22T09:00:00Z |
| image_id | Image ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| member_id | Member ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| status | Member status | pending |
| updated_at | Updated at | 2025-07-26T12:00:00Z |
1.12 - Create Keypair
1.12.1 - 1.1
scpcli virtualserver keypair create
--name <value>
[--public_key <value>]
[--tags <value>]
Description
Create keypair.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
name required | string | Keypair name | keypairname |
public_key optional | string | Public Key | publickey |
tags optional | array | Tags | '{"key": "Key", "value": "Value"}' |
Responses
| Name | Description | Example |
|---|
| fingerprint | Fingerprint | 7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd |
| name | Keypair name | keypairname |
| private_key | Private key | privatekey |
| public_key | Public Key | publickey |
| type | Keypair type | ssh |
1.12.2 - 1.0
scpcli virtualserver keypair create
--name <value>
[--public_key <value>]
[--tags <value>]
Description
Create keypair.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
name required | string | Keypair name | keypairname |
public_key optional | string | Public Key | publickey |
tags optional | array | Tags | '{"key": "Key", "value": "Value"}' |
Responses
| Name | Description | Example |
|---|
| fingerprint | Fingerprint | 7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd |
| name | Keypair name | keypairname |
| private_key | Private key | privatekey |
| public_key | Public Key | publickey |
| type | Keypair type | ssh |
1.13 - Create Launch Configuration
1.13.1 - 1.1
scpcli virtualserver launch configuration create
--server_type_id <value>
--name <value>
--keypair_name <value>
--image_id <value>
[--tags <value>]
[--user_data <value>]
[--volumes <value>]
Description
Create Launch Configuration.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
server_type_id required | string | Server type ID | s1v1m2 |
name required | string | Launch Configuration name | launch-configuration-name |
keypair_name required | string | Keypair name | keypairname |
image_id required | string | Image ID | 70a599e0-31e7-49b7-b260-868f441e862b |
tags optional | array | Tags | '{"key": "Key", "value": "Value"}' |
user_data optional | string | User data | IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg== |
volumes optional | array | Volumes | '{"boot_index": 0, "size": 104, "type": "SSD"}' |
Responses
| Name | Description | Example |
|---|
| boot_index | Boot index | 0 |
| size | Volume size | 104 |
| type | Volume type | SSD |
1.13.2 - 1.0
scpcli virtualserver launch configuration create
--server_type_id <value>
--name <value>
--keypair_name <value>
--image_id <value>
[--tags <value>]
[--user_data <value>]
[--volumes <value>]
Description
Create Launch Configuration.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
server_type_id required | string | Server type ID | s1v1m2 |
name required | string | Launch Configuration name | launch-configuration-name |
keypair_name required | string | Keypair name | keypairname |
image_id required | string | Image ID | 70a599e0-31e7-49b7-b260-868f441e862b |
tags optional | array | Tags | '{"key": "Key", "value": "Value"}' |
user_data optional | string | User data | IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg== |
volumes optional | array | Volumes | '{"boot_index": 0, "size": 104, "type": "SSD"}' |
Responses
| Name | Description | Example |
|---|
| boot_index | Boot index | 0 |
| size | Volume size | 104 |
| type | Volume type | SSD |
1.14 - Create Server Group
1.14.1 - 1.1
scpcli virtualserver server group create
--policy <value>
--name <value>
[--tags <value>]
Description
Create server group.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
policy required | string | Server Group policy | anti-affinity |
name required | string | Server Group name | server-group |
tags optional | array | Tags | '{"key": "Key", "value": "Value"}' |
Responses
| Name | Description | Example |
|---|
| id | Server Group ID | 616fb98f-46ca-475e-917e-2563e5a8cd19 |
| account_id | Account ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| members | Server Group members | [‘2a9be312-5d4b-4bc8-b2ae-35100fa9241f’] |
| name | Server Group name | server-group |
| partition_size | Partition Size | 3 |
| policy | Server Group policy | anti-affinity |
| user_id | User ID | 570907805e5447be84b618450ef52o0t |
1.14.2 - 1.0
scpcli virtualserver server group create
--policy <value>
--name <value>
[--tags <value>]
Description
Create server group.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
policy required | string | Server Group policy | anti-affinity |
name required | string | Server Group name | server-group |
tags optional | array | Tags | '{"key": "Key", "value": "Value"}' |
Responses
| Name | Description | Example |
|---|
| id | Server Group ID | 616fb98f-46ca-475e-917e-2563e5a8cd19 |
| account_id | Account ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| members | Server Group members | [‘2a9be312-5d4b-4bc8-b2ae-35100fa9241f’] |
| name | Server Group name | server-group |
| partition_size | Partition Size | 3 |
| policy | Server Group policy | anti-affinity |
| user_id | User ID | 570907805e5447be84b618450ef52o0t |
1.15 - Create Server Interface
1.15.1 - 1.1
scpcli virtualserver server add interface
--server_id <value>
[--fixed_ips <value>]
[--port_id <value>]
[--subnet_id <value>]
Description
Create Server Interface.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
fixed_ips optional | array | Fixed Ip list | '{"ip_address": "192.169.3.2"}' |
port_id optional | string | Port ID | 91424c08-0b26-49fb-9808-ed042292ceef |
subnet_id optional | string | Subnet ID | 78b2ee3f074145c580ab6abac4821f97 |
Responses
| Name | Description | Example |
|---|
| ip_address | IP address | 192.169.3.2 |
1.15.2 - 1.0
scpcli virtualserver server add interface
--server_id <value>
[--fixed_ips <value>]
[--port_id <value>]
[--subnet_id <value>]
Description
Create Server Interface.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
fixed_ips optional | array | Fixed Ip list | '{"ip_address": "192.169.3.2"}' |
port_id optional | string | Port ID | 91424c08-0b26-49fb-9808-ed042292ceef |
subnet_id optional | string | Subnet ID | 78b2ee3f074145c580ab6abac4821f97 |
Responses
| Name | Description | Example |
|---|
| ip_address | IP address | 192.169.3.2 |
1.16 - Create Server Interface Nat
1.16.1 - 1.1
scpcli virtualserver server interface add static nat
--port_id <value>
--server_id <value>
--publicip_id <value>
Description
Create Server Interface Nat.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
port_id required | string | Port ID | 91424c08-0b26-49fb-9808-ed042292ceef |
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
publicip_id required | string | Public IP ID | 615fa9cd5cff486c9de679b3ce63e601 |
Responses
1.16.2 - 1.0
scpcli virtualserver server interface add static nat
--port_id <value>
--server_id <value>
--publicip_id <value>
Description
Create Server Interface Nat.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
port_id required | string | Port ID | 91424c08-0b26-49fb-9808-ed042292ceef |
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
publicip_id required | string | Public IP ID | 615fa9cd5cff486c9de679b3ce63e601 |
Responses
1.17 - Create Server Interface Private Nat
1.17.1 - 1.1
scpcli virtualserver server interface add private static nat
--port_id <value>
--server_id <value>
--private_nat_ip_id <value>
--private_nat_id <value>
Description
Create Server Interface Private Nat.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
port_id required | string | Port ID | 91424c08-0b26-49fb-9808-ed042292ceef |
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
private_nat_ip_id required | string | Private NAT IP ID | 1f0cb5390c40483592ddc5a282f53496 |
private_nat_id required | string | Private NAT ID | 3a6c1dc6b1b24e02a444d672c2798a1c |
Responses
1.17.2 - 1.0
scpcli virtualserver server interface add private static nat
--port_id <value>
--server_id <value>
--private_nat_ip_id <value>
--private_nat_id <value>
Description
Create Server Interface Private Nat.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
port_id required | string | Port ID | 91424c08-0b26-49fb-9808-ed042292ceef |
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
private_nat_ip_id required | string | Private NAT IP ID | 1f0cb5390c40483592ddc5a282f53496 |
private_nat_id required | string | Private NAT ID | 3a6c1dc6b1b24e02a444d672c2798a1c |
Responses
1.18 - Create Server Volume
1.18.1 - 1.1
scpcli virtualserver server add volume
--server_id <value>
--volume_id <value>
[--delete_on_termination <value>]
[--device <value>]
Description
Create Server Volume.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
volume_id required | string | Volume ID | - |
delete_on_termination optional | boolean | Delete on termination | False |
device optional | string | Device name | /dev/vda |
Responses
| Name | Description | Example |
|---|
| id | Volume Attachment ID | 3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c |
| delete_on_termination | Delete on termination | False |
| device | Device name | /dev/vda |
| server_id | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| volume_id | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
1.18.2 - 1.0
scpcli virtualserver server add volume
--server_id <value>
--volume_id <value>
[--delete_on_termination <value>]
[--device <value>]
Description
Create Server Volume.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
volume_id required | string | Volume ID | - |
delete_on_termination optional | boolean | Delete on termination | False |
device optional | string | Device name | /dev/vda |
Responses
| Name | Description | Example |
|---|
| id | Volume Attachment ID | 3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c |
| delete_on_termination | Delete on termination | False |
| device | Device name | /dev/vda |
| server_id | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| volume_id | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
1.19 - Create Sharing Image
1.19.1 - 1.1
scpcli virtualserver sharing image create
--image_id <value>
Description
Create Sharing Image.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
image_id required | string | Image ID | 70a599e0-31e7-49b7-b260-868f441e862b |
Responses
1.19.2 - 1.0
scpcli virtualserver sharing image create
--image_id <value>
Description
Create Sharing Image.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
image_id required | string | Image ID | 70a599e0-31e7-49b7-b260-868f441e862b |
Responses
1.20 - Create Virtual Server
1.20.1 - 1.1
scpcli virtualserver server create
--server_type_id <value>
--networks <value>
--name <value>
--keypair_name <value>
--image_id <value>
[--lock <value>]
[--max_count <value>]
[--metadata <value>]
[--partition_number <value>]
[--product_category <value>]
[--product_offering <value>]
[--security_groups <value>]
[--server_group_id <value>]
[--tags <value>]
[--user_data <value>]
[--volumes <value>]
Description
Create Virtual Server.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
server_type_id required | string | Server type ID | s1v1m2 |
networks required | array | List of Network | '{"fixed_ip": "192.169.3.2", "port_id": "91424c08-0b26-49fb-9808-ed042292ceef", "public_ip_id": "615fa9cd5cff486c9de679b3ce63e601", "subnet_id": "78b2ee3f074145c580ab6abac4821f97"}' |
name required | string | Server name | servername |
keypair_name required | string | Keypair name | keypairname |
image_id required | string | Image ID | 70a599e0-31e7-49b7-b260-868f441e862b |
lock optional | boolean | Locked | False |
max_count optional | integer | Max count | 2 |
metadata optional | object | Metadata | - |
partition_number optional | integer | Partition number | 1 |
product_category optional | **** | Product category | compute |
product_offering optional | **** | Product offering | virtual_server |
security_groups optional | array | Security Groups | [ |
server_group_id optional | string | Server Group ID | 616fb98f-46ca-475e-917e-2563e5a8cd19 |
tags optional | array | Tags | '{"key": "Key", "value": "Value"}' |
user_data optional | string | User data | IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg== |
volumes optional | array | Volumes | '{"boot_index": 0, "delete_on_termination": false, "size": 104, "source_type": "image", "type": "SSD"}' |
Responses
| Name | Description | Example |
|---|
| id | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
1.20.2 - 1.0
scpcli virtualserver server create
--server_type_id <value>
--networks <value>
--name <value>
--keypair_name <value>
--image_id <value>
[--lock <value>]
[--max_count <value>]
[--metadata <value>]
[--partition_number <value>]
[--product_category <value>]
[--product_offering <value>]
[--security_groups <value>]
[--server_group_id <value>]
[--tags <value>]
[--user_data <value>]
[--volumes <value>]
Description
Create Virtual Server.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
server_type_id required | string | Server type ID | s1v1m2 |
networks required | array | List of Network | '{"fixed_ip": "192.169.3.2", "port_id": "91424c08-0b26-49fb-9808-ed042292ceef", "public_ip_id": "615fa9cd5cff486c9de679b3ce63e601", "subnet_id": "78b2ee3f074145c580ab6abac4821f97"}' |
name required | string | Server name | servername |
keypair_name required | string | Keypair name | keypairname |
image_id required | string | Image ID | 70a599e0-31e7-49b7-b260-868f441e862b |
lock optional | boolean | Locked | False |
max_count optional | integer | Max count | 2 |
metadata optional | object | Metadata | - |
partition_number optional | integer | Partition number | 1 |
product_category optional | **** | Product category | compute |
product_offering optional | **** | Product offering | virtual_server |
security_groups optional | array | Security Groups | [ |
server_group_id optional | string | Server Group ID | 616fb98f-46ca-475e-917e-2563e5a8cd19 |
tags optional | array | Tags | '{"key": "Key", "value": "Value"}' |
user_data optional | string | User data | IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg== |
volumes optional | array | Volumes | '{"boot_index": 0, "delete_on_termination": false, "size": 104, "source_type": "image", "type": "SSD"}' |
Responses
| Name | Description | Example |
|---|
| id | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
1.21 - Create Virtual Server Custom Image
1.21.1 - 1.1
scpcli virtualserver server image create
--server_id <value>
--image_name <value>
Description
Create Virtual Server Custom Image.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
image_name required | string | Image name | imagename |
Responses
| Name | Description | Example |
|---|
| image_id | Image ID | 70a599e0-31e7-49b7-b260-868f441e862b |
1.21.2 - 1.0
scpcli virtualserver server image create
--server_id <value>
--image_name <value>
Description
Create Virtual Server Custom Image.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
image_name required | string | Image name | imagename |
Responses
| Name | Description | Example |
|---|
| image_id | Image ID | 70a599e0-31e7-49b7-b260-868f441e862b |
1.22 - Create Virtual Server Dump
1.22.1 - 1.1
scpcli virtualserver server dump create
--server_id <value>
Description
Create Virtual Server Dump.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
1.22.2 - 1.0
scpcli virtualserver server dump create
--server_id <value>
Description
Create Virtual Server Dump.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
1.23 - Create Volume
1.23.1 - 1.1
scpcli virtualserver volume create
--size <value>
--name <value>
[--snapshot_id <value>]
[--tags <value>]
[--volume_type <value>]
Description
Create a Volume.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
size required | integer | Volume size | 104 |
name required | string | Volume name | volume01 |
snapshot_id optional | string | Snapshot ID | cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 |
tags optional | array | Tags | '{"key": "Key", "value": "Value"}' |
volume_type optional | string | Volume type | SSD |
Responses
| Name | Description | Example |
|---|
| id | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| attached_at | The time when the volume was attached to the server. | |
| device | Device name | /dev/vda |
1.23.2 - 1.0
scpcli virtualserver volume create
--size <value>
--name <value>
[--snapshot_id <value>]
[--tags <value>]
[--volume_type <value>]
Description
Create a Volume.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
size required | integer | Volume size | 104 |
name required | string | Volume name | volume01 |
snapshot_id optional | string | Snapshot ID | cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 |
tags optional | array | Tags | '{"key": "Key", "value": "Value"}' |
volume_type optional | string | Volume type | SSD |
Responses
| Name | Description | Example |
|---|
| id | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| attached_at | The time when the volume was attached to the server. | |
| device | Device name | /dev/vda |
1.24 - Delete a snapshot
1.24.1 - 1.1
scpcli virtualserver volume snapshot delete
--snapshot_id <value>
Description
Delete a snapshot.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
snapshot_id required | string | Snapshot ID | cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 |
1.24.2 - 1.0
scpcli virtualserver volume snapshot delete
--snapshot_id <value>
Description
Delete a snapshot.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
snapshot_id required | string | Snapshot ID | cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 |
1.25 - Delete a volume transfer
1.25.1 - 1.1
scpcli virtualserver volume transfer delete
--transfer_id <value>
Description
Delete a volume transfer.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
transfer_id required | string | Transfer ID | 1ac231be-823b-4a4d-8ff0-aac503a7118a |
1.25.2 - 1.0
scpcli virtualserver volume transfer delete
--transfer_id <value>
Description
Delete a volume transfer.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
transfer_id required | string | Transfer ID | 1ac231be-823b-4a4d-8ff0-aac503a7118a |
1.26 - Delete Auto-Scaling Group
1.26.1 - 1.1
scpcli virtualserver auto scaling group delete
--auto_scaling_group_id <value>
Description
Delete Auto-Scaling Group.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
1.26.2 - 1.0
scpcli virtualserver auto scaling group delete
--auto_scaling_group_id <value>
Description
Delete Auto-Scaling Group.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
1.27 - Delete Auto-Scaling Group Notification
1.27.1 - 1.1
scpcli virtualserver auto scaling group notification delete
--notification_id <value>
--auto_scaling_group_id <value>
Description
Delete Auto-Scaling Group notification.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
notification_id required | string | Notification ID | fa7fd191410744cd810a290c0b4d22b9 |
auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
1.27.2 - 1.0
scpcli virtualserver auto scaling group notification delete
--notification_id <value>
--auto_scaling_group_id <value>
Description
Delete Auto-Scaling Group notification.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
notification_id required | string | Notification ID | fa7fd191410744cd810a290c0b4d22b9 |
auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
1.28 - Delete Auto-Scaling Group Policy
1.28.1 - 1.1
scpcli virtualserver auto scaling group policy delete
--policy_id <value>
--auto_scaling_group_id <value>
Description
Delete Auto-Scaling Group policy.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
policy_id required | string | Policy ID | 0761d76085f54363bab07909baf69841 |
auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
1.28.2 - 1.0
scpcli virtualserver auto scaling group policy delete
--policy_id <value>
--auto_scaling_group_id <value>
Description
Delete Auto-Scaling Group policy.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
policy_id required | string | Policy ID | 0761d76085f54363bab07909baf69841 |
auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
1.29 - Delete Auto-Scaling Group Schedule
1.29.1 - 1.1
scpcli virtualserver auto scaling group schedule delete
--schedule_id <value>
--auto_scaling_group_id <value>
Description
Delete Auto-Scaling Group schedule.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
schedule_id required | string | Schedule ID | 43d4841abd404220af5f0904037aba71 |
auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
1.29.2 - 1.0
scpcli virtualserver auto scaling group schedule delete
--schedule_id <value>
--auto_scaling_group_id <value>
Description
Delete Auto-Scaling Group schedule.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
schedule_id required | string | Schedule ID | 43d4841abd404220af5f0904037aba71 |
auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
1.30 - Delete Image
1.30.1 - 1.1
scpcli virtualserver image delete
--image_id <value>
Description
Delete Image.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
image_id required | string | Image ID | 70a599e0-31e7-49b7-b260-868f441e862b |
1.30.2 - 1.0
scpcli virtualserver image delete
--image_id <value>
Description
Delete Image.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
image_id required | string | Image ID | 70a599e0-31e7-49b7-b260-868f441e862b |
1.31 - Delete Image member
1.31.1 - 1.1
scpcli virtualserver image remove member
--member_id <value>
--image_id <value>
Description
Delete Image member.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
member_id required | string | Member ID | a8f10467abfc4b87b64614ab36eb9ae4 |
image_id required | string | Image ID | 70a599e0-31e7-49b7-b260-868f441e862b |
1.31.2 - 1.0
scpcli virtualserver image remove member
--member_id <value>
--image_id <value>
Description
Delete Image member.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
member_id required | string | Member ID | a8f10467abfc4b87b64614ab36eb9ae4 |
image_id required | string | Image ID | 70a599e0-31e7-49b7-b260-868f441e862b |
1.32 - Delete Keypair
1.32.1 - 1.1
scpcli virtualserver keypair delete
--keypair_name <value>
Description
Delete keypair.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
keypair_name required | string | Keypair name | keypairname |
1.32.2 - 1.0
scpcli virtualserver keypair delete
--keypair_name <value>
Description
Delete keypair.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
keypair_name required | string | Keypair name | keypairname |
1.33 - Delete Launch Configuration
1.33.1 - 1.1
scpcli virtualserver launch configuration delete
--launch_configuration_id <value>
Description
Delete Launch Configuration.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
launch_configuration_id required | string | Launch Configuration ID | b5aea5a675fc4f6b9e0fcd1288354c5f |
1.33.2 - 1.0
scpcli virtualserver launch configuration delete
--launch_configuration_id <value>
Description
Delete Launch Configuration.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
launch_configuration_id required | string | Launch Configuration ID | b5aea5a675fc4f6b9e0fcd1288354c5f |
1.34 - Delete Server Group
1.34.1 - 1.1
scpcli virtualserver server group delete
--server_group_id <value>
Description
Delete server group
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
server_group_id required | string | Server Group ID | 616fb98f-46ca-475e-917e-2563e5a8cd19 |
1.34.2 - 1.0
scpcli virtualserver server group delete
--server_group_id <value>
Description
Delete server group
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
server_group_id required | string | Server Group ID | 616fb98f-46ca-475e-917e-2563e5a8cd19 |
1.35 - Delete Server Interface
1.35.1 - 1.1
scpcli virtualserver server remove interface
--port_id <value>
--server_id <value>
Description
Delete Server Interface.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
port_id required | string | Port ID | 91424c08-0b26-49fb-9808-ed042292ceef |
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
1.35.2 - 1.0
scpcli virtualserver server remove interface
--port_id <value>
--server_id <value>
Description
Delete Server Interface.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
port_id required | string | Port ID | 91424c08-0b26-49fb-9808-ed042292ceef |
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
1.36 - Delete Server Interface Nat
1.36.1 - 1.1
scpcli virtualserver server interface remove static nat
--nat_id <value>
--port_id <value>
--server_id <value>
Description
Delete Server Interface Nat.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
nat_id required | string | NAT ID | 224b80106e6f41b38efe98ac9ddbf280 |
port_id required | string | Port ID | 91424c08-0b26-49fb-9808-ed042292ceef |
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
1.36.2 - 1.0
scpcli virtualserver server interface remove static nat
--nat_id <value>
--port_id <value>
--server_id <value>
Description
Delete Server Interface Nat.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
nat_id required | string | NAT ID | 224b80106e6f41b38efe98ac9ddbf280 |
port_id required | string | Port ID | 91424c08-0b26-49fb-9808-ed042292ceef |
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
1.37 - Delete Server Interface Private Nat
1.37.1 - 1.1
scpcli virtualserver server interface remove private static nat
--nat_id <value>
--port_id <value>
--server_id <value>
Description
Delete Server Interface Private Nat.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
nat_id required | string | NAT ID | 224b80106e6f41b38efe98ac9ddbf280 |
port_id required | string | Port ID | 91424c08-0b26-49fb-9808-ed042292ceef |
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
1.37.2 - 1.0
scpcli virtualserver server interface remove private static nat
--nat_id <value>
--port_id <value>
--server_id <value>
Description
Delete Server Interface Private Nat.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
nat_id required | string | NAT ID | 224b80106e6f41b38efe98ac9ddbf280 |
port_id required | string | Port ID | 91424c08-0b26-49fb-9808-ed042292ceef |
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
1.38 - Delete Server Volume
1.38.1 - 1.1
scpcli virtualserver server remove volume
--volume_id <value>
--server_id <value>
Description
Delete Server Volume.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
1.38.2 - 1.0
scpcli virtualserver server remove volume
--volume_id <value>
--server_id <value>
Description
Delete Server Volume.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
1.39 - Delete Virtual Server
1.39.1 - 1.1
scpcli virtualserver server delete
--server_id <value>
Description
Delete Virtual Server.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
1.39.2 - 1.0
scpcli virtualserver server delete
--server_id <value>
Description
Delete Virtual Server.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
1.40 - Delete Volume
1.40.1 - 1.1
scpcli virtualserver volume delete
--volume_id <value>
[--cascade <value>]
Description
Delete a Volume.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
cascade optional | boolean | Whether to delete snapshots together | True |
1.40.2 - 1.0
scpcli virtualserver volume delete
--volume_id <value>
[--cascade <value>]
Description
Delete a Volume.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
cascade optional | boolean | Whether to delete snapshots together | True |
1.41 - Detach Virtual Server Security Group
1.41.1 - 1.0
scpcli virtualserver server remove security group
--security_group_id <value>
--server_id <value>
Description
Detach Virtual Server Security Group
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
security_group_id required | string | Security Group ID | c09c3f05-03d9-443f-b27a-40e0f973c75f |
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
1.42 - Detach Volume from Virtual Server
1.42.1 - 1.1
scpcli virtualserver volume detach server
--server_id <value>
--volume_id <value>
Description
Detach Volume from Virtual Server.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
volume_id required | string | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
1.42.2 - 1.0
scpcli virtualserver volume detach server
--server_id <value>
--volume_id <value>
Description
Detach Volume from Virtual Server.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
volume_id required | string | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
1.43 - Extend Volume
1.43.1 - 1.1
scpcli virtualserver volume resize
--volume_id <value>
--size <value>
Description
Extend a Volume.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
size required | integer | Volume size | 104 |
1.43.2 - 1.0
scpcli virtualserver volume resize
--volume_id <value>
--size <value>
Description
Extend a Volume.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
size required | integer | Volume size | 104 |
1.44 - Get region's maximum partition size.
1.44.1 - 1.1
scpcli virtualserver server group maximum partition size
Description
Get region’s maximum partition size
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Responses
| Name | Description | Example |
|---|
| partition_size | | |
1.44.2 - 1.0
scpcli virtualserver server group maximum partition size
Description
Get region’s maximum partition size
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Responses
| Name | Description | Example |
|---|
| partition_size | | |
1.45 - Import Image
1.45.1 - 1.1
scpcli virtualserver image import
--image_id <value>
--url <value>
Description
Import Image file.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
image_id required | string | Image ID | 70a599e0-31e7-49b7-b260-868f441e862b |
url required | string | Object Storage URL for Image file (only qcow2 format allowed) | https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2 |
Responses
1.45.2 - 1.0
scpcli virtualserver image import
--image_id <value>
--url <value>
Description
Import Image file.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
image_id required | string | Image ID | 70a599e0-31e7-49b7-b260-868f441e862b |
url required | string | Object Storage URL for Image file (only qcow2 format allowed) | https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2 |
Responses
1.46 - List Auto-Scaling Group LB Server Groups
1.46.1 - 1.1
scpcli virtualserver auto scaling group lb server group list
--auto_scaling_group_id <value>
[--offset <value>]
[--limit <value>]
[--sort <value>]
Description
List Auto-Scaling Group LB Server Groups.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
offset optional | integer | Index of where to start in the list | 0 |
limit optional | integer | Page size of items | 20 |
sort optional | string | Comma-separated list of sort keys and optional sort directions in the form of [:] | created_at:desc |
Responses
| Name | Description | Example |
|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | LB Server Group name | lb-server-group-name |
| port | LB Server Group port | 8080 |
1.46.2 - 1.0
scpcli virtualserver auto scaling group lb server group list
--auto_scaling_group_id <value>
[--offset <value>]
[--limit <value>]
[--sort <value>]
Description
List Auto-Scaling Group LB Server Groups.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
offset optional | integer | Index of where to start in the list | 0 |
limit optional | integer | Page size of items | 20 |
sort optional | string | Comma-separated list of sort keys and optional sort directions in the form of [:] | created_at:desc |
Responses
| Name | Description | Example |
|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | LB Server Group name | lb-server-group-name |
| port | LB Server Group port | 8080 |
1.47 - List Auto-Scaling Group Notifications
1.47.1 - 1.1
scpcli virtualserver auto scaling group notification list
--auto_scaling_group_id <value>
[--user_ids <value>]
[--notification_state <value>]
[--notification_event <value>]
[--offset <value>]
[--limit <value>]
[--sort <value>]
Description
List Auto-Scaling Group notifications.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
user_ids optional | array | User ID list | 570907805e5447be84b618450ef52o0t |
notification_state optional | string | Auto-Scaling Group notification state | ACTIVE |
notification_event optional | string | Auto-Scaling Group notification event | SCALE_OUT |
offset optional | integer | Index of where to start in the list | 0 |
limit optional | integer | Page size of items | 20 |
sort optional | string | Comma-separated list of sort keys and optional sort directions in the form of [:] | created_at:desc |
Responses
| Name | Description | Example |
|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| auto_scaling_group_id | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| notification_events | Auto-Scaling Group notification events | [‘SCALE_OUT’, ‘SCALE_OUT_FAIL’] |
| notification_state | Auto-Scaling Group notification state | ACTIVE |
| user_id | User ID | 570907805e5447be84b618450ef52o0t |
| user_name | User name | scpuser |
1.47.2 - 1.0
scpcli virtualserver auto scaling group notification list
--auto_scaling_group_id <value>
[--user_ids <value>]
[--notification_state <value>]
[--notification_event <value>]
[--offset <value>]
[--limit <value>]
[--sort <value>]
Description
List Auto-Scaling Group notifications.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
user_ids optional | array | User ID list | 570907805e5447be84b618450ef52o0t |
notification_state optional | string | Auto-Scaling Group notification state | ACTIVE |
notification_event optional | string | Auto-Scaling Group notification event | SCALE_OUT |
offset optional | integer | Index of where to start in the list | 0 |
limit optional | integer | Page size of items | 20 |
sort optional | string | Comma-separated list of sort keys and optional sort directions in the form of [:] | created_at:desc |
Responses
| Name | Description | Example |
|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| auto_scaling_group_id | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| notification_events | Auto-Scaling Group notification events | [‘SCALE_OUT’, ‘SCALE_OUT_FAIL’] |
| notification_state | Auto-Scaling Group notification state | ACTIVE |
| user_id | User ID | 570907805e5447be84b618450ef52o0t |
| user_name | User name | scpuser |
1.48 - List Auto-Scaling Group Policies
1.48.1 - 1.1
scpcli virtualserver auto scaling group policy list
--auto_scaling_group_id <value>
[--name <value>]
[--metric_method <value>]
[--metric_type <value>]
[--scale_type <value>]
[--offset <value>]
[--limit <value>]
[--sort <value>]
Description
List Auto-Scaling Group policies.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
name optional | string | Policy name | policy-name |
metric_method optional | **** | Metric method | AVG |
metric_type optional | string | Metric type | CPU |
scale_type optional | **** | Scale type | SCALE_OUT |
offset optional | integer | Index of where to start in the list | 0 |
limit optional | integer | Page size of items | 20 |
sort optional | string | Comma-separated list of sort keys and optional sort directions in the form of [:] | created_at:desc |
Responses
| Name | Description | Example |
|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| auto_scaling_group_id | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| comparison_operator | Comparison operator | ge |
| cooldown_seconds | Cooldown seconds | 300 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| evaluation_minutes | Evaluation minutes | 1 |
| metric_method | Metric method | AVG |
| metric_type | Metric type | CPU |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Policy name | policy-name |
| scale_method | Scale method | AMOUNT |
| scale_type | Scale type | SCALE_OUT |
| scale_value | Scale value | 10 |
| state | Policy state | ACTIVE |
| threshold | Threshold | 60 |
| threshold_unit | Threshold unit | % |
1.48.2 - 1.0
scpcli virtualserver auto scaling group policy list
--auto_scaling_group_id <value>
[--name <value>]
[--metric_method <value>]
[--metric_type <value>]
[--scale_type <value>]
[--offset <value>]
[--limit <value>]
[--sort <value>]
Description
List Auto-Scaling Group policies.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
name optional | string | Policy name | policy-name |
metric_method optional | **** | Metric method | AVG |
metric_type optional | string | Metric type | CPU |
scale_type optional | **** | Scale type | SCALE_OUT |
offset optional | integer | Index of where to start in the list | 0 |
limit optional | integer | Page size of items | 20 |
sort optional | string | Comma-separated list of sort keys and optional sort directions in the form of [:] | created_at:desc |
Responses
| Name | Description | Example |
|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| auto_scaling_group_id | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| comparison_operator | Comparison operator | ge |
| cooldown_seconds | Cooldown seconds | 300 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| evaluation_minutes | Evaluation minutes | 1 |
| metric_method | Metric method | AVG |
| metric_type | Metric type | CPU |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Policy name | policy-name |
| scale_method | Scale method | AMOUNT |
| scale_type | Scale type | SCALE_OUT |
| scale_value | Scale value | 10 |
| state | Policy state | ACTIVE |
| threshold | Threshold | 60 |
| threshold_unit | Threshold unit | % |
1.49 - List Auto-Scaling Group Schedules
1.49.1 - 1.1
scpcli virtualserver auto scaling group schedule list
--auto_scaling_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--frequency <value>]
Description
Get Auto-Scaling Group schedule list.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
size optional | integer | size | 20 |
page optional | integer | page | 0 |
sort optional | string | sort | created_at:desc |
frequency optional | **** | Frequency | WEEKLY |
Responses
| Name | Description | Example |
|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| day_of_month | Day of the month | -1,1 |
| day_of_week | Day of the week | SU,SA |
| description | Description | description |
| desired_server_count | Desired server count | 1 |
| end_date | End date | 2025-01-01 |
| frequency | Frequency | WEEKLY |
| hour | Hour | 9 |
| max_server_count | Max server count | 2 |
| min_server_count | Min server count | 1 |
| minute | Minute | 0 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Schedule name | schedulename |
| start_date | Start date | 2024-01-01 |
| state | Schedule state | ACTIVE |
| timezone | Timezone | Asia/Seoul |
1.49.2 - 1.0
scpcli virtualserver auto scaling group schedule list
--auto_scaling_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--frequency <value>]
Description
Get Auto-Scaling Group schedule list.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
size optional | integer | size | 20 |
page optional | integer | page | 0 |
sort optional | string | sort | created_at:desc |
frequency optional | **** | Frequency | WEEKLY |
Responses
| Name | Description | Example |
|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| day_of_month | Day of the month | -1,1 |
| day_of_week | Day of the week | SU,SA |
| description | Description | description |
| desired_server_count | Desired server count | 1 |
| end_date | End date | 2025-01-01 |
| frequency | Frequency | WEEKLY |
| hour | Hour | 9 |
| max_server_count | Max server count | 2 |
| min_server_count | Min server count | 1 |
| minute | Minute | 0 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Schedule name | schedulename |
| start_date | Start date | 2024-01-01 |
| state | Schedule state | ACTIVE |
| timezone | Timezone | Asia/Seoul |
1.50 - List Auto-Scaling Group Virtual Servers
1.50.1 - 1.1
scpcli virtualserver auto scaling group server list
--auto_scaling_group_id <value>
[--marker <value>]
[--limit <value>]
[--sort <value>]
Description
List Auto-Scaling Group Virtual Servers.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
marker optional | string | The last item's ID from previous request | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
limit optional | integer | Page size of items | 20 |
sort optional | string | Comma-separated list of sort keys and optional sort directions in the form of [:] | created_at:desc |
Responses
| Name | Description | Example |
|---|
| id | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| account_id | Account ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| addresses | Addresses | |
| auto_scaling_group_id | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| created_at | Created at | |
| created_by | Created by | 97e6b22c9a4143789ca522df7457a32f |
| disk_config | Disk config | MANUAL |
| image_id | Image ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| is_marketplace | Is Marketplace | False |
| keypair_name | Keypair name | keypairname |
| launch_configuration_id | Launch Configuration ID | b5aea5a675fc4f6b9e0fcd1288354c5f |
| lb_linked_state | Load Balancer linked state | ATTACHED |
| locked | Locked | False |
| metadata | Metadata | |
| modified_at | Modified at | |
| name | Server name | servername |
| partition_number | Partition number | 1 |
| planned_compute_os_type | Planned Compute OS type | windows |
| product_category | Product category | compute |
| product_offering | Product offering | virtual_server |
| security_groups | Security Groups | |
| server_group_id | Server Group ID | 616fb98f-46ca-475e-917e-2563e5a8cd19 |
| server_type | Server type | |
| state | Server state | ACTIVE |
| volumes | Volumes | |
| vpc_id | VPC ID | cc976b621087484ea5fd527f4b78708b |
1.50.2 - 1.0
scpcli virtualserver auto scaling group server list
--auto_scaling_group_id <value>
[--marker <value>]
[--limit <value>]
[--sort <value>]
Description
List Auto-Scaling Group Virtual Servers.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
marker optional | string | The last item's ID from previous request | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
limit optional | integer | Page size of items | 20 |
sort optional | string | Comma-separated list of sort keys and optional sort directions in the form of [:] | created_at:desc |
Responses
| Name | Description | Example |
|---|
| id | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| account_id | Account ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| addresses | Addresses | |
| auto_scaling_group_id | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| created_at | Created at | |
| created_by | Created by | 97e6b22c9a4143789ca522df7457a32f |
| disk_config | Disk config | MANUAL |
| image_id | Image ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| is_marketplace | Is Marketplace | False |
| keypair_name | Keypair name | keypairname |
| launch_configuration_id | Launch Configuration ID | b5aea5a675fc4f6b9e0fcd1288354c5f |
| lb_linked_state | Load Balancer linked state | ATTACHED |
| locked | Locked | False |
| metadata | Metadata | |
| modified_at | Modified at | |
| name | Server name | servername |
| partition_number | Partition number | 1 |
| planned_compute_os_type | Planned Compute OS type | windows |
| product_category | Product category | compute |
| product_offering | Product offering | virtual_server |
| security_groups | Security Groups | |
| server_group_id | Server Group ID | 616fb98f-46ca-475e-917e-2563e5a8cd19 |
| server_type | Server type | |
| state | Server state | ACTIVE |
| volumes | Volumes | |
| vpc_id | VPC ID | cc976b621087484ea5fd527f4b78708b |
1.51 - List Auto-Scaling Groups
1.51.1 - 1.1
scpcli virtualserver auto scaling group list
[--name <value>]
[--state <value>]
[--launch_configuration_id <value>]
[--launch_configuration_name <value>]
[--lb_server_group_id <value>]
[--security_group_id <value>]
[--subnet_id <value>]
[--vpc_id <value>]
[--created_by <value>]
[--offset <value>]
[--limit <value>]
[--sort <value>]
[--long]
Description
List Auto-Scaling Groups.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
name optional | string | Auto-Scaling Group name | auto-scaling-group-name |
state optional | string | Auto-Scaling Group state | IN_SERVICE |
launch_configuration_id optional | string | Launch Configuration ID | b5aea5a675fc4f6b9e0fcd1288354c5f |
launch_configuration_name optional | string | Launch Configuration name | launch-configuration-name |
lb_server_group_id optional | string | LB Server Group ID | d06e87d3-ca9a-461b-8e88-077a542a7335 |
security_group_id optional | string | Security Group ID | c09c3f05-03d9-443f-b27a-40e0f973c75f |
subnet_id optional | string | Subnet ID | 78b2ee3f074145c580ab6abac4821f97 |
vpc_id optional | string | VPC ID | cc976b621087484ea5fd527f4b78708b |
created_by optional | string | Created by | 97e6b22c9a4143789ca522df7457a32f |
offset optional | integer | Index of where to start in the list | 0 |
limit optional | integer | Page size of items | 20 |
sort optional | string | Comma-separated list of sort keys and optional sort directions in the form of [:] | created_at:desc |
Responses
| Name | Description | Example |
|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID Requires --long option | a8f10467abfc4b87b64614ab36eb9ae4 |
| created_at | Created At Requires --long option | 2024-05-17T00:23:17Z |
| created_by | Created By Requires --long option | 90dddfc2b1e04edba54ba2b41539a9ac |
| desired_server_count | Desired server count | 1 |
| desired_server_count_editable | Desired server count editable Requires --long option | True |
| drain_enabled | Drain enabled Requires --long option | True |
| drain_timeout | Drain timeout Requires --long option | 300 |
| launch_configuration_id | Launch Configuration ID Requires --long option | b5aea5a675fc4f6b9e0fcd1288354c5f |
| launch_configuration_name | Launch Configuration name | launch-configuration-name |
| lb_server_groups | LB Server Group list Requires --long option | |
| max_server_count | Max server count | 2 |
| min_server_count | Min server count | 1 |
| modified_at | Modified At Requires --long option | 2024-05-17T00:23:17Z |
| modified_by | Modified By Requires --long option | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Auto-Scaling Group name | auto-scaling-group-name |
| security_group_ids | Security Group ID list Requires --long option | [‘c09c3f05-03d9-443f-b27a-40e0f973c75f’] |
| server_name_prefix | Server name prefix Requires --long option | server-name-prefix |
| state | Auto-Scaling Group state | IN_SERVICE |
| subnet_ids | Subnet ID list Requires --long option | |
| vpc_id | VPC ID Requires --long option | cc976b621087484ea5fd527f4b78708b |
1.51.2 - 1.0
scpcli virtualserver auto scaling group list
[--name <value>]
[--state <value>]
[--launch_configuration_id <value>]
[--launch_configuration_name <value>]
[--lb_server_group_id <value>]
[--security_group_id <value>]
[--subnet_id <value>]
[--vpc_id <value>]
[--created_by <value>]
[--offset <value>]
[--limit <value>]
[--sort <value>]
[--long]
Description
List Auto-Scaling Groups.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
name optional | string | Auto-Scaling Group name | auto-scaling-group-name |
state optional | string | Auto-Scaling Group state | IN_SERVICE |
launch_configuration_id optional | string | Launch Configuration ID | b5aea5a675fc4f6b9e0fcd1288354c5f |
launch_configuration_name optional | string | Launch Configuration name | launch-configuration-name |
lb_server_group_id optional | string | LB Server Group ID | d06e87d3-ca9a-461b-8e88-077a542a7335 |
security_group_id optional | string | Security Group ID | c09c3f05-03d9-443f-b27a-40e0f973c75f |
subnet_id optional | string | Subnet ID | 78b2ee3f074145c580ab6abac4821f97 |
vpc_id optional | string | VPC ID | cc976b621087484ea5fd527f4b78708b |
created_by optional | string | Created by | 97e6b22c9a4143789ca522df7457a32f |
offset optional | integer | Index of where to start in the list | 0 |
limit optional | integer | Page size of items | 20 |
sort optional | string | Comma-separated list of sort keys and optional sort directions in the form of [:] | created_at:desc |
Responses
| Name | Description | Example |
|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID Requires --long option | a8f10467abfc4b87b64614ab36eb9ae4 |
| created_at | Created At Requires --long option | 2024-05-17T00:23:17Z |
| created_by | Created By Requires --long option | 90dddfc2b1e04edba54ba2b41539a9ac |
| desired_server_count | Desired server count | 1 |
| desired_server_count_editable | Desired server count editable Requires --long option | True |
| drain_enabled | Drain enabled Requires --long option | True |
| drain_timeout | Drain timeout Requires --long option | 300 |
| launch_configuration_id | Launch Configuration ID Requires --long option | b5aea5a675fc4f6b9e0fcd1288354c5f |
| launch_configuration_name | Launch Configuration name | launch-configuration-name |
| lb_server_groups | LB Server Group list Requires --long option | |
| max_server_count | Max server count | 2 |
| min_server_count | Min server count | 1 |
| modified_at | Modified At Requires --long option | 2024-05-17T00:23:17Z |
| modified_by | Modified By Requires --long option | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Auto-Scaling Group name | auto-scaling-group-name |
| security_group_ids | Security Group ID list Requires --long option | [‘c09c3f05-03d9-443f-b27a-40e0f973c75f’] |
| server_name_prefix | Server name prefix Requires --long option | server-name-prefix |
| state | Auto-Scaling Group state | IN_SERVICE |
| subnet_ids | Subnet ID list Requires --long option | |
| vpc_id | VPC ID Requires --long option | cc976b621087484ea5fd527f4b78708b |
1.52 - List Default Configs
1.52.1 - 1.1
scpcli virtualserver default config list
[--name <value>]
[--category <value>]
Description
Get default config list.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
name optional | string | Name | key |
category optional | string | Category | AUTO_SCALING_GROUP |
Responses
| Name | Description | Example |
|---|
| configs | Configs | (‘key’: ‘value’} |
| count | count | 20 |
1.52.2 - 1.0
scpcli virtualserver default config list
[--name <value>]
[--category <value>]
Description
Get default config list.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
name optional | string | Name | key |
category optional | string | Category | AUTO_SCALING_GROUP |
Responses
| Name | Description | Example |
|---|
| configs | Configs | (‘key’: ‘value’} |
| count | count | 20 |
1.53 - List Image members
1.53.1 - 1.1
scpcli virtualserver image member list
--image_id <value>
Description
List Image members.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
image_id required | string | Image ID | 70a599e0-31e7-49b7-b260-868f441e862b |
Responses
| Name | Description | Example |
|---|
| created_at | Created at | 2025-07-22T09:00:00Z |
| image_id | Image ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| member_id | Member ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| status | Member status | pending |
| updated_at | Updated at | 2025-07-26T12:00:00Z |
1.53.2 - 1.0
scpcli virtualserver image member list
--image_id <value>
Description
List Image members.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
image_id required | string | Image ID | 70a599e0-31e7-49b7-b260-868f441e862b |
Responses
| Name | Description | Example |
|---|
| created_at | Created at | 2025-07-22T09:00:00Z |
| image_id | Image ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| member_id | Member ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| status | Member status | pending |
| updated_at | Updated at | 2025-07-26T12:00:00Z |
1.54 - List Images
1.54.1 - 1.1
scpcli virtualserver image list
[--limit <value>]
[--marker <value>]
[--scp_image_type <value>]
[--scp_original_image_type <value>]
[--name <value>]
[--os_distro <value>]
[--status <value>]
[--visibility <value>]
[--sort <value>]
[--long]
Description
List Images.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
limit optional | integer | Page size of items | 20 |
marker optional | string | The last item's ID from previous request | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
scp_image_type optional | string | Image type | custom |
scp_original_image_type optional | string | Original Image type | standard |
name optional | string | Image name | imagename |
os_distro optional | string | OS distribution | alma |
status optional | string | Status | active |
visibility optional | **** | Visibility | private |
sort optional | string | Comma-separated list of sort keys and optional sort directions in the form of [:] | created_at:desc |
Responses
| Name | Description | Example |
|---|
| id | Image ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| checksum | Checksum Requires --long option | 7538e0fcb56e0e272cfd89eb384d6613 |
| container_format | Container format Requires --long option | bare |
| created_at | Created at | 2025-07-22T09:00:00Z |
| disk_format | Disk format Requires --long option | qcow2 |
| file | File Requires --long option | /v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file |
| min_disk | Minimum disk Requires --long option | 100 |
| min_ram | Minimum RAM Requires --long option | 0 |
| name | Image name | imagename |
| os_distro | OS distribution | alma |
| os_hash_algo | OS hash algorithm Requires --long option | sha512 |
| os_hash_value | OS hash value Requires --long option | c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99 |
| os_hidden | OS hidden Requires --long option | False |
| owner | Owner account ID Requires --long option | a8f10467abfc4b87b64614ab36eb9ae4 |
| owner_account_name | Owner account name Requires --long option | AccountName |
| owner_user_name | Owner user name Requires --long option | user@samsung.com |
| protected | Protected Requires --long option | False |
| root_device_name | Root device name Requires --long option | /dev/vda |
| scp_image_type | Image type Requires --long option | custom |
| scp_k8s_version | K8S version Requires --long option | v1.28.7 |
| scp_original_image_type | Original Image type Requires --long option | standard |
| scp_os_build_version | OS build version Requires --long option | 20250101 |
| scp_os_version | OS version Requires --long option | 8.8 |
| size | Size Requires --long option | 2429747200 |
| status | Status Requires --long option | active |
| updated_at | Updated at Requires --long option | 2025-07-26T12:00:00Z |
| url | Object 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_size | Virtual size Requires --long option | 17179869184 |
| visibility | Visibility | private |
| volumes | Volumes 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}] |
1.54.2 - 1.0
scpcli virtualserver image list
[--limit <value>]
[--marker <value>]
[--scp_image_type <value>]
[--scp_original_image_type <value>]
[--name <value>]
[--os_distro <value>]
[--status <value>]
[--visibility <value>]
[--sort <value>]
[--long]
Description
List Images.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
limit optional | integer | Page size of items | 20 |
marker optional | string | The last item's ID from previous request | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
scp_image_type optional | string | Image type | custom |
scp_original_image_type optional | string | Original Image type | standard |
name optional | string | Image name | imagename |
os_distro optional | string | OS distribution | alma |
status optional | string | Status | active |
visibility optional | **** | Visibility | private |
sort optional | string | Comma-separated list of sort keys and optional sort directions in the form of [:] | created_at:desc |
Responses
| Name | Description | Example |
|---|
| id | Image ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| checksum | Checksum Requires --long option | 7538e0fcb56e0e272cfd89eb384d6613 |
| container_format | Container format Requires --long option | bare |
| created_at | Created at | 2025-07-22T09:00:00Z |
| disk_format | Disk format Requires --long option | qcow2 |
| file | File Requires --long option | /v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file |
| min_disk | Minimum disk Requires --long option | 100 |
| min_ram | Minimum RAM Requires --long option | 0 |
| name | Image name | imagename |
| os_distro | OS distribution | alma |
| os_hash_algo | OS hash algorithm Requires --long option | sha512 |
| os_hash_value | OS hash value Requires --long option | c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99 |
| os_hidden | OS hidden Requires --long option | False |
| owner | Owner account ID Requires --long option | a8f10467abfc4b87b64614ab36eb9ae4 |
| owner_account_name | Owner account name Requires --long option | AccountName |
| owner_user_name | Owner user name Requires --long option | user@samsung.com |
| protected | Protected Requires --long option | False |
| root_device_name | Root device name Requires --long option | /dev/vda |
| scp_image_type | Image type Requires --long option | custom |
| scp_k8s_version | K8S version Requires --long option | v1.28.7 |
| scp_original_image_type | Original Image type Requires --long option | standard |
| scp_os_build_version | OS build version Requires --long option | 20250101 |
| scp_os_version | OS version Requires --long option | 8.8 |
| size | Size Requires --long option | 2429747200 |
| status | Status Requires --long option | active |
| updated_at | Updated at Requires --long option | 2025-07-26T12:00:00Z |
| url | Object 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_size | Virtual size Requires --long option | 17179869184 |
| visibility | Visibility | private |
| volumes | Volumes 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}] |
1.55 - List Keypairs
1.55.1 - 1.1
scpcli virtualserver keypair list
[--limit <value>]
[--marker <value>]
[--long]
Description
Get keypair list.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
limit optional | integer | Page size of items | 20 |
marker optional | string | The last item's ID from previous request | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
| Name | Description | Example |
|---|
| fingerprint | Fingerprint | 7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd |
| name | Keypair name | keypairname |
| public_key | Public Key Requires --long option | publickey |
| type | Keypair type | ssh |
1.55.2 - 1.0
scpcli virtualserver keypair list
[--limit <value>]
[--marker <value>]
[--long]
Description
Get keypair list.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
limit optional | integer | Page size of items | 20 |
marker optional | string | The last item's ID from previous request | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
| Name | Description | Example |
|---|
| fingerprint | Fingerprint | 7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd |
| name | Keypair name | keypairname |
| public_key | Public Key Requires --long option | publickey |
| type | Keypair type | ssh |
1.56 - List Launch Configurations
1.56.1 - 1.1
scpcli virtualserver launch configuration list
[--name <value>]
[--image_id <value>]
[--offset <value>]
[--limit <value>]
[--sort <value>]
[--long]
Description
List Launch Configurations.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
name optional | string | Launch Configuration name | launch-configuration-name |
image_id optional | string | Image ID | 70a599e0-31e7-49b7-b260-868f441e862b |
offset optional | integer | Index of where to start in the list | - |
limit optional | integer | Page size of items | - |
sort optional | string | Comma-separated list of sort keys and optional sort directions in the form of [:] | - |
Responses
| Name | Description | Example |
|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID Requires --long option | a8f10467abfc4b87b64614ab36eb9ae4 |
| auto_scaling_group_count | Number of Auto-Scaling Group attached to Launch Configuration | 1 |
| boot_disk_size | Size of default volume Requires --long option | 104 |
| created_at | Created At Requires --long option | 2024-05-17T00:23:17Z |
| created_by | Created By Requires --long option | 90dddfc2b1e04edba54ba2b41539a9ac |
| extra_disk_size | Size of additional volume Requires --long option | 104 |
| image_id | Image ID Requires --long option | 70a599e0-31e7-49b7-b260-868f441e862b |
| image_name | Image name | imagename |
| keypair_name | Keypair name Requires --long option | keypairname |
| modified_at | Modified At Requires --long option | 2024-05-17T00:23:17Z |
| modified_by | Modified By Requires --long option | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Launch Configuration name | launch-configuration-name |
| public_key | Public Key Requires --long option | publickey |
| server_type_id | Server type ID | s1v1m2 |
| state | Launch Configuration state Requires --long option | ACTIVE |
| user_data | User data Requires --long option | IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg== |
| volumes | Volumes | |
1.56.2 - 1.0
scpcli virtualserver launch configuration list
[--name <value>]
[--image_id <value>]
[--offset <value>]
[--limit <value>]
[--sort <value>]
[--long]
Description
List Launch Configurations.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
name optional | string | Launch Configuration name | launch-configuration-name |
image_id optional | string | Image ID | 70a599e0-31e7-49b7-b260-868f441e862b |
offset optional | integer | Index of where to start in the list | - |
limit optional | integer | Page size of items | - |
sort optional | string | Comma-separated list of sort keys and optional sort directions in the form of [:] | - |
Responses
| Name | Description | Example |
|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID Requires --long option | a8f10467abfc4b87b64614ab36eb9ae4 |
| auto_scaling_group_count | Number of Auto-Scaling Group attached to Launch Configuration | 1 |
| boot_disk_size | Size of default volume Requires --long option | 104 |
| created_at | Created At Requires --long option | 2024-05-17T00:23:17Z |
| created_by | Created By Requires --long option | 90dddfc2b1e04edba54ba2b41539a9ac |
| extra_disk_size | Size of additional volume Requires --long option | 104 |
| image_id | Image ID Requires --long option | 70a599e0-31e7-49b7-b260-868f441e862b |
| image_name | Image name | imagename |
| keypair_name | Keypair name Requires --long option | keypairname |
| modified_at | Modified At Requires --long option | 2024-05-17T00:23:17Z |
| modified_by | Modified By Requires --long option | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Launch Configuration name | launch-configuration-name |
| public_key | Public Key Requires --long option | publickey |
| server_type_id | Server type ID | s1v1m2 |
| state | Launch Configuration state Requires --long option | ACTIVE |
| user_data | User data Requires --long option | IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg== |
| volumes | Volumes | |
1.57 - List pending Images
1.57.1 - 1.1
scpcli virtualserver image pending list
[--scp_image_type <value>]
[--scp_original_image_type <value>]
[--long]
Description
List pending Images.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
scp_image_type optional | string | Image type | custom |
scp_original_image_type optional | string | Original Image type | standard |
Responses
| Name | Description | Example |
|---|
| id | Image ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| checksum | Checksum Requires --long option | 7538e0fcb56e0e272cfd89eb384d6613 |
| container_format | Container format Requires --long option | bare |
| created_at | Created at | 2025-07-22T09:00:00Z |
| disk_format | Disk format Requires --long option | qcow2 |
| file | File Requires --long option | /v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file |
| min_disk | Minimum disk Requires --long option | 100 |
| min_ram | Minimum RAM Requires --long option | 0 |
| name | Image name | imagename |
| os_distro | OS distribution | alma |
| os_hash_algo | OS hash algorithm Requires --long option | sha512 |
| os_hash_value | OS hash value Requires --long option | c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99 |
| os_hidden | OS hidden Requires --long option | False |
| owner | Owner account ID Requires --long option | a8f10467abfc4b87b64614ab36eb9ae4 |
| owner_account_name | Owner account name Requires --long option | AccountName |
| owner_user_name | Owner user name Requires --long option | user@samsung.com |
| protected | Protected Requires --long option | False |
| root_device_name | Root device name Requires --long option | /dev/vda |
| scp_image_type | Image type Requires --long option | custom |
| scp_k8s_version | K8S version Requires --long option | v1.28.7 |
| scp_original_image_type | Original Image type Requires --long option | standard |
| scp_os_build_version | OS build version Requires --long option | 20250101 |
| scp_os_version | OS version Requires --long option | 8.8 |
| size | Size Requires --long option | 2429747200 |
| status | Status Requires --long option | active |
| updated_at | Updated at Requires --long option | 2025-07-26T12:00:00Z |
| url | Object 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_size | Virtual size Requires --long option | 17179869184 |
| visibility | Visibility | private |
| volumes | Volumes 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}] |
1.57.2 - 1.0
scpcli virtualserver image pending list
[--scp_image_type <value>]
[--scp_original_image_type <value>]
[--long]
Description
List pending Images.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
scp_image_type optional | string | Image type | custom |
scp_original_image_type optional | string | Original Image type | standard |
Responses
| Name | Description | Example |
|---|
| id | Image ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| checksum | Checksum Requires --long option | 7538e0fcb56e0e272cfd89eb384d6613 |
| container_format | Container format Requires --long option | bare |
| created_at | Created at | 2025-07-22T09:00:00Z |
| disk_format | Disk format Requires --long option | qcow2 |
| file | File Requires --long option | /v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file |
| min_disk | Minimum disk Requires --long option | 100 |
| min_ram | Minimum RAM Requires --long option | 0 |
| name | Image name | imagename |
| os_distro | OS distribution | alma |
| os_hash_algo | OS hash algorithm Requires --long option | sha512 |
| os_hash_value | OS hash value Requires --long option | c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99 |
| os_hidden | OS hidden Requires --long option | False |
| owner | Owner account ID Requires --long option | a8f10467abfc4b87b64614ab36eb9ae4 |
| owner_account_name | Owner account name Requires --long option | AccountName |
| owner_user_name | Owner user name Requires --long option | user@samsung.com |
| protected | Protected Requires --long option | False |
| root_device_name | Root device name Requires --long option | /dev/vda |
| scp_image_type | Image type Requires --long option | custom |
| scp_k8s_version | K8S version Requires --long option | v1.28.7 |
| scp_original_image_type | Original Image type Requires --long option | standard |
| scp_os_build_version | OS build version Requires --long option | 20250101 |
| scp_os_version | OS version Requires --long option | 8.8 |
| size | Size Requires --long option | 2429747200 |
| status | Status Requires --long option | active |
| updated_at | Updated at Requires --long option | 2025-07-26T12:00:00Z |
| url | Object 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_size | Virtual size Requires --long option | 17179869184 |
| visibility | Visibility | private |
| volumes | Volumes 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}] |
1.58 - List Server Groups
1.58.1 - 1.1
scpcli virtualserver server group list
[--limit <value>]
[--offset <value>]
[--long]
Description
Get server group list.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
limit optional | integer | Page size of items | 20 |
offset optional | integer | Index of where to start in the list | 0 |
Responses
| Name | Description | Example |
|---|
| id | Server Group ID | 616fb98f-46ca-475e-917e-2563e5a8cd19 |
| account_id | Account ID Requires --long option | a8f10467abfc4b87b64614ab36eb9ae4 |
| members | Server Group members Requires --long option | [‘2a9be312-5d4b-4bc8-b2ae-35100fa9241f’] |
| name | Server Group name | server-group |
| partition_size | Partition Size Requires --long option | 3 |
| policy | Server Group policy | anti-affinity |
| user_id | User ID Requires --long option | 570907805e5447be84b618450ef52o0t |
1.58.2 - 1.0
scpcli virtualserver server group list
[--limit <value>]
[--offset <value>]
[--long]
Description
Get server group list.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
limit optional | integer | Page size of items | 20 |
offset optional | integer | Index of where to start in the list | 0 |
Responses
| Name | Description | Example |
|---|
| id | Server Group ID | 616fb98f-46ca-475e-917e-2563e5a8cd19 |
| account_id | Account ID Requires --long option | a8f10467abfc4b87b64614ab36eb9ae4 |
| members | Server Group members Requires --long option | [‘2a9be312-5d4b-4bc8-b2ae-35100fa9241f’] |
| name | Server Group name | server-group |
| partition_size | Partition Size Requires --long option | 3 |
| policy | Server Group policy | anti-affinity |
| user_id | User ID Requires --long option | 570907805e5447be84b618450ef52o0t |
1.59 - List Server Interfaces
1.59.1 - 1.1
scpcli virtualserver server interface list
--server_id <value>
Description
List Server Interfaces.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
| Name | Description | Example |
|---|
| fixed_ips | Fixed Ip list | |
| mac_addr | MAC Address | fa:16:3e:c0:71:2b |
| port_id | Port ID | f2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc |
| port_state | Port State | ACTIVE |
| private_static_nat | Private Static NAT | |
| static_nat | Public Static NAT | |
| subnet_id | Subnet ID | 183c6c30df0c4fcbb16422aa2d64aa21 |
1.59.2 - 1.0
scpcli virtualserver server interface list
--server_id <value>
Description
List Server Interfaces.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
| Name | Description | Example |
|---|
| fixed_ips | Fixed Ip list | |
| mac_addr | MAC Address | fa:16:3e:c0:71:2b |
| port_id | Port ID | f2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc |
| port_state | Port State | ACTIVE |
| private_static_nat | Private Static NAT | |
| static_nat | Public Static NAT | |
| subnet_id | Subnet ID | 183c6c30df0c4fcbb16422aa2d64aa21 |
1.60 - List Server Ips
1.60.1 - 1.1
scpcli virtualserver server ip list
--server_id <value>
Description
List Server Ips.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
| Name | Description | Example |
|---|
| ip_addresses | IP addresses | |
| subnet_name | Subnet name | subnetname |
1.60.2 - 1.0
scpcli virtualserver server ip list
--server_id <value>
Description
List Server Ips.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
| Name | Description | Example |
|---|
| ip_addresses | IP addresses | |
| subnet_name | Subnet name | subnetname |
1.61 - List Server Types
1.61.1 - 1.1
scpcli virtualserver server type list
[--limit <value>]
[--marker <value>]
[--min_disk <value>]
[--min_ram <value>]
[--sort <value>]
Description
Get server type list.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
limit optional | integer | Page size of items | 20 |
marker optional | string | The last item's ID from previous request | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
min_disk optional | integer | Minimum disk size | 0 |
min_ram optional | integer | Minimum ram size | 2048 |
sort optional | string | Comma-separated list of sort keys and optional sort directions in the form of [:] | created_at:desc |
Responses
| Name | Description | Example |
|---|
| id | Server type ID | s1v1m2 |
| description | Description | description |
| disk | Size of root disk | 100 |
| ephemeral | Size of ephemeral disk | 0 |
| extra_specs | Extra specs | |
| name | Server type name | s1v1m2 |
| ram | Amount of RAM | 2 |
| swap | Size of dedicated swap disk | 0 |
| vcpus | Number of CPUs | 1 |
1.61.2 - 1.0
scpcli virtualserver server type list
[--limit <value>]
[--marker <value>]
[--min_disk <value>]
[--min_ram <value>]
[--sort <value>]
Description
Get server type list.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
limit optional | integer | Page size of items | 20 |
marker optional | string | The last item's ID from previous request | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
min_disk optional | integer | Minimum disk size | 0 |
min_ram optional | integer | Minimum ram size | 2048 |
sort optional | string | Comma-separated list of sort keys and optional sort directions in the form of [:] | created_at:desc |
Responses
| Name | Description | Example |
|---|
| id | Server type ID | s1v1m2 |
| description | Description | description |
| disk | Size of root disk | 100 |
| ephemeral | Size of ephemeral disk | 0 |
| extra_specs | Extra specs | |
| name | Server type name | s1v1m2 |
| ram | Amount of RAM | 2 |
| swap | Size of dedicated swap disk | 0 |
| vcpus | Number of CPUs | 1 |
1.62 - List Server Volumes
1.62.1 - 1.1
scpcli virtualserver server volume list
--server_id <value>
Description
List Server Volumes.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
| Name | Description | Example |
|---|
| id | Volume Attachment ID | 3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c |
| delete_on_termination | Delete on termination | False |
| device | Device name | /dev/vda |
| server_id | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| volume_id | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
1.62.2 - 1.0
scpcli virtualserver server volume list
--server_id <value>
Description
List Server Volumes.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
| Name | Description | Example |
|---|
| id | Volume Attachment ID | 3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c |
| delete_on_termination | Delete on termination | False |
| device | Device name | /dev/vda |
| server_id | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| volume_id | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
1.63 - List snapshots and details
1.63.1 - 1.1
scpcli virtualserver volume snapshot list
[--volume_id <value>]
[--limit <value>]
[--offset <value>]
[--marker <value>]
[--with_count <value>]
[--name <value>]
Description
List snapshots and details.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
volume_id optional | string | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
limit optional | integer | Page size of items | 20 |
offset optional | integer | Index of where to start in the list | 0 |
marker optional | string | The last item's ID from previous request | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
with_count optional | boolean | Whether to show count | True |
name optional | string | Snapshot name | snapshot-1 |
Responses
| Name | Description | Example |
|---|
| id | Snapshot ID | cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 |
| created_at | Created at | 2025-07-22T09:00:00Z |
| description | Description | description |
| metadata | Snapshot metadata | |
| name | Snapshot name | snapshot-1 |
| size | Volume size | 104 |
| status | Volume state | available |
| updated_at | Updated at | 2025-07-26T12:00:00Z |
| user_id | User ID | 570907805e5447be84b618450ef52o0t |
| volume_id | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
1.63.2 - 1.0
scpcli virtualserver volume snapshot list
[--volume_id <value>]
[--limit <value>]
[--offset <value>]
[--marker <value>]
[--with_count <value>]
[--name <value>]
Description
List snapshots and details.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
volume_id optional | string | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
limit optional | integer | Page size of items | 20 |
offset optional | integer | Index of where to start in the list | 0 |
marker optional | string | The last item's ID from previous request | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
with_count optional | boolean | Whether to show count | True |
name optional | string | Snapshot name | snapshot-1 |
Responses
| Name | Description | Example |
|---|
| id | Snapshot ID | cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 |
| created_at | Created at | 2025-07-22T09:00:00Z |
| description | Description | description |
| metadata | Snapshot metadata | |
| name | Snapshot name | snapshot-1 |
| size | Volume size | 104 |
| status | Volume state | available |
| updated_at | Updated at | 2025-07-26T12:00:00Z |
| user_id | User ID | 570907805e5447be84b618450ef52o0t |
| volume_id | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
1.64 - List Virtual Server Security Group
1.64.1 - 1.1
scpcli virtualserver server security group list
--server_id <value>
Description
List Virtual Server Security Group.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
| Name | Description | Example |
|---|
| id | Security Group ID | 616fb98f-46ca-475e-917e-2563e5a8cd19 |
| account_id | Server Group owner’s account ID | 6f70656e737461636b20342065766572 |
| description | Security group description | Security group description |
| name | Security Group name | securitygroup |
| rules | Security group rules | |
1.64.2 - 1.0
scpcli virtualserver server security group list
--server_id <value>
Description
List Virtual Server Security Group.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
| Name | Description | Example |
|---|
| id | Security Group ID | 616fb98f-46ca-475e-917e-2563e5a8cd19 |
| account_id | Server Group owner’s account ID | 6f70656e737461636b20342065766572 |
| description | Security group description | Security group description |
| name | Security Group name | securitygroup |
| rules | Security group rules | |
1.65 - List Virtual Servers
1.65.1 - 1.1
scpcli virtualserver server list
[--name <value>]
[--ip <value>]
[--state <value>]
[--product_category <value>]
[--product_offering <value>]
[--vpc_id <value>]
[--server_type_id <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--auto_scaling_group_id <value>]
[--long]
Description
List Virtual Servers.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
name optional | string | Server name | servername |
ip optional | string | IP address | 192.169.3.2 |
state optional | string | Server state | ACTIVE |
product_category optional | **** | Product category | compute |
product_offering optional | array | Product offering | 'v' |
vpc_id optional | string | VPC ID | cc976b621087484ea5fd527f4b78708b |
server_type_id optional | string | Server type ID | s1v1m2 |
limit optional | integer | Page size of items | 20 |
marker optional | string | The last item's ID from previous request | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
sort optional | string | Comma-separated list of sort keys and optional sort directions in the form of [:] | created_at:desc |
auto_scaling_group_id optional | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
Responses
| Name | Description | Example |
|---|
| id | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| account_id | Account ID Requires --long option | a8f10467abfc4b87b64614ab36eb9ae4 |
| addresses | Addresses | |
| auto_scaling_group_id | Auto-Scaling Group ID Requires --long option | 52613bd852b04b39adcb15a8364d856d |
| created_at | Created at Requires --long option | |
| created_by | Created by Requires --long option | 97e6b22c9a4143789ca522df7457a32f |
| disk_config | Disk config Requires --long option | MANUAL |
| image_id | Image ID Requires --long option | 70a599e0-31e7-49b7-b260-868f441e862b |
| is_marketplace | Is Marketplace Requires --long option | False |
| keypair_name | Keypair name Requires --long option | keypairname |
| launch_configuration_id | Launch Configuration ID Requires --long option | b5aea5a675fc4f6b9e0fcd1288354c5f |
| locked | Locked Requires --long option | False |
| metadata | Metadata Requires --long option | |
| modified_at | Modified at Requires --long option | |
| name | Server name | servername |
| partition_number | Partition number Requires --long option | 1 |
| planned_compute_os_type | Planned Compute OS type Requires --long option | windows |
| product_category | Product category Requires --long option | compute |
| product_offering | Product offering Requires --long option | virtual_server |
| security_groups | Security Groups Requires --long option | |
| server_group_id | Server Group ID Requires --long option | 616fb98f-46ca-475e-917e-2563e5a8cd19 |
| server_type | Server type | |
| state | Server state | ACTIVE |
| volumes | Volumes Requires --long option | |
| vpc_id | VPC ID Requires --long option | cc976b621087484ea5fd527f4b78708b |
1.65.2 - 1.0
scpcli virtualserver server list
[--name <value>]
[--ip <value>]
[--state <value>]
[--product_category <value>]
[--product_offering <value>]
[--vpc_id <value>]
[--server_type_id <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--auto_scaling_group_id <value>]
[--long]
Description
List Virtual Servers.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
name optional | string | Server name | servername |
ip optional | string | IP address | 192.169.3.2 |
state optional | string | Server state | ACTIVE |
product_category optional | **** | Product category | compute |
product_offering optional | array | Product offering | 'v' |
vpc_id optional | string | VPC ID | cc976b621087484ea5fd527f4b78708b |
server_type_id optional | string | Server type ID | s1v1m2 |
limit optional | integer | Page size of items | 20 |
marker optional | string | The last item's ID from previous request | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
sort optional | string | Comma-separated list of sort keys and optional sort directions in the form of [:] | created_at:desc |
auto_scaling_group_id optional | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
Responses
| Name | Description | Example |
|---|
| id | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| account_id | Account ID Requires --long option | a8f10467abfc4b87b64614ab36eb9ae4 |
| addresses | Addresses | |
| auto_scaling_group_id | Auto-Scaling Group ID Requires --long option | 52613bd852b04b39adcb15a8364d856d |
| created_at | Created at Requires --long option | |
| created_by | Created by Requires --long option | 97e6b22c9a4143789ca522df7457a32f |
| disk_config | Disk config Requires --long option | MANUAL |
| image_id | Image ID Requires --long option | 70a599e0-31e7-49b7-b260-868f441e862b |
| is_marketplace | Is Marketplace Requires --long option | False |
| keypair_name | Keypair name Requires --long option | keypairname |
| launch_configuration_id | Launch Configuration ID Requires --long option | b5aea5a675fc4f6b9e0fcd1288354c5f |
| locked | Locked Requires --long option | False |
| metadata | Metadata Requires --long option | |
| modified_at | Modified at Requires --long option | |
| name | Server name | servername |
| partition_number | Partition number Requires --long option | 1 |
| planned_compute_os_type | Planned Compute OS type Requires --long option | windows |
| product_category | Product category Requires --long option | compute |
| product_offering | Product offering Requires --long option | virtual_server |
| security_groups | Security Groups Requires --long option | |
| server_group_id | Server Group ID Requires --long option | 616fb98f-46ca-475e-917e-2563e5a8cd19 |
| server_type | Server type | |
| state | Server state | ACTIVE |
| volumes | Volumes Requires --long option | |
| vpc_id | VPC ID Requires --long option | cc976b621087484ea5fd527f4b78708b |
1.66 - List volume transfers
1.66.1 - 1.1
scpcli virtualserver volume transfer list
Description
List volume transfers.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Responses
| Name | Description | Example |
|---|
| id | Transfer ID | 1ac231be-823b-4a4d-8ff0-aac503a7118a |
| name | Volume name | volume01 |
| volume_id | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
1.66.2 - 1.0
scpcli virtualserver volume transfer list
Description
List volume transfers.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Responses
| Name | Description | Example |
|---|
| id | Transfer ID | 1ac231be-823b-4a4d-8ff0-aac503a7118a |
| name | Volume name | volume01 |
| volume_id | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
1.67 - List volume types and details
1.67.1 - 1.1
scpcli virtualserver volume type list
[--limit <value>]
[--offset <value>]
[--marker <value>]
[--sort <value>]
Description
List volume types and details
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
limit optional | integer | Page size of items | 20 |
offset optional | integer | Index of where to start in the list | 0 |
marker optional | string | The last item's ID from previous request | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
sort optional | string | Comma-separated list of sort keys and optional sort directions in the form of [:] | created_at:desc |
Responses
| Name | Description | Example |
|---|
| id | Volume type ID | c643ac35-3aec-43e6-b97a-3d6f666c5207 |
| description | Volume type description | Volume type description |
| extra_specs | Extra specs | |
| name | Volume type name | SSD |
1.67.2 - 1.0
scpcli virtualserver volume type list
[--limit <value>]
[--offset <value>]
[--marker <value>]
[--sort <value>]
Description
List volume types and details
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
limit optional | integer | Page size of items | 20 |
offset optional | integer | Index of where to start in the list | 0 |
marker optional | string | The last item's ID from previous request | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
sort optional | string | Comma-separated list of sort keys and optional sort directions in the form of [:] | created_at:desc |
Responses
| Name | Description | Example |
|---|
| id | Volume type ID | c643ac35-3aec-43e6-b97a-3d6f666c5207 |
| description | Volume type description | Volume type description |
| extra_specs | Extra specs | |
| name | Volume type name | SSD |
1.68 - List volumes and details
1.68.1 - 1.1
scpcli virtualserver volume list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--offset <value>]
[--name <value>]
[--state <value>]
[--bootable <value>]
[--long]
Description
List volumes and details.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
with_count optional | boolean | Whether to show count | True |
limit optional | integer | Page size of items | 20 |
marker optional | string | The last item's ID from previous request | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
sort optional | string | Comma-separated list of sort keys and optional sort directions in the form of [:] | created_at:desc |
offset optional | integer | Index of where to start in the list | 0 |
name optional | string | Volume name | volume01 |
state optional | string | Volume state | available |
bootable optional | boolean | Bootable | False |
Responses
| Name | Description | Example |
|---|
| id | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
| bootable | Bootable | False |
| created_at | Created at | |
| encrypted | Encrypted Requires --long option | True |
| modified_at | Modified at Requires --long option | 2025-07-26T12:00:00Z |
| multiattach | Multiattach Requires --long option | False |
| name | Volume name | volume01 |
| servers | Attached servers Requires --long option | |
| size | Volume size | 104 |
| snapshot_id | Snapshot ID Requires --long option | cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 |
| state | Volume state | available |
| user_id | User ID Requires --long option | 570907805e5447be84b618450ef52o0t |
| volume_image_metadata | Volume Image metadata Requires --long option | |
| volume_type | Volume type | SSD |
| volume_type_id | Volume type ID Requires --long option | c643ac35-3aec-43e6-b97a-3d6f666c5207 |
1.68.2 - 1.0
scpcli virtualserver volume list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--offset <value>]
[--name <value>]
[--state <value>]
[--bootable <value>]
[--long]
Description
List volumes and details.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
with_count optional | boolean | Whether to show count | True |
limit optional | integer | Page size of items | 20 |
marker optional | string | The last item's ID from previous request | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
sort optional | string | Comma-separated list of sort keys and optional sort directions in the form of [:] | created_at:desc |
offset optional | integer | Index of where to start in the list | 0 |
name optional | string | Volume name | volume01 |
state optional | string | Volume state | available |
bootable optional | boolean | Bootable | False |
Responses
| Name | Description | Example |
|---|
| id | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
| bootable | Bootable | False |
| created_at | Created at | |
| encrypted | Encrypted Requires --long option | True |
| modified_at | Modified at Requires --long option | 2025-07-26T12:00:00Z |
| multiattach | Multiattach Requires --long option | False |
| name | Volume name | volume01 |
| servers | Attached servers Requires --long option | |
| size | Volume size | 104 |
| snapshot_id | Snapshot ID Requires --long option | cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 |
| state | Volume state | available |
| user_id | User ID Requires --long option | 570907805e5447be84b618450ef52o0t |
| volume_image_metadata | Volume Image metadata Requires --long option | |
| volume_type | Volume type | SSD |
| volume_type_id | Volume type ID Requires --long option | c643ac35-3aec-43e6-b97a-3d6f666c5207 |
1.69 - Lock Virtual Server
1.69.1 - 1.1
scpcli virtualserver server lock
--server_id <value>
Description
Lock Virtual Server.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
1.69.2 - 1.0
scpcli virtualserver server lock
--server_id <value>
Description
Lock Virtual Server.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
1.70 - Reboot Virtual Server
1.70.1 - 1.1
scpcli virtualserver server reboot
--server_id <value>
[--reboot_type <value>]
Description
Reboot Virtual Server.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
reboot_type optional | **** | Reboot type | SOFT |
Responses
1.70.2 - 1.0
scpcli virtualserver server reboot
--server_id <value>
[--reboot_type <value>]
Description
Reboot Virtual Server.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
reboot_type optional | **** | Reboot type | SOFT |
Responses
1.71 - Rebuild Virtual Server
1.71.1 - 1.1
scpcli virtualserver server rebuild
--server_id <value>
Description
Rebuild Virtual Server.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
1.71.2 - 1.0
scpcli virtualserver server rebuild
--server_id <value>
Description
Rebuild Virtual Server.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
1.72 - Revert Volume to snapshot
1.72.1 - 1.1
scpcli virtualserver volume revert
--volume_id <value>
--snapshot_id <value>
Description
Revert Volume to snapshot.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
snapshot_id required | string | Snapshot ID | cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 |
Responses
1.72.2 - 1.0
scpcli virtualserver volume revert
--volume_id <value>
--snapshot_id <value>
Description
Revert Volume to snapshot.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
snapshot_id required | string | Snapshot ID | cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 |
Responses
1.73 - Show a snapshot’s details
1.73.1 - 1.1
scpcli virtualserver volume snapshot show
--snapshot_id <value>
Description
Show a snapshot’s details.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
snapshot_id required | string | Snapshot ID | cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 |
Responses
| Name | Description | Example |
|---|
| id | Snapshot ID | cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 |
| created_at | Created at | 2025-07-22T09:00:00Z |
| description | Description | description |
| metadata | Snapshot metadata | |
| name | Snapshot name | snapshot-1 |
| size | Volume size | 104 |
| status | Volume state | available |
| updated_at | Updated at | 2025-07-26T12:00:00Z |
| user_id | User ID | 570907805e5447be84b618450ef52o0t |
| volume_id | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
1.73.2 - 1.0
scpcli virtualserver volume snapshot show
--snapshot_id <value>
Description
Show a snapshot’s details.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
snapshot_id required | string | Snapshot ID | cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 |
Responses
| Name | Description | Example |
|---|
| id | Snapshot ID | cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 |
| created_at | Created at | 2025-07-22T09:00:00Z |
| description | Description | description |
| metadata | Snapshot metadata | |
| name | Snapshot name | snapshot-1 |
| size | Volume size | 104 |
| status | Volume state | available |
| updated_at | Updated at | 2025-07-26T12:00:00Z |
| user_id | User ID | 570907805e5447be84b618450ef52o0t |
| volume_id | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
1.74 - Show Auto-Scaling Group
1.74.1 - 1.1
scpcli virtualserver auto scaling group show
--auto_scaling_group_id <value>
Description
Show Auto-Scaling Group.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
Responses
| Name | Description | Example |
|---|
| id | LB Server Group ID | d06e87d3-ca9a-461b-8e88-077a542a7335 |
| port | LB Server Group port | 8080 |
1.74.2 - 1.0
scpcli virtualserver auto scaling group show
--auto_scaling_group_id <value>
Description
Show Auto-Scaling Group.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
Responses
| Name | Description | Example |
|---|
| id | LB Server Group ID | d06e87d3-ca9a-461b-8e88-077a542a7335 |
| port | LB Server Group port | 8080 |
1.75 - Show Auto-Scaling Group Notification
1.75.1 - 1.1
scpcli virtualserver auto scaling group notification show
--notification_id <value>
--auto_scaling_group_id <value>
Description
Show Auto-Scaling Group notification.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
notification_id required | string | Notification ID | fa7fd191410744cd810a290c0b4d22b9 |
auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
Responses
| Name | Description | Example |
|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| auto_scaling_group_id | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| notification_events | Auto-Scaling Group notification events | [‘SCALE_OUT’, ‘SCALE_OUT_FAIL’] |
| notification_state | Auto-Scaling Group notification state | ACTIVE |
| user_id | User ID | 570907805e5447be84b618450ef52o0t |
| user_name | User name | scpuser |
1.75.2 - 1.0
scpcli virtualserver auto scaling group notification show
--notification_id <value>
--auto_scaling_group_id <value>
Description
Show Auto-Scaling Group notification.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
notification_id required | string | Notification ID | fa7fd191410744cd810a290c0b4d22b9 |
auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
Responses
| Name | Description | Example |
|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| auto_scaling_group_id | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| notification_events | Auto-Scaling Group notification events | [‘SCALE_OUT’, ‘SCALE_OUT_FAIL’] |
| notification_state | Auto-Scaling Group notification state | ACTIVE |
| user_id | User ID | 570907805e5447be84b618450ef52o0t |
| user_name | User name | scpuser |
1.76 - Show Auto-Scaling Group Policy
1.76.1 - 1.1
scpcli virtualserver auto scaling group policy show
--policy_id <value>
--auto_scaling_group_id <value>
Description
Show Auto-Scaling Group policy.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
policy_id required | string | Policy ID | 0761d76085f54363bab07909baf69841 |
auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
Responses
| Name | Description | Example |
|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| auto_scaling_group_id | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| comparison_operator | Comparison operator | ge |
| cooldown_seconds | Cooldown seconds | 300 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| evaluation_minutes | Evaluation minutes | 1 |
| metric_method | Metric method | AVG |
| metric_type | Metric type | CPU |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Policy name | policy-name |
| scale_method | Scale method | AMOUNT |
| scale_type | Scale type | SCALE_OUT |
| scale_value | Scale value | 10 |
| state | Policy state | ACTIVE |
| threshold | Threshold | 60 |
| threshold_unit | Threshold unit | % |
1.76.2 - 1.0
scpcli virtualserver auto scaling group policy show
--policy_id <value>
--auto_scaling_group_id <value>
Description
Show Auto-Scaling Group policy.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
policy_id required | string | Policy ID | 0761d76085f54363bab07909baf69841 |
auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
Responses
| Name | Description | Example |
|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| auto_scaling_group_id | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| comparison_operator | Comparison operator | ge |
| cooldown_seconds | Cooldown seconds | 300 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| evaluation_minutes | Evaluation minutes | 1 |
| metric_method | Metric method | AVG |
| metric_type | Metric type | CPU |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Policy name | policy-name |
| scale_method | Scale method | AMOUNT |
| scale_type | Scale type | SCALE_OUT |
| scale_value | Scale value | 10 |
| state | Policy state | ACTIVE |
| threshold | Threshold | 60 |
| threshold_unit | Threshold unit | % |
1.77 - Show Auto-Scaling Group Schedule
1.77.1 - 1.1
scpcli virtualserver auto scaling group schedule show
--schedule_id <value>
--auto_scaling_group_id <value>
Description
Show Auto-Scaling Group schedule.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
schedule_id required | string | Schedule ID | 43d4841abd404220af5f0904037aba71 |
auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
Responses
| Name | Description | Example |
|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| day_of_month | Day of the month | -1,1 |
| day_of_week | Day of the week | SU,SA |
| description | Description | description |
| desired_server_count | Desired server count | 1 |
| end_date | End date | 2025-01-01 |
| frequency | Frequency | WEEKLY |
| hour | Hour | 9 |
| max_server_count | Max server count | 2 |
| min_server_count | Min server count | 1 |
| minute | Minute | 0 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Schedule name | schedulename |
| start_date | Start date | 2024-01-01 |
| state | Schedule state | ACTIVE |
| timezone | Timezone | Asia/Seoul |
1.77.2 - 1.0
scpcli virtualserver auto scaling group schedule show
--schedule_id <value>
--auto_scaling_group_id <value>
Description
Show Auto-Scaling Group schedule.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
schedule_id required | string | Schedule ID | 43d4841abd404220af5f0904037aba71 |
auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
Responses
| Name | Description | Example |
|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| day_of_month | Day of the month | -1,1 |
| day_of_week | Day of the week | SU,SA |
| description | Description | description |
| desired_server_count | Desired server count | 1 |
| end_date | End date | 2025-01-01 |
| frequency | Frequency | WEEKLY |
| hour | Hour | 9 |
| max_server_count | Max server count | 2 |
| min_server_count | Min server count | 1 |
| minute | Minute | 0 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Schedule name | schedulename |
| start_date | Start date | 2024-01-01 |
| state | Schedule state | ACTIVE |
| timezone | Timezone | Asia/Seoul |
1.78 - Show default Volume type’s details
1.78.1 - 1.1
scpcli virtualserver volume type default show
Description
Show a default Volume type’s details.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Responses
| Name | Description | Example |
|---|
| id | Volume type ID | c643ac35-3aec-43e6-b97a-3d6f666c5207 |
| description | Volume type description | Volume type description |
| extra_specs | Extra specs | |
| name | Volume type name | SSD |
1.78.2 - 1.0
scpcli virtualserver volume type default show
Description
Show a default Volume type’s details.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Responses
| Name | Description | Example |
|---|
| id | Volume type ID | c643ac35-3aec-43e6-b97a-3d6f666c5207 |
| description | Volume type description | Volume type description |
| extra_specs | Extra specs | |
| name | Volume type name | SSD |
1.79 - Show Image
1.79.1 - 1.1
scpcli virtualserver image show
--image_id <value>
Description
Show Image.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
image_id required | string | Image ID | 70a599e0-31e7-49b7-b260-868f441e862b |
Responses
| Name | Description | Example |
|---|
| id | Image ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| checksum | Checksum | 7538e0fcb56e0e272cfd89eb384d6613 |
| container_format | Container format | bare |
| created_at | Created at | 2025-07-22T09:00:00Z |
| disk_format | Disk format | qcow2 |
| file | File | /v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file |
| min_disk | Minimum disk | 100 |
| min_ram | Minimum RAM | 0 |
| name | Image name | imagename |
| os_distro | OS distribution | alma |
| os_hash_algo | OS hash algorithm | sha512 |
| os_hash_value | OS hash value | c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99 |
| os_hidden | OS hidden | False |
| owner | Owner account ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| owner_account_name | Owner account name | AccountName |
| owner_user_name | Owner user name | user@samsung.com |
| protected | Protected | False |
| root_device_name | Root device name | /dev/vda |
| scp_image_type | Image type | custom |
| scp_k8s_version | K8S version | v1.28.7 |
| scp_original_image_type | Original Image type | standard |
| scp_os_build_version | OS build version | 20250101 |
| scp_os_version | OS version | 8.8 |
| size | Size | 2429747200 |
| status | Status | active |
| updated_at | Updated at | 2025-07-26T12:00:00Z |
| url | Object Storage URL for Image file (only qcow2 format allowed) | https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2 |
| virtual_size | Virtual size | 17179869184 |
| visibility | Visibility | private |
| volumes | Volumes | [{“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}] |
1.79.2 - 1.0
scpcli virtualserver image show
--image_id <value>
Description
Show Image.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
image_id required | string | Image ID | 70a599e0-31e7-49b7-b260-868f441e862b |
Responses
| Name | Description | Example |
|---|
| id | Image ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| checksum | Checksum | 7538e0fcb56e0e272cfd89eb384d6613 |
| container_format | Container format | bare |
| created_at | Created at | 2025-07-22T09:00:00Z |
| disk_format | Disk format | qcow2 |
| file | File | /v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file |
| min_disk | Minimum disk | 100 |
| min_ram | Minimum RAM | 0 |
| name | Image name | imagename |
| os_distro | OS distribution | alma |
| os_hash_algo | OS hash algorithm | sha512 |
| os_hash_value | OS hash value | c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99 |
| os_hidden | OS hidden | False |
| owner | Owner account ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| owner_account_name | Owner account name | AccountName |
| owner_user_name | Owner user name | user@samsung.com |
| protected | Protected | False |
| root_device_name | Root device name | /dev/vda |
| scp_image_type | Image type | custom |
| scp_k8s_version | K8S version | v1.28.7 |
| scp_original_image_type | Original Image type | standard |
| scp_os_build_version | OS build version | 20250101 |
| scp_os_version | OS version | 8.8 |
| size | Size | 2429747200 |
| status | Status | active |
| updated_at | Updated at | 2025-07-26T12:00:00Z |
| url | Object Storage URL for Image file (only qcow2 format allowed) | https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2 |
| virtual_size | Virtual size | 17179869184 |
| visibility | Visibility | private |
| volumes | Volumes | [{“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}] |
1.80 - Show Image member
1.80.1 - 1.1
scpcli virtualserver image member show
--member_id <value>
--image_id <value>
Description
Show Image member.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
member_id required | string | Member ID | a8f10467abfc4b87b64614ab36eb9ae4 |
image_id required | string | Image ID | 70a599e0-31e7-49b7-b260-868f441e862b |
Responses
| Name | Description | Example |
|---|
| created_at | Created at | 2025-07-22T09:00:00Z |
| image_id | Image ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| member_id | Member ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| status | Member status | pending |
| updated_at | Updated at | 2025-07-26T12:00:00Z |
1.80.2 - 1.0
scpcli virtualserver image member show
--member_id <value>
--image_id <value>
Description
Show Image member.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
member_id required | string | Member ID | a8f10467abfc4b87b64614ab36eb9ae4 |
image_id required | string | Image ID | 70a599e0-31e7-49b7-b260-868f441e862b |
Responses
| Name | Description | Example |
|---|
| created_at | Created at | 2025-07-22T09:00:00Z |
| image_id | Image ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| member_id | Member ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| status | Member status | pending |
| updated_at | Updated at | 2025-07-26T12:00:00Z |
1.81 - Show Keypair
1.81.1 - 1.1
scpcli virtualserver keypair show
--keypair_name <value>
Description
Show keypair.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
keypair_name required | string | Keypair name | keypairname |
Responses
| Name | Description | Example |
|---|
| id | Keypair ID | 1 |
| created_at | Created at | 2025-07-22T09:00:00Z |
| fingerprint | Fingerprint | 7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd |
| name | Keypair name | keypairname |
| public_key | Public Key | publickey |
| type | Keypair type | ssh |
| user_id | User ID | 570907805e5447be84b618450ef52o0t |
1.81.2 - 1.0
scpcli virtualserver keypair show
--keypair_name <value>
Description
Show keypair.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
keypair_name required | string | Keypair name | keypairname |
Responses
| Name | Description | Example |
|---|
| id | Keypair ID | 1 |
| created_at | Created at | 2025-07-22T09:00:00Z |
| fingerprint | Fingerprint | 7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd |
| name | Keypair name | keypairname |
| public_key | Public Key | publickey |
| type | Keypair type | ssh |
| user_id | User ID | 570907805e5447be84b618450ef52o0t |
1.82 - Show Launch Configuration
1.82.1 - 1.1
scpcli virtualserver launch configuration show
--launch_configuration_id <value>
Description
Show Launch Configuration.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
launch_configuration_id required | string | Launch Configuration ID | b5aea5a675fc4f6b9e0fcd1288354c5f |
Responses
| Name | Description | Example |
|---|
| boot_index | Boot index | 0 |
| size | Volume size | 104 |
| type | Volume type | SSD |
1.82.2 - 1.0
scpcli virtualserver launch configuration show
--launch_configuration_id <value>
Description
Show Launch Configuration.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
launch_configuration_id required | string | Launch Configuration ID | b5aea5a675fc4f6b9e0fcd1288354c5f |
Responses
| Name | Description | Example |
|---|
| boot_index | Boot index | 0 |
| size | Volume size | 104 |
| type | Volume type | SSD |
1.83 - Show Server Group
1.83.1 - 1.1
scpcli virtualserver server group show
--server_group_id <value>
Description
Show server group.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
server_group_id required | string | Server Group ID | 616fb98f-46ca-475e-917e-2563e5a8cd19 |
Responses
| Name | Description | Example |
|---|
| id | Server Group ID | 616fb98f-46ca-475e-917e-2563e5a8cd19 |
| account_id | Account ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| members | Server Group members | [‘2a9be312-5d4b-4bc8-b2ae-35100fa9241f’] |
| name | Server Group name | server-group |
| partition_size | Partition Size | 3 |
| policy | Server Group policy | anti-affinity |
| user_id | User ID | 570907805e5447be84b618450ef52o0t |
1.83.2 - 1.0
scpcli virtualserver server group show
--server_group_id <value>
Description
Show server group.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
server_group_id required | string | Server Group ID | 616fb98f-46ca-475e-917e-2563e5a8cd19 |
Responses
| Name | Description | Example |
|---|
| id | Server Group ID | 616fb98f-46ca-475e-917e-2563e5a8cd19 |
| account_id | Account ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| members | Server Group members | [‘2a9be312-5d4b-4bc8-b2ae-35100fa9241f’] |
| name | Server Group name | server-group |
| partition_size | Partition Size | 3 |
| policy | Server Group policy | anti-affinity |
| user_id | User ID | 570907805e5447be84b618450ef52o0t |
1.84 - Show Server Interface
1.84.1 - 1.1
scpcli virtualserver server interface show
--port_id <value>
--server_id <value>
Description
Show Server Interface.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
port_id required | string | Port ID | 91424c08-0b26-49fb-9808-ed042292ceef |
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
| Name | Description | Example |
|---|
| fixed_ips | Fixed Ip list | |
| mac_addr | MAC Address | fa:16:3e:c0:71:2b |
| port_id | Port ID | f2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc |
| port_state | Port State | ACTIVE |
| private_static_nat | Private Static NAT | |
| static_nat | Public Static NAT | |
| subnet_id | Subnet ID | 183c6c30df0c4fcbb16422aa2d64aa21 |
1.84.2 - 1.0
scpcli virtualserver server interface show
--port_id <value>
--server_id <value>
Description
Show Server Interface.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
port_id required | string | Port ID | 91424c08-0b26-49fb-9808-ed042292ceef |
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
| Name | Description | Example |
|---|
| fixed_ips | Fixed Ip list | |
| mac_addr | MAC Address | fa:16:3e:c0:71:2b |
| port_id | Port ID | f2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc |
| port_state | Port State | ACTIVE |
| private_static_nat | Private Static NAT | |
| static_nat | Public Static NAT | |
| subnet_id | Subnet ID | 183c6c30df0c4fcbb16422aa2d64aa21 |
1.85 - Show Server Ip
1.85.1 - 1.1
scpcli virtualserver server ip show
--subnet_id <value>
--server_id <value>
Description
Show Server Ip.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
subnet_id required | string | Subnet ID | 78b2ee3f074145c580ab6abac4821f97 |
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
| Name | Description | Example |
|---|
| ip_address | IP address | 192.169.3.2 |
| version | IP address version | 4 |
1.85.2 - 1.0
scpcli virtualserver server ip show
--subnet_id <value>
--server_id <value>
Description
Show Server Ip.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
subnet_id required | string | Subnet ID | 78b2ee3f074145c580ab6abac4821f97 |
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
| Name | Description | Example |
|---|
| ip_address | IP address | 192.169.3.2 |
| version | IP address version | 4 |
1.86 - Show Server Quota Set
1.86.1 - 1.1
scpcli virtualserver quota set show
Description
Show server quota Set.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Responses
| Name | Description | Example |
|---|
| id | Quota set ID | fc7283354c6143a58629b59f4c3e16b2 |
| cores | Core quota | |
| instances | Instance quota | |
| keypairs | Keypairs quota | |
| metadata_items | Metadata items quota | |
| ram | RAM quota | |
| server_group_members | Server group members quota | |
| server_groups | Server groups quota | |
1.86.2 - 1.0
scpcli virtualserver quota set show
Description
Show server quota Set.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Responses
| Name | Description | Example |
|---|
| id | Quota set ID | fc7283354c6143a58629b59f4c3e16b2 |
| cores | Core quota | |
| instances | Instance quota | |
| keypairs | Keypairs quota | |
| metadata_items | Metadata items quota | |
| ram | RAM quota | |
| server_group_members | Server group members quota | |
| server_groups | Server groups quota | |
1.87 - Show Server Type
1.87.1 - 1.1
scpcli virtualserver server type show
--server_type_id <value>
Description
Show server type.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
server_type_id required | string | Server type ID | s1v1m2 |
Responses
| Name | Description | Example |
|---|
| id | Server type ID | s1v1m2 |
| description | Description | description |
| disk | Size of root disk | 100 |
| ephemeral | Size of ephemeral disk | 0 |
| extra_specs | Extra specs | |
| name | Server type name | s1v1m2 |
| ram | Amount of RAM | 2 |
| swap | Size of dedicated swap disk | 0 |
| vcpus | Number of CPUs | 1 |
1.87.2 - 1.0
scpcli virtualserver server type show
--server_type_id <value>
Description
Show server type.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
server_type_id required | string | Server type ID | s1v1m2 |
Responses
| Name | Description | Example |
|---|
| id | Server type ID | s1v1m2 |
| description | Description | description |
| disk | Size of root disk | 100 |
| ephemeral | Size of ephemeral disk | 0 |
| extra_specs | Extra specs | |
| name | Server type name | s1v1m2 |
| ram | Amount of RAM | 2 |
| swap | Size of dedicated swap disk | 0 |
| vcpus | Number of CPUs | 1 |
1.88 - Show Server Volume
1.88.1 - 1.1
scpcli virtualserver server volume show
--volume_id <value>
--server_id <value>
Description
Show Server Volume.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
| Name | Description | Example |
|---|
| id | Volume Attachment ID | 3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c |
| delete_on_termination | Delete on termination | False |
| device | Device name | /dev/vda |
| server_id | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| volume_id | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
1.88.2 - 1.0
scpcli virtualserver server volume show
--volume_id <value>
--server_id <value>
Description
Show Server Volume.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
| Name | Description | Example |
|---|
| id | Volume Attachment ID | 3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c |
| delete_on_termination | Delete on termination | False |
| device | Device name | /dev/vda |
| server_id | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| volume_id | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
1.89 - Show Virtual Server
1.89.1 - 1.1
scpcli virtualserver server show
--server_id <value>
Description
Show Virtual Server.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
| Name | Description | Example |
|---|
| ip_addresses | IP addresses | |
| subnet_name | Subnet name | subnetname |
1.89.2 - 1.0
scpcli virtualserver server show
--server_id <value>
Description
Show Virtual Server.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
| Name | Description | Example |
|---|
| ip_addresses | IP addresses | |
| subnet_name | Subnet name | subnetname |
1.90 - Show Virtual Server Console Log
1.90.1 - 1.1
scpcli virtualserver server console log show
--server_id <value>
[--line_size <value>]
Description
Show Virtual Server Console Log.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
line_size optional | integer | Number of log lines to get | 1 |
Responses
| Name | Description | Example |
|---|
| output | Server console log output | FAKE CONSOLE OUTPUT |
1.90.2 - 1.0
scpcli virtualserver server console log show
--server_id <value>
[--line_size <value>]
Description
Show Virtual Server Console Log.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
line_size optional | integer | Number of log lines to get | 1 |
Responses
| Name | Description | Example |
|---|
| output | Server console log output | FAKE CONSOLE OUTPUT |
1.91 - Show Virtual Server Password
1.91.1 - 1.1
scpcli virtualserver server password show
--server_id <value>
[--private_key <value>]
Description
Show Virtual Server Password.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
private_key optional | string | Private key | privatekey |
Responses
| Name | Description | Example |
|---|
| password | Server password | password |
1.91.2 - 1.0
scpcli virtualserver server password show
--server_id <value>
[--private_key <value>]
Description
Show Virtual Server Password.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
private_key optional | string | Private key | privatekey |
Responses
| Name | Description | Example |
|---|
| password | Server password | password |
1.92 - Show Volume Quota Set
1.92.1 - 1.1
scpcli virtualserver volume quota set show
Description
Show volume quota set.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Responses
| Name | Description | Example |
|---|
| id | Quota set ID | fc7283354c6143a58629b59f4c3e16b2 |
| per_volume_size | Per volume size quota | |
| snapshots | Snapshot Quota | |
| usages | Usage quota | |
| volumes | Volume Quota | |
1.92.2 - 1.0
scpcli virtualserver volume quota set show
Description
Show volume quota set.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Responses
| Name | Description | Example |
|---|
| id | Quota set ID | fc7283354c6143a58629b59f4c3e16b2 |
| per_volume_size | Per volume size quota | |
| snapshots | Snapshot Quota | |
| usages | Usage quota | |
| volumes | Volume Quota | |
1.93 - Show volume transfer detail
1.93.1 - 1.1
scpcli virtualserver volume transfer show
--transfer_id <value>
Description
Show volume transfer detail.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
transfer_id required | string | Transfer ID | 1ac231be-823b-4a4d-8ff0-aac503a7118a |
Responses
| Name | Description | Example |
|---|
| id | Transfer ID | 1ac231be-823b-4a4d-8ff0-aac503a7118a |
| created_at | Created at | |
| name | Volume name | volume01 |
| volume_id | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
1.93.2 - 1.0
scpcli virtualserver volume transfer show
--transfer_id <value>
Description
Show volume transfer detail.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
transfer_id required | string | Transfer ID | 1ac231be-823b-4a4d-8ff0-aac503a7118a |
Responses
| Name | Description | Example |
|---|
| id | Transfer ID | 1ac231be-823b-4a4d-8ff0-aac503a7118a |
| created_at | Created at | |
| name | Volume name | volume01 |
| volume_id | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
1.94 - Show Volume type’s details
1.94.1 - 1.1
scpcli virtualserver volume type show
--volume_type_id <value>
Description
Show a Volume type’s details.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
volume_type_id required | string | Volume type ID | c643ac35-3aec-43e6-b97a-3d6f666c5207 |
Responses
| Name | Description | Example |
|---|
| id | Volume type ID | c643ac35-3aec-43e6-b97a-3d6f666c5207 |
| description | Volume type description | Volume type description |
| extra_specs | Extra specs | |
| name | Volume type name | SSD |
1.94.2 - 1.0
scpcli virtualserver volume type show
--volume_type_id <value>
Description
Show a Volume type’s details.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
volume_type_id required | string | Volume type ID | c643ac35-3aec-43e6-b97a-3d6f666c5207 |
Responses
| Name | Description | Example |
|---|
| id | Volume type ID | c643ac35-3aec-43e6-b97a-3d6f666c5207 |
| description | Volume type description | Volume type description |
| extra_specs | Extra specs | |
| name | Volume type name | SSD |
1.95 - Show Volume's details
1.95.1 - 1.1
scpcli virtualserver volume show
--volume_id <value>
Description
Show a Volume’s details.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
Responses
| Name | Description | Example |
|---|
| id | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| attached_at | The time when the volume was attached to the server. | |
| device | Device name | /dev/vda |
1.95.2 - 1.0
scpcli virtualserver volume show
--volume_id <value>
Description
Show a Volume’s details.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
Responses
| Name | Description | Example |
|---|
| id | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| attached_at | The time when the volume was attached to the server. | |
| device | Device name | /dev/vda |
1.96 - Start Virtual Server
1.96.1 - 1.1
scpcli virtualserver server start
--server_id <value>
Description
Start Virtual Server.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
1.96.2 - 1.0
scpcli virtualserver server start
--server_id <value>
Description
Start Virtual Server.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
1.97 - Stop Virtual Server
1.97.1 - 1.1
scpcli virtualserver server stop
--server_id <value>
Description
Stop Virtual Server.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
1.97.2 - 1.0
scpcli virtualserver server stop
--server_id <value>
Description
Stop Virtual Server.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
1.98 - Unlock Virtual Server
1.98.1 - 1.1
scpcli virtualserver server unlock
--server_id <value>
Description
Unlock Virtual Server.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
1.98.2 - 1.0
scpcli virtualserver server unlock
--server_id <value>
Description
Unlock Virtual Server.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
1.99 - Update a snapshot
1.99.1 - 1.1
scpcli virtualserver volume snapshot set
--snapshot_id <value>
--name <value>
[--description <value>]
Description
Update a snapshot.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
snapshot_id required | string | Snapshot ID | cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 |
name required | string | Snapshot name | snapshot-1 |
description optional | string | Description | description |
1.99.2 - 1.0
scpcli virtualserver volume snapshot set
--snapshot_id <value>
--name <value>
[--description <value>]
Description
Update a snapshot.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
snapshot_id required | string | Snapshot ID | cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 |
name required | string | Snapshot name | snapshot-1 |
description optional | string | Description | description |
1.100 - Update Auto-Scaling Group
1.100.1 - 1.1
scpcli virtualserver auto scaling group set
--auto_scaling_group_id <value>
[--desired_server_count_editable <value>]
[--drain_enabled <value>]
[--drain_timeout <value>]
[--launch_configuration_id <value>]
[--security_group_ids <value>]
Description
Update Auto-Scaling Group.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
desired_server_count_editable optional | boolean | Desired server count editable | True |
drain_enabled optional | boolean | Drain enabled | True |
drain_timeout optional | integer | Drain timeout | 300 |
launch_configuration_id optional | string | Launch Configuration ID | b5aea5a675fc4f6b9e0fcd1288354c5f |
security_group_ids optional | array | Security Group ID list | [ |
1.100.2 - 1.0
scpcli virtualserver auto scaling group set
--auto_scaling_group_id <value>
[--desired_server_count_editable <value>]
[--drain_enabled <value>]
[--drain_timeout <value>]
[--launch_configuration_id <value>]
[--security_group_ids <value>]
Description
Update Auto-Scaling Group.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
desired_server_count_editable optional | boolean | Desired server count editable | True |
drain_enabled optional | boolean | Drain enabled | True |
drain_timeout optional | integer | Drain timeout | 300 |
launch_configuration_id optional | string | Launch Configuration ID | b5aea5a675fc4f6b9e0fcd1288354c5f |
security_group_ids optional | array | Security Group ID list | [ |
1.101 - Update Auto-Scaling Group LB Server Groups
1.101.1 - 1.1
scpcli virtualserver auto scaling group lb server group set
--auto_scaling_group_id <value>
--lb_server_groups <value>
Description
Update Auto-Scaling Group LB Server Groups.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
lb_server_groups required | array | LB Server Group list | '{"id": "d06e87d3-ca9a-461b-8e88-077a542a7335", "port": 8080}' |
1.101.2 - 1.0
scpcli virtualserver auto scaling group lb server group set
--auto_scaling_group_id <value>
--lb_server_groups <value>
Description
Update Auto-Scaling Group LB Server Groups.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
lb_server_groups required | array | LB Server Group list | '{"id": "d06e87d3-ca9a-461b-8e88-077a542a7335", "port": 8080}' |
1.102 - Update Auto-Scaling Group Notification
1.102.1 - 1.1
scpcli virtualserver auto scaling group notification update
--notification_id <value>
--auto_scaling_group_id <value>
[--notification_events <value>]
[--notification_state <value>]
Description
Update Auto-Scaling Group notification.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
notification_id required | string | Notification ID | fa7fd191410744cd810a290c0b4d22b9 |
auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
notification_events optional | array | Auto-Scaling Group notification events | SCALE_OUT |
notification_state optional | string | Auto-Scaling Group notification state | ACTIVE |
1.102.2 - 1.0
scpcli virtualserver auto scaling group notification update
--notification_id <value>
--auto_scaling_group_id <value>
[--notification_events <value>]
[--notification_state <value>]
Description
Update Auto-Scaling Group notification.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
notification_id required | string | Notification ID | fa7fd191410744cd810a290c0b4d22b9 |
auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
notification_events optional | array | Auto-Scaling Group notification events | SCALE_OUT |
notification_state optional | string | Auto-Scaling Group notification state | ACTIVE |
1.103 - Update Auto-Scaling Group Policy
1.103.1 - 1.1
scpcli virtualserver auto scaling group policy set
--policy_id <value>
--auto_scaling_group_id <value>
[--comparison_operator <value>]
[--cooldown_seconds <value>]
[--evaluation_minutes <value>]
[--metric_method <value>]
[--metric_type <value>]
[--name <value>]
[--scale_method <value>]
[--scale_type <value>]
[--scale_value <value>]
[--state <value>]
[--threshold <value>]
Description
Update Auto-Scaling Group policy.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
policy_id required | string | Policy ID | 0761d76085f54363bab07909baf69841 |
auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
comparison_operator optional | string | Comparison operator | ge |
cooldown_seconds optional | integer | Cooldown seconds | 300 |
evaluation_minutes optional | integer | Evaluation minutes | 1 |
metric_method optional | string | Metric method | AVG |
metric_type optional | string | Metric type | CPU |
name optional | string | Policy name | policy-name |
scale_method optional | string | Scale method | AMOUNT |
scale_type optional | string | Scale type | SCALE_OUT |
scale_value optional | integer | Scale value | 10 |
state optional | string | Policy state | ACTIVE |
threshold optional | integer | Threshold | 60 |
1.103.2 - 1.0
scpcli virtualserver auto scaling group policy set
--policy_id <value>
--auto_scaling_group_id <value>
[--comparison_operator <value>]
[--cooldown_seconds <value>]
[--evaluation_minutes <value>]
[--metric_method <value>]
[--metric_type <value>]
[--name <value>]
[--scale_method <value>]
[--scale_type <value>]
[--scale_value <value>]
[--state <value>]
[--threshold <value>]
Description
Update Auto-Scaling Group policy.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
policy_id required | string | Policy ID | 0761d76085f54363bab07909baf69841 |
auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
comparison_operator optional | string | Comparison operator | ge |
cooldown_seconds optional | integer | Cooldown seconds | 300 |
evaluation_minutes optional | integer | Evaluation minutes | 1 |
metric_method optional | string | Metric method | AVG |
metric_type optional | string | Metric type | CPU |
name optional | string | Policy name | policy-name |
scale_method optional | string | Scale method | AMOUNT |
scale_type optional | string | Scale type | SCALE_OUT |
scale_value optional | integer | Scale value | 10 |
state optional | string | Policy state | ACTIVE |
threshold optional | integer | Threshold | 60 |
1.104 - Update Auto-Scaling Group Schedule
1.104.1 - 1.1
scpcli virtualserver auto scaling group schedule set
--schedule_id <value>
--auto_scaling_group_id <value>
[--day_of_month <value>]
[--day_of_week <value>]
[--description <value>]
[--desired_server_count <value>]
[--end_date <value>]
[--frequency <value>]
[--hour <value>]
[--max_server_count <value>]
[--min_server_count <value>]
[--minute <value>]
[--name <value>]
[--start_date <value>]
[--state <value>]
[--timezone <value>]
Description
Update Auto-Scaling Group schedule.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
schedule_id required | string | Schedule ID | 43d4841abd404220af5f0904037aba71 |
auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
day_of_month optional | string | Day of the month | -1,1 |
day_of_week optional | string | Day of the week | SU,SA |
description optional | string | Description | description |
desired_server_count optional | integer | Desired server count | 1 |
end_date optional | string | End date | 2025-01-01 |
frequency optional | **** | Frequency | WEEKLY |
hour optional | integer | Hour | 9 |
max_server_count optional | integer | Max server count | 2 |
min_server_count optional | integer | Min server count | 1 |
minute optional | integer | Minute | 0 |
name optional | string | Schedule name | schedulename |
start_date optional | string | Start date | 2024-01-01 |
state optional | string | Schedule state | ACTIVE |
timezone optional | string | Timezone | Asia/Seoul |
1.104.2 - 1.0
scpcli virtualserver auto scaling group schedule set
--schedule_id <value>
--auto_scaling_group_id <value>
[--day_of_month <value>]
[--day_of_week <value>]
[--description <value>]
[--desired_server_count <value>]
[--end_date <value>]
[--frequency <value>]
[--hour <value>]
[--max_server_count <value>]
[--min_server_count <value>]
[--minute <value>]
[--name <value>]
[--start_date <value>]
[--state <value>]
[--timezone <value>]
Description
Update Auto-Scaling Group schedule.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
schedule_id required | string | Schedule ID | 43d4841abd404220af5f0904037aba71 |
auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
day_of_month optional | string | Day of the month | -1,1 |
day_of_week optional | string | Day of the week | SU,SA |
description optional | string | Description | description |
desired_server_count optional | integer | Desired server count | 1 |
end_date optional | string | End date | 2025-01-01 |
frequency optional | **** | Frequency | WEEKLY |
hour optional | integer | Hour | 9 |
max_server_count optional | integer | Max server count | 2 |
min_server_count optional | integer | Min server count | 1 |
minute optional | integer | Minute | 0 |
name optional | string | Schedule name | schedulename |
start_date optional | string | Start date | 2024-01-01 |
state optional | string | Schedule state | ACTIVE |
timezone optional | string | Timezone | Asia/Seoul |
1.105 - Update Auto-Scaling Group server count
1.105.1 - 1.1
scpcli virtualserver auto scaling group server count set
--auto_scaling_group_id <value>
[--desired_server_count <value>]
[--max_server_count <value>]
[--min_server_count <value>]
Description
Update Auto-Scaling Group server count.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
desired_server_count optional | integer | Desired server count | 1 |
max_server_count optional | integer | Max server count | 2 |
min_server_count optional | integer | Min server count | 1 |
1.105.2 - 1.0
scpcli virtualserver auto scaling group server count set
--auto_scaling_group_id <value>
[--desired_server_count <value>]
[--max_server_count <value>]
[--min_server_count <value>]
Description
Update Auto-Scaling Group server count.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
desired_server_count optional | integer | Desired server count | 1 |
max_server_count optional | integer | Max server count | 2 |
min_server_count optional | integer | Min server count | 1 |
1.106 - Update Image
1.106.1 - 1.1
scpcli virtualserver image set
--image_id <value>
[--min_disk <value>]
[--min_ram <value>]
[--protected <value>]
[--visibility <value>]
Description
Update Image.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
image_id required | string | Image ID | 70a599e0-31e7-49b7-b260-868f441e862b |
min_disk optional | integer | Minimum disk | 100 |
min_ram optional | integer | Minimum RAM | 0 |
protected optional | boolean | Protected | False |
visibility optional | string | Visibility | private |
1.106.2 - 1.0
scpcli virtualserver image set
--image_id <value>
[--min_disk <value>]
[--min_ram <value>]
[--protected <value>]
[--visibility <value>]
Description
Update Image.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
image_id required | string | Image ID | 70a599e0-31e7-49b7-b260-868f441e862b |
min_disk optional | integer | Minimum disk | 100 |
min_ram optional | integer | Minimum RAM | 0 |
protected optional | boolean | Protected | False |
visibility optional | string | Visibility | private |
1.107 - Update Image member
1.107.1 - 1.1
scpcli virtualserver image member set
--member_id <value>
--image_id <value>
--status <value>
Description
Update Image member.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
member_id required | string | Member ID | a8f10467abfc4b87b64614ab36eb9ae4 |
image_id required | string | Image ID | 70a599e0-31e7-49b7-b260-868f441e862b |
status required | string | Member status | pending |
1.107.2 - 1.0
scpcli virtualserver image member set
--member_id <value>
--image_id <value>
--status <value>
Description
Update Image member.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
member_id required | string | Member ID | a8f10467abfc4b87b64614ab36eb9ae4 |
image_id required | string | Image ID | 70a599e0-31e7-49b7-b260-868f441e862b |
status required | string | Member status | pending |
1.108 - Update Server Interface
1.108.1 - 1.1
scpcli virtualserver server interface set
--port_id <value>
--server_id <value>
[--fixed_ip_address <value>]
[--subnet_id <value>]
Description
Update Server Interface.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
port_id required | string | Port ID | 91424c08-0b26-49fb-9808-ed042292ceef |
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
fixed_ip_address optional | string | IP address | 192.169.3.2 |
subnet_id optional | string | Subnet ID | - |
1.108.2 - 1.0
scpcli virtualserver server interface set
--port_id <value>
--server_id <value>
[--fixed_ip_address <value>]
[--subnet_id <value>]
Description
Update Server Interface.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
port_id required | string | Port ID | 91424c08-0b26-49fb-9808-ed042292ceef |
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
fixed_ip_address optional | string | IP address | 192.169.3.2 |
subnet_id optional | string | Subnet ID | - |
1.109 - Update Server Volume
1.109.1 - 1.1
scpcli virtualserver server volume set
--volume_id <value>
--server_id <value>
--volume_id <value>
[--delete_on_termination <value>]
Description
Update Server Volume.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
volume_id required | string | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
delete_on_termination optional | boolean | Delete on termination | False |
1.109.2 - 1.0
scpcli virtualserver server volume set
--volume_id <value>
--server_id <value>
--volume_id <value>
[--delete_on_termination <value>]
Description
Update Server Volume.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
volume_id required | string | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
delete_on_termination optional | boolean | Delete on termination | False |
1.110 - Update Virtual Server
1.110.1 - 1.1
scpcli virtualserver server set
--server_id <value>
--name <value>
Description
Update Virtual Server.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
name required | string | Server name | servername |
1.110.2 - 1.0
scpcli virtualserver server set
--server_id <value>
--name <value>
Description
Update Virtual Server.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
name required | string | Server name | servername |
1.111 - Update Virtual Server type
1.111.1 - 1.1
scpcli virtualserver server type set
--server_id <value>
--server_type <value>
Description
Update Virtual Server type
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
server_type required | string | Server type | s1v1m2 |
Responses
1.111.2 - 1.0
scpcli virtualserver server type set
--server_id <value>
--server_type <value>
Description
Update Virtual Server type
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
server_id required | string | Server ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
server_type required | string | Server type | s1v1m2 |
Responses
1.112 - Update Volume
1.112.1 - 1.1
scpcli virtualserver volume set
--volume_id <value>
[--name <value>]
Description
Update a Volume.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
name optional | string | Volume name | volume01 |
1.112.2 - 1.0
scpcli virtualserver volume set
--volume_id <value>
[--name <value>]
Description
Update a Volume.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
name optional | string | Volume name | volume01 |