VPC 환경에서 이용 가능합니다.
시크릿 보호 키로 지정 가능한 KMS 키 목록을 조회합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
메서드 | URI |
---|---|
GET | /api/v1/keys |
요청 헤더
Secret Manager API에서 공통으로 사용하는 헤더에 대한 정보는 Secret Manager 요청 헤더를 참조해 주십시오.
요청 예시
요청 예시는 다음과 같습니다.
curl --location --request GET 'https://secretmanager.apigw.ntruss.com/api/v1/keys' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
응답
응답 형식을 설명합니다.
응답 바디
응답 바디에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
code |
String | - | 응답 코드 |
data |
Object | - | 응답 결과 |
data.keyList |
Array | - | KMS 키 목록 |
keyList
keyList
에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
keyId |
String | - | 키 식별자 |
keyTag |
String | - | 키 태그 |
keyName |
String | - | 키 이름 |
keyStatus |
String | - | 키 상태
|
keyType |
String | - | 키 타입
|
응답 상태 코드
Secret Manager API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Secret Manager 응답 상태 코드를 참조해 주십시오.
응답 예시
응답 예시는 다음과 같습니다.
{
"code": "SUCCESS",
"data": {
"keyList": [
{
"keyId": 0,
"keyTag": "",
"keyName": "Secret Manager Default Key",
"keyStatus": "",
"keyType": ""
},
{
"keyId": 12345,
"keyTag": "*****a8e99ef1ba49b9c190a0cb4f6fb20cff86dd3a3017fd6ee05aea8b*****",
"keyName": "test-***",
"keyStatus": "ENABLE",
"keyType": "AES256"
}
]
}
}