Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 Secrets Manager에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | CURRENT | - |
이 섹션의 다중 페이지 출력 화면임. 여기를 클릭하여 프린트.
Secrets Manager
- 1: CLIs
- 1.1: Create Secret
- 1.1.1: 1.0
- 1.2: Delete Secret
- 1.2.1: 1.0
- 1.3: Generate Random Password
- 1.3.1: 1.0
- 1.4: List Secrets
- 1.4.1: 1.0
- 1.5: List Versions of Secret
- 1.5.1: 1.0
- 1.6: Restore Secret
- 1.6.1: 1.0
- 1.7: Set CIDR of Secret
- 1.7.1: 1.0
- 1.8: Set Description of Secret
- 1.8.1: 1.0
- 1.9: Set KMS ID of Secret
- 1.9.1: 1.0
- 1.10: Set Label of Version
- 1.10.1: 1.0
- 1.11: Show Secret Detail
- 1.11.1: 1.0
- 1.12: Show Secret Value
- 1.12.1: 1.0
- 1.13: Update Secret Value
- 1.13.1: 1.0
1 - CLIs
1.1 - Create Secret
1.1.1 - 1.0
scpcli secretsmanager secret create
--secret_value <value>
--name <value>
--kms_id <value>
--acl_cidr <value>
[--description <value>]
[--tags <value>]
Description
Secret 을 생성합니다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| secret_value required | string | The 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 | string | Secret 이름 | name |
| kms_id required | string | Resource ID created in the Key Management Service (KMS) product | 3265ab469f0d406d83073da3e11e7a6c |
| acl_cidr required | string | Secret 접근허용 CIDR 리스트 | 192.168.1.1/24, 10.0.0.1/16 |
| description optional | string | Secret 설명 | description |
| tags optional | array | Tag List' | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | 계정 id | 3265ab469f0d406d83073da3e11e7a6c |
| acl_cidr | Secret 접근허용 CIDR 리스트 | 192.168.1.1/24, 10.0.0.1/16 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| deleted_at | Date of deletion | 2025-02-25 03:07:17.000 |
| description | Secret 설명 | description |
| kms_id | Key Management Service 상품에서 생성한 자원 ID | 3265ab469f0d406d83073da3e11e7a6c |
| kms_name | KMS 키 이름 | 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 |
| type | Secret 타입 | General |
1.2 - Delete Secret
1.2.1 - 1.0
scpcli secretsmanager secret delete
--secret_id <value>
--waiting_time_ndays <value>
Description
Secret을 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret 아이디 | 3265ab469f0d406d83073da3e11e7a6c |
| waiting_time_ndays required | integer | 삭제까지 남은 일수 | 7 |
1.3 - Generate Random Password
1.3.1 - 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 (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| 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
| Name | Description | Example |
|---|---|---|
| random_password | 임의 비밀번호 생성 | random-value |
1.4 - List Secrets
1.4.1 - 1.0
scpcli secretsmanager secret list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--state <value>]
Description
Secret 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Secret 이름 | name |
| state optional | array | Secret 상태 | A |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | 계정 id | 3265ab469f0d406d83073da3e11e7a6c |
| acl_cidr | Secret 접근허용 CIDR 리스트 | 192.168.1.1/24, 10.0.0.1/16 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| deleted_at | Date of deletion | 2025-02-25 03:07:17.000 |
| description | Secret 설명 | description |
| kms_id | Key Management Service 상품에서 생성한 자원 ID | 3265ab469f0d406d83073da3e11e7a6c |
| kms_name | KMS 키 이름 | 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 |
| type | Secret 타입 | General |
1.5 - List Versions of Secret
1.5.1 - 1.0
scpcli secretsmanager secret list version
--secret_id <value>
Description
Secrets 버전 리스트
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret 아이디 | 3265ab469f0d406d83073da3e11e7a6c |
Responses
| Name | Description | Example |
|---|---|---|
| version_list |
1.6 - Restore Secret
1.6.1 - 1.0
scpcli secretsmanager secret restore
--secret_id <value>
Description
Secret 삭제 절차를 취소한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret 아이디 | 3265ab469f0d406d83073da3e11e7a6c |
1.7 - Set CIDR of Secret
1.7.1 - 1.0
scpcli secretsmanager secret set cidr
--secret_id <value>
--acl_cidr <value>
Description
Secret의 Value 조회 접근제어를 위한 IP CIDR 값을 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret 아이디 | 3265ab469f0d406d83073da3e11e7a6c |
| acl_cidr required | string | Secret 접근허용 CIDR 리스트 | 192.168.1.1/24, 10.0.0.1/16 |
1.8 - Set Description of Secret
1.8.1 - 1.0
scpcli secretsmanager secret set description
--secret_id <value>
--description <value>
Description
Secret의 설명값을 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret 아이디 | 3265ab469f0d406d83073da3e11e7a6c |
| description required | string | Secret 설명 | description |
1.9 - Set KMS ID of Secret
1.9.1 - 1.0
scpcli secretsmanager secret set kmsid
--secret_id <value>
--kms_id <value>
Description
Secret Value 암호화에 사용한 KMS ID 를 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret 아이디 | 3265ab469f0d406d83073da3e11e7a6c |
| kms_id required | string | Resource ID created in the Key Management Service (KMS) product | 3265ab469f0d406d83073da3e11e7a6c |
1.10 - Set Label of Version
1.10.1 - 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 (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret 아이디 | 3265ab469f0d406d83073da3e11e7a6c |
| label required | string | Secret 버전 라벨. 중복 불가. | My Custom Label |
| move_to_version_id optional | string | Secret 버전 아이디 | 3265ab469f0d406d83073da3e11e7a6c |
| remove_from_version_id optional | string | Secret 버전 아이디 | 3265ab469f0d406d83073da3e11e7a6c |
1.11 - Show Secret Detail
1.11.1 - 1.0
scpcli secretsmanager secret show
--secret_id <value>
Description
Secret 상세정보 보기
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret 아이디 | 3265ab469f0d406d83073da3e11e7a6c |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | 계정 id | 3265ab469f0d406d83073da3e11e7a6c |
| acl_cidr | Secret 접근허용 CIDR 리스트 | 192.168.1.1/24, 10.0.0.1/16 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| deleted_at | Date of deletion | 2025-02-25 03:07:17.000 |
| description | Secret 설명 | description |
| kms_id | Key Management Service 상품에서 생성한 자원 ID | 3265ab469f0d406d83073da3e11e7a6c |
| kms_name | KMS 키 이름 | 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 |
| type | Secret 타입 | General |
1.12 - Show Secret Value
1.12.1 - 1.0
scpcli secretsmanager secret show value
--secret_id <value>
[--label <value>]
[--version_id <value>]
Description
Secret value 보기
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret 아이디 | 3265ab469f0d406d83073da3e11e7a6c |
| label optional | string | Secret 버전 라벨. 중복 불가. | CURRENT |
| version_id optional | string | Secret 버전 아이디 | e7b638507d9f4feeb6032a22b7640bf7 |
Responses
| Name | Description | Example |
|---|---|---|
| secret_value | Secret의 Value는 key/value 형식의 json string으로 10개쌍까지 입력 가능합니다. | {“key1”:“value1”,“key2”:“value2”} |
1.13 - Update Secret Value
1.13.1 - 1.0
scpcli secretsmanager secret update value
--secret_id <value>
--secret_value <value>
Description
Secret value 업데이트
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret 아이디 | 3265ab469f0d406d83073da3e11e7a6c |
| secret_value required | string | The value of a Secret can be entered as a JSON string in key/value format, up to 10 pairs. | {"key1":"value1","key2":"value2"} |