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

Return to the regular view of this page.

Product

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 PRODUCT 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-

1 - CLIs

1.1 - List Product Categories

1.1.1 - 1.0

scpcli product product categories list
[--limit <value>]
[--page <value>]
[--display_name <value>]
[--display_name_ko <value>]
[--is_exposed_menu <value>]
[--created_by <value>]
[--modified_by <value>]
[--created_start_date <value>]
[--created_end_date <value>]
[--modified_start_date <value>]
[--modified_end_date <value>]
[--sort <value>]

Description

List product categories

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
limit
optional
integerLIMIT10
page
optional
integerPage1
display_name
optional
arrayProduct Category NameN
display_name_ko
optional
arrayProduct Category NameN
is_exposed_menu
optional
arrayProduct Category Menu Exposed StatusT
created_by
optional
stringCreated by김삼성
modified_by
optional
stringModified by김삼성
created_start_date
optional
stringCreated start date2024-01-01T00:00:00
created_end_date
optional
stringCreated end date2024-01-01T00:00:00
modified_start_date
optional
stringModified start date2024-01-01T00:00:00
modified_end_date
optional
stringModified end date2024-01-01T00:00:00
sort
optional
stringSortcreated_at:asc

Responses

NameDescriptionExample
category_idProduct Category IDNETWORKING
created_atCreated date2024-01-01T00:00:00
created_byCreated by5cada9f6afa049418c4f18c0c4859202
display_nameProduct Category NameNetworking
display_name_koProduct Category NameNetworking
icon_file_idIcon File IDc1d5c1f63bf24f73b32c37f6f7b50310
is_exposed_menuProduct Category Menu Exposed StatusTrue
modified_atModified date2024-01-01T00:00:00
modified_byModified by5cada9f6afa049418c4f18c0c4859202
seqSeq9
service_group_color_idService Group Colorffff00

1.2 - List Products

1.2.1 - 1.0

scpcli product product list
[--limit <value>]
[--page <value>]
[--product_category_id <value>]
[--product_id <value>]
[--display_name <value>]
[--display_name_ko <value>]
[--kind <value>]
[--created_start_date <value>]
[--created_end_date <value>]
[--modified_start_date <value>]
[--modified_end_date <value>]
[--sort <value>]

Description

List products.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
limit
optional
integerLIMIT10
page
optional
integerPage1
product_category_id
optional
arrayProduct Category IDN
product_id
optional
arrayProduct IDV
display_name
optional
arrayProduct nameV
display_name_ko
optional
arrayProduct nameV
kind
optional
arrayProduct KindP
created_start_date
optional
stringCreated start date2024-01-01T00:00:00
created_end_date
optional
stringCreated end date2024-01-01T00:00:00
modified_start_date
optional
stringModified start date2024-01-01T00:00:00
modified_end_date
optional
stringModified end date2024-01-01T00:00:00
sort
optional
stringSortcreated_at:asc

Responses

NameDescriptionExample
created_atCreated date2024-01-01T00:00:00
created_byCreated by5cada9f6afa049418c4f18c0c4859202
display_nameProduct nameVPC
display_name_koProduct nameVPC
kindProduct KindPRODUCT
modified_atModified date2024-01-01T00:00:00
modified_byModified by5cada9f6afa049418c4f18c0c4859202
product_category_idProduct Category IDNETWORKING
product_category_nameProduct Category NameNetworking
product_idProduct IDVPC

1.3 - Show Product

1.3.1 - 1.0

scpcli product product show
--product_id <value>

Description

Show product.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
product_id
required
stringProduct IDVPC

Responses

NameDescriptionExample
created_atCreated date2024-01-01T00:00:00
created_byCreated by5cada9f6afa049418c4f18c0c4859202
display_nameProduct nameVPC
display_name_koProduct nameVPC
kindProduct KindPRODUCT
modified_atModified date2024-01-01T00:00:00
modified_byModified by5cada9f6afa049418c4f18c0c4859202
product_category_idProduct Category IDNETWORKING
product_category_nameProduct Category NameNetworking
product_idProduct IDVPC

1.4 - Show Product category

1.4.1 - 1.0

scpcli product product category show
--category_id <value>

Description

Show product category.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
category_id
required
stringProduct Category IDNETWORKING

Responses

NameDescriptionExample
category_idProduct Category IDNETWORKING
created_atCreated date2024-01-01T00:00:00
created_byCreated by5cada9f6afa049418c4f18c0c4859202
display_nameProduct Category NameNetworking
display_name_koProduct Category NameNetworking
icon_file_idIcon File IDc1d5c1f63bf24f73b32c37f6f7b50310
is_exposed_menuProduct Category Menu Exposed StatusTrue
modified_atModified date2024-01-01T00:00:00
modified_byModified by5cada9f6afa049418c4f18c0c4859202
seqSeq9
service_group_color_idService Group Colorffff00