이 섹션의 다중 페이지 출력 화면임. 여기를 클릭하여 프린트.

Budget

1: CLIs

1.1: CreateAccountBudget

1.1.1: 1.0

1.2: DeleteAccountBudget

1.2.1: 1.0

1.3: ListAccountBudgets

1.3.1: 1.0

1.4: SetAccountBudget

1.4.1: 1.0

1.5: ShowAccountBudget

1.5.1: 1.0

Overview

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

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

Version

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

Version	Status	Not Before
1.0	CURRENT	-

CLI Version History

1.0

Budget CLI가 출시되었습니다.

변경사항

[신규] budget account budget list [--size {value}] [--page {value}] [--sort {value}] [--search_name {value}] [--budget_name {value}] - ListAccountBudgets 명령어가 추가되었습니다.
[신규] budget account budget show --budget_id {value} - ShowAccountBudget 명령어가 추가되었습니다.
[신규] budget account budget create --unit {value} --start_month {value} --name {value} --amount {value} [--is_use_notification {value}] [--notification_send_period {value}] [--thresholds {value}] [--is_use_prevention {value}] [--threshold {value}] [--notifications_receivers {value}] [--prevention_receivers {value}] - CreateAccountBudget 명령어가 추가되었습니다.
[신규] budget account budget set --budget_id {value} --unit {value} --start_month {value} --name {value} --amount {value} [--is_use_notification {value}] [--notification_send_period {value}] [--thresholds {value}] [--is_use_prevention {value}] [--threshold {value}] [--notifications_receivers {value}] [--prevention_receivers {value}] - SetAccountBudget 명령어가 추가되었습니다.
[신규] budget account budget delete --budget_id {value} - DeleteAccountBudget 명령어가 추가되었습니다.

1 - CLIs

1.1 - CreateAccountBudget

1.1.1 - 1.0

scp-cli budget account budget create
--unit <value>
--start_month <value>
--name <value>
--amount <value>
[--is_use_notification <value>]
[--notification_send_period <value>]
[--thresholds <value>]
[--is_use_prevention <value>]
[--threshold <value>]
[--notifications_receivers <value>]
[--prevention_receivers <value>]

Description

어카운트 예산 생성

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Name	Type	Description	Example
unit required	string	Budget management unit (MONTHLY or OVERALL)	`MONTHLY`
start_month required	string	Budget start month (ex.YYYY-MM)	`2026-01`
name required	string	Budget name	`test_budget`
amount required	integer	Budget amount	`1000000`
is_use_notification optional	boolean	Notification use state	`True`
notification_send_period optional	string	The notification frequency can be FIRST, DAILY, or NONE.	`FIRST`
thresholds optional	array	Thresholds for receiving threshold exceed notification email: 70/80/90/100.	`80`
is_use_prevention optional	boolean	Auto Generation prevent use state	`True`
threshold optional	integer	Threshold for receiving prevention notification email: 70/80/90/100.	`80`
notifications_receivers optional	array	Threshold exceed notification recipient email list.	`test_user1@test.com`
prevention_receivers optional	array	Prevention notification recipient email list.	`test_user1@test.com`

Responses

Name	Description	Example
budget		{}
notifications		{}
prevention		{}

1.2 - DeleteAccountBudget

1.2.1 - 1.0

scp-cli budget account budget delete
--budget_id <value>

Description

어커운트 예산 삭제

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Name	Type	Description	Example
budget_id required	string	Budget id	`240200fd2b02490ca63bb3965048b493`

1.3 - ListAccountBudgets

1.3.1 - 1.0

scp-cli budget account budget list
[--size <value>]
[--page <value>]
[--sort <value>]
[--search_name <value>]
[--budget_name <value>]

Description

어카운트 예산 목록 조회

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
search_name optional	string	Budget name	`my_budget_ex`
budget_name optional	string	Budget name	`my_budget_ex`

Responses

Name	Description	Example
id	Budget id	240200fd2b02490ca63bb3965048b493
amount	Budget amount	1000000
created_at	Created datetime	2025-11-01T00:00:00
created_by	Created user	TEST
modified_at	Modified datetime	2025-11-01T00:00:00
modified_by	Modified user	TEST
name	Budget name	my_budget_ex
start_month	Budget start month (ex.YYYY-MM)	2025-11
type	Budget type	COST
unit	Budget management unit (MONTHLY or OVERALL)	MONTHLY

1.4 - SetAccountBudget

1.4.1 - 1.0

scp-cli budget account budget set
--budget_id <value>
--unit <value>
--start_month <value>
--name <value>
--amount <value>
[--is_use_notification <value>]
[--notification_send_period <value>]
[--thresholds <value>]
[--is_use_prevention <value>]
[--threshold <value>]
[--notifications_receivers <value>]
[--prevention_receivers <value>]

Description

어카운트 예산 수정

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Name	Type	Description	Example
budget_id required	string	Budget id	`240200fd2b02490ca63bb3965048b493`
unit required	string	Budget management unit (MONTHLY or OVERALL)	`MONTHLY`
start_month required	string	Budget start month (ex.YYYY-MM)	`2026-01`
name required	string	Budget name	`test_budget`
amount required	integer	Budget amount	`1000000`
is_use_notification optional	boolean	Notification use state	`True`
notification_send_period optional	string	The notification frequency can be FIRST, DAILY, or NONE.	`FIRST`
thresholds optional	array	Thresholds for receiving threshold exceed notification email: 70/80/90/100.	`80`
is_use_prevention optional	boolean	Auto Generation prevent use state	`True`
threshold optional	integer	Threshold for receiving prevention notification email: 70/80/90/100.	`80`
notifications_receivers optional	array	Threshold exceed notification recipient email list.	`test_user1@test.com`
prevention_receivers optional	array	Prevention notification recipient email list.	`test_user1@test.com`

1.5 - ShowAccountBudget

1.5.1 - 1.0

scp-cli budget account budget show
--budget_id <value>

Description

어카운트 예산 상세 조회

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Name	Type	Description	Example
budget_id required	string	Budget id	`240200fd2b02490ca63bb3965048b493`

Responses

Name	Description	Example
budget		{}
notifications		{}
prevention		{}