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

Return to the regular view of this page.

BillingPlan

1: CLIs

1.1: Change Request Planned Compute

1.1.1: 1.0

1.2: Create Request Planned Computes

1.2.1: 1.0

1.3: Get Planned Compute

1.3.1: 1.0

1.4: GetCancellationFee

1.4.1: 1.0

1.5: List Contract Type

1.5.1: 1.0

1.6: List OS System

1.6.1: 1.0

1.7: List Planned Compute Covered Resource

1.7.1: 1.0

1.8: ListServerType

1.8.1: 1.0

1.9: ListServiceType

1.9.1: 1.0

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 BillingPlan service and how to call CLI.

Version

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

Version	Status	Not Before
1.0	CURRENT	-

1 - CLIs

1.1 - Change Request Planned Compute

1.1.1 - 1.0

scpcli billingplan set planned compute
--planned_compute_id <value>
[--action <value>]
[--contract_type <value>]
[--server_type <value>]

Description

Change action request planned compute.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
planned_compute_id required	string	Planned Compute Id	`5f3688a192094ddeb0c94166a3e88935`
action optional	string	Planned Compute change request action type	`EXTEND_CHANGE`
contract_type optional	****	Contract type is required in the case of EXTEND_APPLY or EXTEND_CHANGE	`01`
server_type optional	string	Server Type is required in the case of SERVER_TYPE_CHANGE	`s1v1m2`

1.2 - Create Request Planned Computes

1.2.1 - 1.0

scpcli billingplan create planned computes
--service_id <value>
--server_type <value>
--os_type <value>
--contract_type <value>
[--service_name <value>]
[--tag <value>]

Description

Create request planned compute.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
service_id required	string	Service Id	`VIRTUAL_SERVER`
server_type required	string	Server Type	`s1v1m2`
os_type required	string	OS Type	`OPEN_SOURCE`
contract_type required	string	Contract Type	`01`
service_name optional	string	Service Name	`Virtual Server`
tag optional	array	Tag Form	`'{"key": "key1", "value": "value1"}'`

Responses

Name	Description	Example
id	Planned Compute Id	5f3688a192094ddeb0c94166a3e88935
account_id	Account Id	228cb9e4a7934f84853594c7f26f7a21
contract_id	Contract Id	C002612775
contract_type	Contract Type	1-year
created_at	Created date	2024-08-01 00:00:00
created_by	Created by	user123
delete_yn	Delete or not	N
end_date	End date (YYYY-MM-dd)	2024-08-01
first_contract_start_at	Start date (YYYY-MM-dd)	2024-08-01
modified_at	Modified date	2024-08-01 00:00:00
modified_by	Modified by	kim
next_contract_type	Next Contract Type	1-year
next_end_date	Next End date (YYYY-MM-dd)	2024-08-31
next_start_date	Next Start date (YYYY-MM-dd)	2024-08-01
os_name	OS Name	Open Source
os_type	OS Type	OPEN_SOURCE
region	Region	kr-west1
resource_name	Resource Name	test-vm
resource_type	Resource Type	instance
server_type	Server Type	s1v1m2
server_type_description	Server Type Description
service_id	Service Id	VIRTUAL_SERVER
service_name	Service Name	Virtual Server
srn	SRN	srn:e::26affb52e16944038a0cd2cc26060e1c:kr1-west1::compute:instance/INSTANCE-UPOg3Z6ZqyiMM0QyC3sI2m
start_date	Start date (YYYY-MM-dd)	2024-08-01
state	Planned Compute State	ACTIVE

1.3 - Get Planned Compute

1.3.1 - 1.0

scpcli billingplan get planned computes
--planned_compute_id <value>

Description

Get planned compute.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
planned_compute_id required	string	Planned Compute Id	`5f3688a192094ddeb0c94166a3e88935`

Responses

