이 섹션의 다중 페이지 출력 화면임. 여기를 클릭하여 프린트.

이 페이지의 일반 화면으로 돌아가기.

Secrets Manager

Overview

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

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

Version

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

VersionStatusNot Before
1.1CURRENT-
1.0SUPPORTED20260831

1 - CLIs

1.1 - Create Secret

1.1.1 - 1.1

scpcli secretsmanager secret create
--secret_value <value>
--name <value>
--kms_id <value>
--acl_cidr <value>
[--description <value>]
[--private_acl_enabled <value>]
[--private_acl_resources <value>]
[--tags <value>]

Description

Secret 을 생성합니다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
secret_value
required		stringThe value of a Secret can be entered as a JSON string in key/value format, up to 10 pairs.{"key1":"value1","key2":"value2"}
name
required		stringSecret 이름name
kms_id
required		stringResource ID created in the Key Management Service (KMS) product3265ab469f0d406d83073da3e11e7a6c
acl_cidr
required		stringSecret 접근허용 CIDR 리스트192.168.1.1/24, 10.0.0.1/16
description
optional		stringSecret 설명description
private_acl_enabled
optional		boolean프라이빗 접근 제어 활성화true
private_acl_resources
optional		array프라이빗 접근 제어 자원들'{"resource_id": ""}'
tags
optional		arrayTag List''{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id계정 id3265ab469f0d406d83073da3e11e7a6c
acl_cidrSecret 접근허용 CIDR 리스트192.168.1.1/24, 10.0.0.1/16
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
deleted_at삭제 날짜2025-02-25 03:07:17.000
descriptionSecret 설명description
kms_idKey Management Service 상품에서 생성한 자원 ID3265ab469f0d406d83073da3e11e7a6c
kms_nameKMS 키 이름kmsname
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name키 이름my-secret-name
private_acl_enabled프라이빗 접근 제어 활성화true
private_acl_resources프라이빗 접근 제어 자원들
recent_searched_at최근 검색일2025-02-25 03:07:17.000
state키 상태(Creating, Active, Error, Stop, To_Be_Terminated)Active
typeSecret 타입General

1.1.2 - 1.0

scpcli secretsmanager secret create
--secret_value <value>
--name <value>
--kms_id <value>
--acl_cidr <value>
[--description <value>]
[--tags <value>]

Description

Secret 을 생성합니다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260831

Parameters

NameTypeDescriptionExample
secret_value
required		stringThe value of a Secret can be entered as a JSON string in key/value format, up to 10 pairs.{"key1":"value1","key2":"value2"}
name
required		stringSecret 이름name
kms_id
required		stringResource ID created in the Key Management Service (KMS) product3265ab469f0d406d83073da3e11e7a6c
acl_cidr
required		stringSecret 접근허용 CIDR 리스트192.168.1.1/24, 10.0.0.1/16
description
optional		stringSecret 설명description
tags
optional		arrayTag List''{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id계정 id3265ab469f0d406d83073da3e11e7a6c
acl_cidrSecret 접근허용 CIDR 리스트192.168.1.1/24, 10.0.0.1/16
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
deleted_at삭제 날짜2025-02-25 03:07:17.000
descriptionSecret 설명description
kms_idKey Management Service 상품에서 생성한 자원 ID3265ab469f0d406d83073da3e11e7a6c
kms_nameKMS 키 이름kmsname
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name키 이름my-secret-name
recent_searched_at최근 검색일2025-02-25 03:07:17.000
state키 상태(Creating, Active, Error, Stop, To_Be_Terminated)Active
typeSecret 타입General

1.2 - Delete Secret

1.2.1 - 1.1

scpcli secretsmanager secret delete
--secret_id <value>
--waiting_time_ndays <value>

Description

Secret을 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
secret_id
required		stringSecret 아이디3265ab469f0d406d83073da3e11e7a6c
waiting_time_ndays
required		integer삭제까지 남은 일수7

1.2.2 - 1.0

scpcli secretsmanager secret delete
--secret_id <value>
--waiting_time_ndays <value>

Description

Secret을 삭제한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260831

Parameters

NameTypeDescriptionExample
secret_id
required		stringSecret 아이디3265ab469f0d406d83073da3e11e7a6c
waiting_time_ndays
required		integer삭제까지 남은 일수7

1.3 - Generate Random Password

1.3.1 - 1.1

scpcli secretsmanager generate random password
[--exclude_characters <value>]
[--exclude_lowercase <value>]
[--exclude_numbers <value>]
[--exclude_punctuation <value>]
[--exclude_uppercase <value>]
[--include_space <value>]
[--password_length <value>]
[--require_each_included_type <value>]

Description

임의 비밀번호 생성

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
exclude_characters
optional		string비밀번호 생성 시 제외할 문자들abcdefg
exclude_lowercase
optional		boolean소문자 제외 옵션false
exclude_numbers
optional		boolean숫자 제외 옵션false
exclude_punctuation
optional		boolean특수문자 제외 옵션false
exclude_uppercase
optional		boolean대문자 제외 옵션false
include_space
optional		boolean공백 포함 옵션false
password_length
optional		integer생성할 비밀번호의 길이32
require_each_included_type
optional		boolean포함된 모든 문자 유형 필수 요구true

Responses

NameDescriptionExample
random_password임의 비밀번호 생성random-value

1.3.2 - 1.0

scpcli secretsmanager generate random password
[--exclude_characters <value>]
[--exclude_lowercase <value>]
[--exclude_numbers <value>]
[--exclude_punctuation <value>]
[--exclude_uppercase <value>]
[--include_space <value>]
[--password_length <value>]
[--require_each_included_type <value>]

Description

임의 비밀번호 생성

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260831

Parameters

NameTypeDescriptionExample
exclude_characters
optional		string비밀번호 생성 시 제외할 문자들abcdefg
exclude_lowercase
optional		boolean소문자 제외 옵션false
exclude_numbers
optional		boolean숫자 제외 옵션false
exclude_punctuation
optional		boolean특수문자 제외 옵션false
exclude_uppercase
optional		boolean대문자 제외 옵션false
include_space
optional		boolean공백 포함 옵션false
password_length
optional		integer생성할 비밀번호의 길이32
require_each_included_type
optional		boolean포함된 모든 문자 유형 필수 요구true

Responses

NameDescriptionExample
random_password임의 비밀번호 생성random-value

1.4 - List Secrets

1.4.1 - 1.1

scpcli secretsmanager secret list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--state <value>]

Description

Secret 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
size
optional		integersize20
page
optional		integerpage0
sort
optional		stringsortcreated_at:desc
name
optional		stringSecret 이름name
state
optional		arraySecret 상태A

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id계정 id3265ab469f0d406d83073da3e11e7a6c
acl_cidrSecret 접근허용 CIDR 리스트192.168.1.1/24, 10.0.0.1/16
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
deleted_at삭제 날짜2025-02-25 03:07:17.000
descriptionSecret 설명description
kms_idKey Management Service 상품에서 생성한 자원 ID3265ab469f0d406d83073da3e11e7a6c
kms_nameKMS 키 이름kmsname
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name키 이름my-secret-name
recent_searched_at최근 검색일2025-02-25 03:07:17.000
state키 상태(Creating, Active, Error, Stop, To_Be_Terminated)Active
typeSecret 타입General

1.4.2 - 1.0

scpcli secretsmanager secret list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--state <value>]

