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
| Version | Status | Supported Until |
|---|
This is the multi-page printable view of this section. Click here to print.
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
1 - CLIs
1.1 - CreateAccountBudget
1.1.1 - 1.0
scpcli budget account budget create
--unit <value>
--start_month <value>
--name <value>
--amount <value>
[--is_use_notification <value>]
[--notification_send_period <value>]
[--receivers <value>]
[--thresholds <value>]
[--is_use_prevention <value>]
[--threshold <value>]
Description
create a account budget
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 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 |
| receivers optional | array | Prevention notification recipient email list. | test_user1@test.com |
| 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 |
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.2 - DeleteAccountBudget
1.2.1 - 1.0
scpcli budget account budget delete
--budget_id <value>
Description
delete a specific account budget
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| budget_id required | string | Budget id | 240200fd2b02490ca63bb3965048b493 |
1.3 - ListAccountBudgets
1.3.1 - 1.0
scpcli budget account budget list
[--size <value>]
[--page <value>]
[--sort <value>]
[--search_name <value>]
[--budget_name <value>]
Description
get account budgets list
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 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
scpcli budget account budget set
--budget_id <value>
--unit <value>
--start_month <value>
--name <value>
--amount <value>
[--is_use_notification <value>]
[--notification_send_period <value>]
[--receivers <value>]
[--thresholds <value>]
[--is_use_prevention <value>]
[--threshold <value>]
Description
set a specific account budget
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 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 |
| receivers optional | array | Prevention notification recipient email list. | test_user1@test.com |
| 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 |
1.5 - ShowAccountBudget
1.5.1 - 1.0
scpcli budget account budget show
--budget_id <value>
Description
show a specific account budget
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| budget_id required | string | Budget id | 240200fd2b02490ca63bb3965048b493 |
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 |