Name	Description	Example
id	Planned Compute Id	5f3688a192094ddeb0c94166a3e88935
account_id	Account Id	228cb9e4a7934f84853594c7f26f7a21
contract_id	Contract Id	C002612775
contract_type	Contract Type	1-year
created_at	Created date	2024-08-01 00:00:00
created_by	Created by	user123
delete_yn	Delete or not	N
end_date	End date (YYYY-MM-dd)	2024-08-01
first_contract_start_at	Start date (YYYY-MM-dd)	2024-08-01
modified_at	Modified date	2024-08-01 00:00:00
modified_by	Modified by	kim
next_contract_type	Next Contract Type	1-year
next_end_date	Next End date (YYYY-MM-dd)	2024-08-31
next_start_date	Next Start date (YYYY-MM-dd)	2024-08-01
os_name	OS Name	Open Source
os_type	OS Type	OPEN_SOURCE
region	Region	kr-west1
resource_name	Resource Name	test-vm
resource_type	Resource Type	instance
server_type	Server Type	s1v1m2
server_type_description	Server Type Description
service_id	Service Id	VIRTUAL_SERVER
service_name	Service Name	Virtual Server
srn	SRN	srn:e::26affb52e16944038a0cd2cc26060e1c:kr1-west1::compute:instance/INSTANCE-UPOg3Z6ZqyiMM0QyC3sI2m
start_date	Start date (YYYY-MM-dd)	2024-08-01
state	Planned Compute State	ACTIVE

1.4 - GetCancellationFee

1.4.1 - 1.0

scpcli billingplan get cancellation fee
--planned_compute_id <value>
[--region <value>]

Description

Get Cancellation Fee

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
planned_compute_id required	array	Planned Compute Id	`5`
region optional	string	Region	`kr-west1`

Responses

Name	Description	Example
code	Currency code	KRW
symbol	Currency Symbol	₩

1.5 - List Contract Type

1.5.1 - 1.0

scpcli billingplan list planned compute contract types
[--service_id <value>]
[--server_type <value>]

Description

Get Contract Type List.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
service_id optional	string	Service Id	`VIRTUAL_SERVER`
server_type optional	string	Server Type	`s1v1m2`

Responses

Name	Description	Example
code	Contract Code	01
display_name	Display Name	1-year

1.6 - List OS System

1.6.1 - 1.0

scpcli billingplan list os types
[--service_id <value>]

Description

Get Os System List.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
service_id optional	string	Service Id	`VIRTUAL_SERVER`

Responses

Name	Description	Example
display_name	Display Name	Open Source
os_type_id	OS Type id	OPEN_SOURCE
os_type_value	Display Name	opensource

1.7 - List Planned Compute Covered Resource

1.7.1 - 1.0

scpcli billingplan list planned compute instances
--end_date <value>
--start_date <value>
--server_type <value>
--os_type <value>
--service_id <value>

Description

Get Planned Compute Covered Resource List.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
end_date required	string	End date (YYYY-MM-dd)	`2024-08-01`
start_date required	string	Start date (YYYY-MM-dd)	`2024-08-01`
server_type required	string	Server Type	`s1v1m2`
os_type required	string	OS Type	`OPEN_SOURCE`
service_id required	string	Service Id	`VIRTUAL_SERVER`

Responses

Name	Description	Example
contract_id	Contract Id	C002612775
non_applied_amount	Non Applied Amount
request_at	Request At	2024-08-01 00:00:00
resource_name	Resource Name	test-vm
unit_price	Unit Price
used_amount	Used amount
used_time	Used time Hour	10

1.8 - ListServerType

1.8.1 - 1.0

scpcli billingplan list planned compute server types
[--service_id <value>]
[--current_server_type <value>]
[--os_type <value>]

Description

Get Server Type List

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
service_id optional	string	Service Id	`VIRTUAL_SERVER`
current_server_type optional	string	Server Type	`s1v1m2`
os_type optional	string	OS Type	`OPEN_SOURCE`

Responses

Name	Description	Example
core	Instance Core	1
gpu_name	Gpu Model Name	a100
instance_type	Instance Type	s1
memory_gb	Instance Memory GB	2
scale_up_yn	Scale up or not. If server_type > current_server_type, it’s represented as Y. if smaller N.	Y
server_type	Server Type	s1v1m2
server_type_description	Server Type Description

1.9 - ListServiceType

1.9.1 - 1.0

scpcli billingplan list planned compute service types

Description

Get Service Type List

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Responses

Name	Description	Example
display_name	Display Name	Virtual Server
service_id	Service Id	VIRTUAL_SERVER