Description

Secret 목록을 조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260831

Parameters

NameTypeDescriptionExample
size
optional		integersize20
page
optional		integerpage0
sort
optional		stringsortcreated_at:desc
name
optional		stringSecret 이름name
state
optional		arraySecret 상태A

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id계정 id3265ab469f0d406d83073da3e11e7a6c
acl_cidrSecret 접근허용 CIDR 리스트192.168.1.1/24, 10.0.0.1/16
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
deleted_at삭제 날짜2025-02-25 03:07:17.000
descriptionSecret 설명description
kms_idKey Management Service 상품에서 생성한 자원 ID3265ab469f0d406d83073da3e11e7a6c
kms_nameKMS 키 이름kmsname
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name키 이름my-secret-name
recent_searched_at최근 검색일2025-02-25 03:07:17.000
state키 상태(Creating, Active, Error, Stop, To_Be_Terminated)Active
typeSecret 타입General

1.5 - List Versions of Secret

1.5.1 - 1.1

scpcli secretsmanager secret list version
--secret_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

Secrets 버전 리스트

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
secret_id
required		stringSecret 아이디3265ab469f0d406d83073da3e11e7a6c
size
optional		integersize100
page
optional		integerpage0
sort
optional		stringsortcreated_at:desc

Responses

NameDescriptionExample
countcount20
pagepage0
sizesize20
sortsort[‘created_at:asc’]
version_list

