CostExplorer

Overview

SCP에서 제공하는 CostExplorer 서비스를 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 CostExplorer 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0CURRENT-

1 - CLIs

1.1 - GetPaymentMonthly

1.1.1 - 1.0

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

Description

Get payment monthly data.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
size
optional
integerSize10
page
optional
integerPage1

Responses

NameDescriptionExample
payer_account_idPayer Account Id228cb9e4a7934f84853594c7f26f7a21
payer_account_namePayer Account Nametest-account
payer_account_typePayer Account TypeMEMBER
bill_year_monthBill year Month2024-08
used_year_monthYear-Month (YYYY-mm)2024-08
payment_datePayment date2024-08-01
bill_currencyCurrencyKRW
payment_currencyCurrencyKRW
payment_stateBilling StatePAID
bill_amount
used_amount
unpaid_amount
paid_amount
accumulated_unpaid_amount
suspended_year_monthYear-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.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
start_year_month
optional
stringStart year-month (YYYY-mm)2024-08
end_year_month
optional
stringEnd year-month (YYYY-mm)2024-08
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
account_id
optional
stringAccount Id228cb9e4a7934f84853594c7f26f7a21
service_category
optional
stringService CategoryCOMPUTE
billing_item_id
optional
stringBilling Item IdVIRTUAL_SERVER
resource_name
optional
stringResource Nametest-vm
region
optional
stringRegionkr-west1
contract_id
optional
stringContract IdC002612775
order_status
optional
stringCCBS Order Status04
bill_year_month
optional
stringBill Date (YYYY-MM)2024-07
bill_state
optional
stringBilling StateUSED

Responses

NameDescriptionExample
idBill Id5f3688a192094ddeb0c94166a3e88935
amountsTotal Amounts{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
discount_amountsTotal Discount Amounts{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
assetAsset amount{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
operationOperation amount{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
optionOption amount{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
support_planSupport Plan{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
cancellation_fee해지 수수료{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
planned_computePlanned Compute{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
msp_discountMSP 할인{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
new_business_discount신규 사업 할인{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
sales_discount영업(기타) 할인{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
sla_discountSLA{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
reseller_discount리셀러 할인{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
account_cost_savingsAccount Cost Savings{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
project_cost_savingsProject Cost Savings{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
account_creditAccount Credit{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
project_creditProject Credit{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
edpEDP{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
account_idAccount Id228cb9e4a7934f84853594c7f26f7a21
service_categoryService CategoryCOMPUTE
billing_item_idBilling Item IdVIRTUAL_SERVER
resource_idResource Id7f6741f3-d9f0-4262-9a5f-627e373567a7
resource_nameResource Nametest-vm
regionRegionkr-west1
contract_idContract IdC002612775
order_statusCCBS Order Status04
bill_year_monthBill year Month2024-07
bill_stateBilling StateUSED

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.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
start_date
optional
stringStart date (YYYY-MM-dd)2024-08-01
end_date
optional
stringEnd date (YYYY-MM-dd)2024-08-01
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
account_id
optional
stringAccount Id228cb9e4a7934f84853594c7f26f7a21
service_category
optional
stringService CategoryCOMPUTE
billing_item_id
optional
stringBilling Item IdVIRTUAL_SERVER
resource_name
optional
stringResource Nametest-vm
region
optional
stringRegionkr-west1
contract_id
optional
stringContract IdC002612775
order_status
optional
stringCCBS Order Status04

Responses

NameDescriptionExample
idUsages Id5f3688a192094ddeb0c94166a3e88935
account_idAccount Id228cb9e4a7934f84853594c7f26f7a21
service_categoryService CategoryCOMPUTE
billing_item_idBilling Item IdVIRTUAL_SERVER
ccbs_product_codeCCBS Product CodePD00013862
resource_idResource Id7f6741f3-d9f0-4262-9a5f-627e373567a7
contract_idContract IdC002612775
order_statusCCBS Order Status04
usage_dateUsage date2024-08-01T00:00:00
amountsAmount{‘krw’: ‘500.0000000000’, ‘usd’: ‘0.0’}
status_codeUsage status code0