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

Return to the regular view of this page.

Budget

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 Budget 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.

VersionStatusNot Before
1.0CURRENT-

CLI Version History

1.0

Initial CLI release for Budget.

Changes

  • [New] budget account budget list [--size {value}] [--page {value}] [--sort {value}] [--search_name {value}] [--budget_name {value}] - ListAccountBudgets commands have been added.
  • [New] budget account budget show --budget_id {value} - ShowAccountBudget commands have been added.
  • [New] 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 commands have been added.
  • [New] 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 commands have been added.
  • [New] budget account budget delete --budget_id {value} - DeleteAccountBudget commands have been added.

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

create a account budget

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
unit
required
stringBudget management unit (MONTHLY or OVERALL)MONTHLY
start_month
required
stringBudget start month (ex.YYYY-MM)2026-01
name
required
stringBudget nametest_budget
amount
required
integerBudget amount1000000
is_use_notification
optional
booleanNotification use stateTrue
notification_send_period
optional
stringThe notification frequency can be FIRST, DAILY, or NONE.FIRST
thresholds
optional
arrayThresholds for receiving threshold exceed notification email: 70/80/90/100.80
is_use_prevention
optional
booleanAuto Generation prevent use stateTrue
threshold
optional
integerThreshold for receiving prevention notification email: 70/80/90/100.80
notifications_receivers
optional
arrayThreshold exceed notification recipient email list.test_user1@test.com
prevention_receivers
optional
arrayPrevention notification recipient email list.test_user1@test.com

Responses

NameDescriptionExample
budget{}
notifications{}
prevention{}

1.2 - DeleteAccountBudget

1.2.1 - 1.0

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

Description

delete a specific account budget

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
budget_id
required
stringBudget id240200fd2b02490ca63bb3965048b493

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

get account budgets list

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
search_name
optional
stringBudget namemy_budget_ex
budget_name
optional
stringBudget namemy_budget_ex

Responses

NameDescriptionExample
idBudget id240200fd2b02490ca63bb3965048b493
amountBudget amount1000000
created_atCreated datetime2025-11-01T00:00:00
created_byCreated userTEST
modified_atModified datetime2025-11-01T00:00:00
modified_byModified userTEST
nameBudget namemy_budget_ex
start_monthBudget start month (ex.YYYY-MM)2025-11
typeBudget typeCOST
unitBudget 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

set a specific account budget

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
budget_id
required
stringBudget id240200fd2b02490ca63bb3965048b493
unit
required
stringBudget management unit (MONTHLY or OVERALL)MONTHLY
start_month
required
stringBudget start month (ex.YYYY-MM)2026-01
name
required
stringBudget nametest_budget
amount
required
integerBudget amount1000000
is_use_notification
optional
booleanNotification use stateTrue
notification_send_period
optional
stringThe notification frequency can be FIRST, DAILY, or NONE.FIRST
thresholds
optional
arrayThresholds for receiving threshold exceed notification email: 70/80/90/100.80
is_use_prevention
optional
booleanAuto Generation prevent use stateTrue
threshold
optional
integerThreshold for receiving prevention notification email: 70/80/90/100.80
notifications_receivers
optional
arrayThreshold exceed notification recipient email list.test_user1@test.com
prevention_receivers
optional
arrayPrevention 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

show a specific account budget

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
budget_id
required
stringBudget id240200fd2b02490ca63bb3965048b493

Responses

NameDescriptionExample
budget{}
notifications{}
prevention{}