1.5.2 - 1.0

scpcli secretsmanager secret list version
--secret_id <value>

Description

Secrets 버전 리스트

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260831

Parameters

NameTypeDescriptionExample
secret_id
required		stringSecret 아이디3265ab469f0d406d83073da3e11e7a6c

Responses

NameDescriptionExample
version_list

1.6 - Restore Secret

1.6.1 - 1.1

scpcli secretsmanager secret restore
--secret_id <value>

Description

Secret 삭제 절차를 취소한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
secret_id
required		stringSecret 아이디3265ab469f0d406d83073da3e11e7a6c

1.6.2 - 1.0

scpcli secretsmanager secret restore
--secret_id <value>

Description

Secret 삭제 절차를 취소한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260831

Parameters

NameTypeDescriptionExample
secret_id
required		stringSecret 아이디3265ab469f0d406d83073da3e11e7a6c

1.7 - Set CIDR of Secret

1.7.1 - 1.1

scpcli secretsmanager secret set cidr
--secret_id <value>
--acl_cidr <value>

Description

Secret의 Value 조회 접근제어를 위한 IP CIDR 값을 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
secret_id
required		stringSecret 아이디3265ab469f0d406d83073da3e11e7a6c
acl_cidr
required		stringSecret 접근허용 CIDR 리스트192.168.1.1/24, 10.0.0.1/16

1.7.2 - 1.0

scpcli secretsmanager secret set cidr
--secret_id <value>
--acl_cidr <value>

Description

Secret의 Value 조회 접근제어를 위한 IP CIDR 값을 수정한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260831

Parameters

NameTypeDescriptionExample
secret_id
required		stringSecret 아이디3265ab469f0d406d83073da3e11e7a6c
acl_cidr
required		stringSecret 접근허용 CIDR 리스트192.168.1.1/24, 10.0.0.1/16

1.8 - Set Description of Secret

1.8.1 - 1.1

scpcli secretsmanager secret set description
--secret_id <value>
--description <value>

Description

Secret의 설명값을 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
secret_id
required		stringSecret 아이디3265ab469f0d406d83073da3e11e7a6c
description
required		stringSecret 설명description

1.8.2 - 1.0

scpcli secretsmanager secret set description
--secret_id <value>
--description <value>

Description

Secret의 설명값을 수정한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260831

Parameters

NameTypeDescriptionExample
secret_id
required		stringSecret 아이디3265ab469f0d406d83073da3e11e7a6c
description
required		stringSecret 설명description

1.9 - Set KMS ID of Secret

1.9.1 - 1.1

scpcli secretsmanager secret set kmsid
--secret_id <value>
--kms_id <value>

Description

Secret Value 암호화에 사용한 KMS ID 를 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
secret_id
required		stringSecret 아이디3265ab469f0d406d83073da3e11e7a6c
kms_id
required		stringResource ID created in the Key Management Service (KMS) product3265ab469f0d406d83073da3e11e7a6c

