Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 PRODUCT 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | CURRENT | - |
이 섹션의 다중 페이지 출력 화면임. 여기를 클릭하여 프린트.
Product
- 1: CLIs
- 1.1: List Product Categories
- 1.1.1: 1.0
- 1.2: List Products
- 1.2.1: 1.0
- 1.3: Show Product
- 1.3.1: 1.0
- 1.4: Show Product category
- 1.4.1: 1.0
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
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| limit optional | integer | LIMIT | 10 |
| page optional | integer | Page | 1 |
| display_name optional | array | Product Category Name | N |
| display_name_ko optional | array | Product Category Name | N |
| is_exposed_menu optional | array | Product Category Menu Exposed Status | T |
| created_by optional | string | Created by | 김삼성 |
| modified_by optional | string | Modified by | 김삼성 |
| created_start_date optional | string | Created start date | 2024-01-01T00:00:00 |
| created_end_date optional | string | Created end date | 2024-01-01T00:00:00 |
| modified_start_date optional | string | Modified start date | 2024-01-01T00:00:00 |
| modified_end_date optional | string | Modified end date | 2024-01-01T00:00:00 |
| sort optional | string | Sort | created_at:asc |
Responses
| Name | Description | Example |
|---|---|---|
| category_id | Product Category ID | NETWORKING |
| created_at | Created date | 2024-01-01T00:00:00 |
| created_by | Created by | 5cada9f6afa049418c4f18c0c4859202 |
| display_name | Product Category Name | Networking |
| display_name_ko | Product Category Name | Networking |
| icon_file_id | Icon File ID | c1d5c1f63bf24f73b32c37f6f7b50310 |
| is_exposed_menu | Product Category Menu Exposed Status | True |
| modified_at | Modified date | 2024-01-01T00:00:00 |
| modified_by | Modified by | 5cada9f6afa049418c4f18c0c4859202 |
| seq | Seq | 9 |
| service_group_color_id | Service Group Color | ffff00 |
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.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| limit optional | integer | LIMIT | 10 |
| page optional | integer | Page | 1 |
| product_category_id optional | array | Product Category ID | N |
| product_id optional | array | Product ID | V |
| display_name optional | array | Product name | V |
| display_name_ko optional | array | Product name | V |
| kind optional | array | Product Kind | P |
| created_start_date optional | string | Created start date | 2024-01-01T00:00:00 |
| created_end_date optional | string | Created end date | 2024-01-01T00:00:00 |
| modified_start_date optional | string | Modified start date | 2024-01-01T00:00:00 |
| modified_end_date optional | string | Modified end date | 2024-01-01T00:00:00 |
| sort optional | string | Sort | created_at:asc |
Responses
| Name | Description | Example |
|---|---|---|
| created_at | Created date | 2024-01-01T00:00:00 |
| created_by | Created by | 5cada9f6afa049418c4f18c0c4859202 |
| display_name | Product name | VPC |
| display_name_ko | Product name | VPC |
| kind | Product Kind | PRODUCT |
| modified_at | Modified date | 2024-01-01T00:00:00 |
| modified_by | Modified by | 5cada9f6afa049418c4f18c0c4859202 |
| product_category_id | Product Category ID | NETWORKING |
| product_category_name | Product Category Name | Networking |
| product_id | Product ID | VPC |
1.3 - Show Product
1.3.1 - 1.0
scpcli product product show
--product_id <value>
Description
Show product.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| product_id required | string | Product ID | VPC |
Responses
| Name | Description | Example |
|---|---|---|
| created_at | Created date | 2024-01-01T00:00:00 |
| created_by | Created by | 5cada9f6afa049418c4f18c0c4859202 |
| display_name | Product name | VPC |
| display_name_ko | Product name | VPC |
| kind | Product Kind | PRODUCT |
| modified_at | Modified date | 2024-01-01T00:00:00 |
| modified_by | Modified by | 5cada9f6afa049418c4f18c0c4859202 |
| product_category_id | Product Category ID | NETWORKING |
| product_category_name | Product Category Name | Networking |
| product_id | Product ID | VPC |
1.4 - Show Product category
1.4.1 - 1.0
scpcli product product category show
--category_id <value>
Description
Show product category.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| category_id required | string | Product Category ID | NETWORKING |
Responses
| Name | Description | Example |
|---|---|---|
| category_id | Product Category ID | NETWORKING |
| created_at | Created date | 2024-01-01T00:00:00 |
| created_by | Created by | 5cada9f6afa049418c4f18c0c4859202 |
| display_name | Product Category Name | Networking |
| display_name_ko | Product Category Name | Networking |
| icon_file_id | Icon File ID | c1d5c1f63bf24f73b32c37f6f7b50310 |
| is_exposed_menu | Product Category Menu Exposed Status | True |
| modified_at | Modified date | 2024-01-01T00:00:00 |
| modified_by | Modified by | 5cada9f6afa049418c4f18c0c4859202 |
| seq | Seq | 9 |
| service_group_color_id | Service Group Color | ffff00 |