1 - Product

Overview

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

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

Version

VersionStatusSupported Until
1.0CURRENT-

1.1 - CLIs

1.1.1 - List Product Categories

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

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.1.2 - List Products

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

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.1.3 - Show Product

1.1.3.1 - 1.0

scpcli product product show
--product_id <value>

Description

Show product.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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.1.4 - Show Product category

1.1.4.1 - 1.0

scpcli product product category show
--category_id <value>

Description

Show product category.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
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

2 - STS

Overview

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

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

Version

VersionStatusSupported Until
1.0CURRENT-

2.1 - CLIs

2.1.1 - Acquire temporary role credential

2.1.1.1 - 1.0

scpcli sts sts assume role
--role_session_name <value>
--role_indicator <value>
[--duration_seconds <value>]

Description

Acquire temporary role credential

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
role_session_name
required
stringIdentifier for the assumed role session-
role_indicator
required
stringIdentifier of the role to assume. [offering:account_id:role_name]-
duration_seconds
optional
integerDuration of seconds of the role session-

Responses

NameDescriptionExample
assumed_role_userSRN and assumed role ID
credentialsTemporary security credentials

2.1.2 - Acquire temporary role credential from SAML Assertion

2.1.2.1 - 1.0

scpcli sts sts assume role with saml
--saml_assertion <value>
--role_indicator <value>
--principal_indicator <value>
[--duration_seconds <value>]

Description

Acquire temporary role credential from SAML Assertion

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
saml_assertion
required
stringBASE64 encoded SAML response-
role_indicator
required
stringIdentifier of the role to assume. [offering:account_id:role_name]-
principal_indicator
required
stringIdentifier of the SAML provider in IAM. [offering:account_id:provider_name]-
duration_seconds
optional
integerDuration of seconds of the role session-

Responses

NameDescriptionExample
assumed_role_userSRN and assumed role ID
audienceValue of Recipient attribute of SubjectConfirmationData element of SAML
credentialsTemporary security credentials
issuerValue of Issuer element of SAML
subjectValue of NameID element in the Subject element of SAML
subject_typeFormat of nameID

2.1.3 - Create new Signature based on Session Token

2.1.3.1 - 1.0

scpcli sts sts object store authorization
--x_amz_date <value>
--x_amz_content_sha256 <value>
--url <value>
--method <value>
[--region <value>]
[--service <value>]

Description

Create new Signature based on Session Token

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
x_amz_date
required
stringDate and time at which the request is signed-
x_amz_content_sha256
required
stringSHA256 hash of the request body-
url
required
stringThe URL of the request-
method
required
stringHTTP method used in the request-
region
optional
stringRegion where the request is made-
service
optional
stringService to which the request is made-

Responses

NameDescriptionExample
AuthorizationAuthorization header for object store authentication