1.9.2 - 1.0

scpcli secretsmanager secret set kmsid
--secret_id <value>
--kms_id <value>

Description

Secret Value 암호화에 사용한 KMS ID 를 수정한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260831

Parameters

NameTypeDescriptionExample
secret_id
required		stringSecret 아이디3265ab469f0d406d83073da3e11e7a6c
kms_id
required		stringResource ID created in the Key Management Service (KMS) product3265ab469f0d406d83073da3e11e7a6c

1.10 - Set Label of Version

1.10.1 - 1.1

scpcli secretsmanager secret update label
--secret_id <value>
--label <value>
[--move_to_version_id <value>]
[--remove_from_version_id <value>]

Description

Version 에 라벨을 추가/이동/삭제합니다. move_to_version_id 값만 사용하는 경우 라벨이 추가되고, remove_from_version_id 값만 사용하는경우 라벨이 제거됩니다. 둘다 사용하는경우, remove_from_version_id 의 라벨값이 move_to_version_id로 이동합니다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
secret_id
required		stringSecret 아이디3265ab469f0d406d83073da3e11e7a6c
label
required		stringSecret 버전 라벨. 중복 불가.My Custom Label
move_to_version_id
optional		stringSecret 버전 아이디3265ab469f0d406d83073da3e11e7a6c
remove_from_version_id
optional		stringSecret 버전 아이디3265ab469f0d406d83073da3e11e7a6c

1.10.2 - 1.0

scpcli secretsmanager secret update label
--secret_id <value>
--label <value>
[--move_to_version_id <value>]
[--remove_from_version_id <value>]

Description

Version 에 라벨을 추가/이동/삭제합니다. move_to_version_id 값만 사용하는 경우 라벨이 추가되고, remove_from_version_id 값만 사용하는경우 라벨이 제거됩니다. 둘다 사용하는경우, remove_from_version_id 의 라벨값이 move_to_version_id로 이동합니다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260831

Parameters

NameTypeDescriptionExample
secret_id
required		stringSecret 아이디3265ab469f0d406d83073da3e11e7a6c
label
required		stringSecret 버전 라벨. 중복 불가.My Custom Label
move_to_version_id
optional		stringSecret 버전 아이디3265ab469f0d406d83073da3e11e7a6c
remove_from_version_id
optional		stringSecret 버전 아이디3265ab469f0d406d83073da3e11e7a6c

1.11 - Set Private Acl of Secret

1.11.1 - 1.1

scpcli secretsmanager secret set private-acl
--secret_id <value>
[--private_acl_enabled <value>]
[--private_acl_resources <value>]

Description

Private acl 업데이트

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
secret_id
required		stringSecret 아이디3265ab469f0d406d83073da3e11e7a6c
private_acl_enabled
optional		boolean프라이빗 접근 제어 활성화true
private_acl_resources
optional		array프라이빗 접근 제어 자원들'{"resource_id": ""}'

1.11.2 - 1.0

scpcli secretsmanager secret set private-acl
--secret_id <value>
[--private_acl_enabled <value>]
[--private_acl_resources <value>]

Description

Private acl 업데이트

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260831

Parameters

NameTypeDescriptionExample
secret_id
required		stringSecret 아이디3265ab469f0d406d83073da3e11e7a6c
private_acl_enabled
optional		boolean프라이빗 접근 제어 활성화true
private_acl_resources
optional		array프라이빗 접근 제어 자원들'{"resource_id": ""}'

1.12 - Show Secret Detail

1.12.1 - 1.1

scpcli secretsmanager secret show
--secret_id <value>

Description

