Get Key Info

Prev Next

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

키의 상세 정보를 조회합니다.

요청

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

메서드 URI
GET /keys/{keyTag}

요청 헤더

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

요청 경로 파라미터

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

필드 타입 필수 여부 설명
keyTag String Required 키 태그
  • 키 이름에서 파생된 키의 고유 식별자
  • Get Key List를 통해 확인
  • REST API로 암호화 또는 복호화 요청 시 사용
  • 키 태그는 기밀 정보로 취급되지 않음

요청 예시

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

curl --location --request GET 'https://ocapi.ncloud.com/kms/v1/keys/a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6' \
--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.keyId Integer - 키 식별자
data.keyTag String - 키 태그
  • 키 이름에서 파생된 키의 고유 식별자
  • REST API로 암호화 또는 복호화 요청 시 사용
  • 키 태그는 기밀 정보로 취급되지 않음
data.keyName String - 생성 시 지정된 키의 고유한 이름
  • 키 이름은 기밀 정보로 취급되지 않음
data.keyType String - 키 타입
data.status String - 키 상태
  • ENABLE | DISABLE | REVOKE
    • ENABLE: 사용 가능
    • DISABLE: 사용 중지
    • REVOKE: 삭제 예정
    • 키 상태에 대한 자세한 내용은 키 상태 관리 참조
data.keystoreId Integer - 사용자에게 할당된 논리적 키 저장소 식별자
data.currentVersion Integer - 키의 현재 버전
  • 키의 가장 최신 버전이 표시됨
data.protectionType String - 키 저장 방식
  • BASIC | COMMON_HSM
    • BASIC: 내부 스토리지에 암호화된 형태로 저장
    • COMMON_HSM: HSM (Hardware Security Module)에 저장
data.memo String - 키 메모
  • 생성 시 입력한 키에 대한 추가 정보 및 설명
data.isConvergent Boolean - 수렴 암호화 설정 여부
  • true | false
    • true: 설정
    • false: 미설정
data.isAutoRotation Boolean - 키 자동 회전 설정 여부
  • true | false
    • true: 설정(활성화)
    • false: 미설정(비활성화)
data.rotationPeriod Integer - 키 자동 회전 주기(일)
data.nextRotationDate Long - 다음 회전 예정 일시(밀리초)
  • Unix Timestamp 형식
data.registerDate Long - 키 생성 일시(밀리초)
  • Unix Timestamp 형식
data.destroyDate Long - 키 삭제 예정 일시(밀리초)
  • Unix Timestamp 형식
  • 삭제 예정 상태의 키에만 포함됨

응답 상태 코드

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

응답 예시

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

{
    "code": "SUCCESS",
    "data": {
        "keyId": 12345,
        "keyTag": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6",
        "keyName": "{KEY_NAME}",
        "keyType": "AES256",
        "status": "ENABLE",
        "keystoreId": 1234,
        "currentVersion": 1,
        "protectionType": "BASIC",
        "memo": "{KEY_DESCRIPTION}",
        "isConvergent": true,
        "isAutoRotation": true,
        "rotationPeriod": 90,
        "nextRotationDate": 1741156631314,
        "registerDate": 1733380631000
    }
}