Get Key List

Classic/VPC 환경에서 이용 가능합니다.

키 목록을 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
GET	/keys

요청 헤더

Key Management Service API에서 공통으로 사용하는 헤더에 대한 정보는 Key Management Service 요청 헤더에서 계정 인증 방식을 참조해 주십시오.

요청 쿼리 파라미터

요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`pageNo`	Integer	Optional	요청 페이지 번호 1 (기본값)
`pageSize`	Integer	Optional	페이지 출력 개수 1~200 (기본값: 100)

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://ocapi.ncloud.com/kms/v1/keys?pageNo=1&pageSize=1' \
--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	-	키 목록 세부 정보
`currentPageNo`	Integer	-	현재 페이지 번호
`totalPageNo`	Integer	-	총 페이지 번호
`totalCount`	Integer	-	응답 결과 개수

KeyList

KeyList에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`keyId`	Integer	-	키 식별자
`keyTag`	String	-	키 태그 키 이름에서 파생된 키의 고유 식별자 키 태그는 기밀 정보로 취급되지 않음
`keyName`	String	-	키 이름 키 이름은 기밀 정보로 취급되지 않음
`keyType`	String	-	키 타입 `AES256` \| `RSA2048` \| `ECDSA` `AES256`: 대칭키 방식의 AES 암호(AES 256-GCM96)를 사용하는 256 bit 키 최대 32 KB의 데이터 암호화 가능 `RSA2048`: 비대칭키 방식의 RSA 암호(RSA 2048)를 사용하는 2048 bit 키 암호화ㆍ복호화, 서명ㆍ검증 기능을 모두 사용할 수 있으나 처리 속도가 가장 느림 최대 190 byte 데이터 암호화 또는 최대 8 KB 데이터 서명 가능 `ECDSA`: 비대칭키 방식의 ECDSA 암호(ECDSA-P256)를 사용하는 256 bit 키 최대 8 KB의 데이터 서명 가능
`data.status`	String	-	키 상태 `ENABLE` \| `DISABLE` \| `REVOKE` `ENABLE`: 사용 가능 `DISABLE`: 사용 중지 `REVOKE`: 삭제 예정 키 상태에 대한 자세한 내용은 키 상태 관리 참조
`protectionType`	String	-	키 저장 방식 `BASIC` \| `COMMON_HSM` `BASIC`: 내부 스토리지에 암호화된 형태로 저장 `COMMON_HSM`: HSM (Hardware Security Module)에 저장
`isConvergent`	Boolean	-	수렴 암호화(convergent encryption) 설정 여부 `true` \| `false` `true`: 설정 `false`: 미설정
`registerDate`	Long	-	키 생성 일시(밀리초) Unix Timestamp 형식
`destroyDate`	Long	-	키 삭제 예정 일시(밀리초) Unix Timestamp 형식 키 상태가 삭제 예정(`REVOKE`)인 경우에만 표시

응답 상태 코드

Key Management Service API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Key Management Service 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "code": "SUCCESS",
    "data": {
        "keyList": [
            {
                "keyId": 12345,
                "keyTag": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6",
                "keyName": "{KEY_NAME}",
                "keyType": "AES256",
                "status": "REVOKE",
                "protectionType": "BASIC",
                "isConvergent": true,
                "registerDate": 1733380631000,
                "destroyDate": 1733645878000
            }
        ],
        "currentPageNo": 1,
        "totalPageNo": 1,
        "totalCount": 1
    }
}