Secret 상세정보 보기

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
secret_id
required		stringSecret 아이디3265ab469f0d406d83073da3e11e7a6c

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id계정 id3265ab469f0d406d83073da3e11e7a6c
acl_cidrSecret 접근허용 CIDR 리스트192.168.1.1/24, 10.0.0.1/16
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
deleted_at삭제 날짜2025-02-25 03:07:17.000
descriptionSecret 설명description
kms_idKey Management Service 상품에서 생성한 자원 ID3265ab469f0d406d83073da3e11e7a6c
kms_nameKMS 키 이름kmsname
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name키 이름my-secret-name
offering오퍼링 이름
private_acl_enabled프라이빗 접근 제어 활성화true
private_acl_resources프라이빗 접근 제어 자원들
recent_searched_at최근 검색일2025-02-25 03:07:17.000
region리즌 이름
state키 상태(Creating, Active, Error, Stop, To_Be_Terminated)Active
typeSecret 타입General

1.12.2 - 1.0

scpcli secretsmanager secret show
--secret_id <value>

Description

Secret 상세정보 보기

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260831

Parameters

NameTypeDescriptionExample
secret_id
required		stringSecret 아이디3265ab469f0d406d83073da3e11e7a6c

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id계정 id3265ab469f0d406d83073da3e11e7a6c
acl_cidrSecret 접근허용 CIDR 리스트192.168.1.1/24, 10.0.0.1/16
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
deleted_at삭제 날짜2025-02-25 03:07:17.000
descriptionSecret 설명description
kms_idKey Management Service 상품에서 생성한 자원 ID3265ab469f0d406d83073da3e11e7a6c
kms_nameKMS 키 이름kmsname
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name키 이름my-secret-name
recent_searched_at최근 검색일2025-02-25 03:07:17.000
state키 상태(Creating, Active, Error, Stop, To_Be_Terminated)Active
typeSecret 타입General

1.13 - Show Secret Value

1.13.1 - 1.1

scpcli secretsmanager secret show value
--secret_id <value>
[--label <value>]
[--version_id <value>]

Description

Secret value 보기

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
secret_id
required		stringSecret 아이디3265ab469f0d406d83073da3e11e7a6c
label
optional		stringSecret 버전 라벨. 중복 불가.CURRENT
version_id
optional		stringSecret 버전 아이디e7b638507d9f4feeb6032a22b7640bf7

Responses

NameDescriptionExample
secret_valueSecret의 Value는 key/value 형식의 json string으로 10개쌍까지 입력 가능합니다.{“key1”:“value1”,“key2”:“value2”}

1.13.2 - 1.0

scpcli secretsmanager secret show value
--secret_id <value>
[--label <value>]
[--version_id <value>]

Description

Secret value 보기

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260831

Parameters

NameTypeDescriptionExample
secret_id
required		stringSecret 아이디3265ab469f0d406d83073da3e11e7a6c
label
optional		stringSecret 버전 라벨. 중복 불가.CURRENT
version_id
optional		stringSecret 버전 아이디e7b638507d9f4feeb6032a22b7640bf7

Responses

NameDescriptionExample
secret_valueSecret의 Value는 key/value 형식의 json string으로 10개쌍까지 입력 가능합니다.{“key1”:“value1”,“key2”:“value2”}

1.14 - Update Secret Value

1.14.1 - 1.1

scpcli secretsmanager secret update value
--secret_id <value>
--secret_value <value>

Description

Secret value 업데이트

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
secret_id
required		stringSecret 아이디3265ab469f0d406d83073da3e11e7a6c
secret_value
required		stringThe value of a Secret can be entered as a JSON string in key/value format, up to 10 pairs.{"key1":"value1","key2":"value2"}

1.14.2 - 1.0

scpcli secretsmanager secret update value
--secret_id <value>
--secret_value <value>

Description

Secret value 업데이트

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260831

Parameters

NameTypeDescriptionExample
secret_id
required		stringSecret 아이디3265ab469f0d406d83073da3e11e7a6c
secret_value
required		stringThe value of a Secret can be entered as a JSON string in key/value format, up to 10 pairs.{"key1":"value1","key2":"value2"}