CostExplorer

1: CLIs

1.1: GetPaymentMonthly

1.1.1: 1.0

1.2: ListBills

1.2.1: 1.0

1.3: ListUsages

1.3.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 CostExplorer 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 - GetPaymentMonthly

1.1.1 - 1.0

scpcli costexplorer payment monthly show
[--size <value>]
[--page <value>]

Description

Get payment monthly data.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
size optional	integer	Size	`10`
page optional	integer	Page	`1`

Responses

Name	Description	Example
accumulated_unpaid_amount
bill_amount
bill_currency	Currency	KRW
bill_year_month	Bill year Month	2024-08
paid_amount
payer_account_id	Payer Account Id	228cb9e4a7934f84853594c7f26f7a21
payer_account_name	Payer Account Name	test-account
payer_account_type	Payer Account Type	MEMBER
payment_currency	Currency	KRW
payment_date	Payment date	2024-08-01
payment_state	Billing State	PAID
suspended_year_month	Year-Month (YYYY-mm)	2024-08
unpaid_amount
used_amount
used_year_month	Year-Month (YYYY-mm)	2024-08

1.2 - ListBills

1.2.1 - 1.0

scpcli costexplorer bill list
[--start_year_month <value>]
[--end_year_month <value>]
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--account_id <value>]
[--service_category <value>]
[--billing_item_id <value>]
[--resource_name <value>]
[--region <value>]
[--contract_id <value>]
[--order_status <value>]
[--bill_year_month <value>]
[--bill_state <value>]

Description

Get bill list.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
start_year_month optional	string	Start year-month (YYYY-mm)	`2024-08`
end_year_month optional	string	End year-month (YYYY-mm)	`2024-08`
with_count optional	string	with count	`true`
limit optional	integer	limit	`20`
marker optional	string	marker	`607e0938521643b5b4b266f343fae693`
sort optional	string	sort	`created_at:desc`
account_id optional	string	Account Id	`228cb9e4a7934f84853594c7f26f7a21`
service_category optional	string	Service Category	`COMPUTE`
billing_item_id optional	string	Billing Item Id	`VIRTUAL_SERVER`
resource_name optional	string	Resource Name	`test-vm`
region optional	string	Region	`kr-west1`
contract_id optional	string	Contract Id	`C002612775`
order_status optional	string	CCBS Order Status	`04`
bill_year_month optional	string	Bill Date (YYYY-MM)	`2024-07`
bill_state optional	string	Billing State	`USED`

Responses

Name	Description	Example
id	Bill Id	5f3688a192094ddeb0c94166a3e88935
account_cost_savings	Account Cost Savings	{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
account_credit	Account Credit	{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
account_id	Account Id	228cb9e4a7934f84853594c7f26f7a21
amounts	Total Amounts	{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
asset	Asset amount	{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
bill_state	Billing State	USED
bill_year_month	Bill year Month	2024-07
billing_item_id	Billing Item Id	VIRTUAL_SERVER
cancellation_fee	해지 수수료	{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
contract_id	Contract Id	C002612775
discount_amounts	Total Discount Amounts	{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
edp	EDP	{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
msp_discount	MSP 할인	{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
new_business_discount	신규 사업 할인	{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
operation	Operation amount	{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
option	Option amount	{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
order_status	CCBS Order Status	04
planned_compute	Planned Compute	{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
project_cost_savings	Project Cost Savings	{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
project_credit	Project Credit	{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
region	Region	kr-west1
reseller_discount	리셀러 할인	{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
resource_id	Resource Id	7f6741f3-d9f0-4262-9a5f-627e373567a7
resource_name	Resource Name	test-vm
sales_discount	영업(기타) 할인	{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
service_category	Service Category	COMPUTE
sla_discount	SLA	{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
support_plan	Support Plan	{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}

1.3 - ListUsages

1.3.1 - 1.0

scpcli costexplorer usages list
[--start_date <value>]
[--end_date <value>]
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--account_id <value>]
[--service_category <value>]
[--billing_item_id <value>]
[--resource_name <value>]
[--region <value>]
[--contract_id <value>]
[--order_status <value>]

Description

Get usage list.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
start_date optional	string	Start date (YYYY-MM-dd)	`2024-08-01`
end_date optional	string	End date (YYYY-MM-dd)	`2024-08-01`
with_count optional	string	with count	`true`
limit optional	integer	limit	`20`
marker optional	string	marker	`607e0938521643b5b4b266f343fae693`
sort optional	string	sort	`created_at:desc`
account_id optional	string	Account Id	`228cb9e4a7934f84853594c7f26f7a21`
service_category optional	string	Service Category	`COMPUTE`
billing_item_id optional	string	Billing Item Id	`VIRTUAL_SERVER`
resource_name optional	string	Resource Name	`test-vm`
region optional	string	Region	`kr-west1`
contract_id optional	string	Contract Id	`C002612775`
order_status optional	string	CCBS Order Status	`04`

Responses

Name	Description	Example
id	Usages Id	5f3688a192094ddeb0c94166a3e88935
account_id	Account Id	228cb9e4a7934f84853594c7f26f7a21
amounts	Amount	{‘krw’: ‘500.0000000000’, ‘usd’: ‘0.0’}
billing_item_id	Billing Item Id	VIRTUAL_SERVER
ccbs_product_code	CCBS Product Code	PD00013862
contract_id	Contract Id	C002612775
order_status	CCBS Order Status	04
resource_id	Resource Id	7f6741f3-d9f0-4262-9a5f-627e373567a7
service_category	Service Category	COMPUTE
status_code	Usage status code	0
usage_date	Usage date	2024-08-01T00:00:00