Get Key Activity Logs

Prev Next

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

키 사용 이력 목록을 조회합니다.

요청

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

메서드 URI
GET /keys/{keyTag}/activities

요청 헤더

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

요청 경로 파라미터

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

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

요청 쿼리 파라미터

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

필드 타입 필수 여부 설명
keyword String Optional 키워드로 필터링
timestampFrom Long Optional 조회 시작 일시(밀리초)
  • 현재 시간에서 1일을 뺀 값(기본값)
  • Unix Timestamp 형식
timestampTo Long Optional 조회 종료 일시(밀리초)
  • 현재 시간(기본값)
  • Unix Timestamp 형식
pageNo Integer Optional 요청 페이지 번호
  • 1 (기본값)
pageSize Integer Optional 페이지 출력 개수
  • 1~200 (기본값: 100)

요청 예시

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

curl --location --request GET 'https://ocapi.ncloud.com/kms/v1/keys/a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6/activities' \
--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.activityLogList Array - 키 사용 이력 목록 세부 정보
data.pageSize Integer - 페이지 출력 개수
data.currentPageNo Integer - 현재 페이지 번호
data.totalPageNo Integer - 총 페이지 번호
data.totalCount Integer - 응답 결과 개수

activityLogList

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

필드 타입 필수 여부 설명
timestamp String - 요청 일시(밀리초)
  • ISO 8601 형식
data Object - 사용 이력별 세부 정보
data.KmsKey Object - 키 세부 정보
data.KmsKey.keyTag String - 사용한 키의 태그
data.KmsKey.keyName String - 키 이름
data.KmsKey.nrn String - 키 리소스 전역 식별자 이름(Ncloud 리소스명)
data.requestor Object - 요청 세부 정보
data.requestor.requestType String - 요청 유형
  • CONSOLE | API | SYSTEM
    • CONSOLE: 콘솔에서 요청
    • API: API로 요청
    • SYSTEM: 자동 회전 및 삭제 스케줄링에 의한 처리
data.requestor.id String - 요청자 계정 아이디
data.requestor.ip String - 요청자 IP 주소
data.api Object - API 요청 세부 정보
data.api.result String - API 요청 결과
  • SUCCESS: 요청 성공
data.api.action String - API 요청 이름
data.api.type String - API 인증 방식
  • account-auth | product-auth
    • account-auth: 계정 인증 방식
    • product-auth: 토큰 인증 방식
  • data.requestor.requestType이 API인 경우에만 표시
message String - 응답 내용
  • 응답의 성공 또느 실패 여부 표시

응답 상태 코드

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

응답 예시

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

{
    "code": "SUCCESS",
    "data": {
        "activityLogList": [
            {
                "timestamp": "2024-12-09T11:50:10.861+09:00",
                "data": {
                    "kmsKey": {
                        "keyTag": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6",
                        "keyName": "{KEY_IDENTIFIER}",
                        "nrn": "nrn:PUB:KMS::xxxxxxx:Key/xxxx-xxxxx"
                    },
                    "requestor": {
                        "requestType": "CONSOLE",
                        "id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
                        "ip": "xxx.xxx.xxx.xxx"
                    },
                    "api": {
                        "result": "SUCCESS",
                        "action": "GetKeyInfo",
                        "type": "product-auth"
                    }
                },
                "message": "{\"result\":\"SUCCESS\",\"action\":\"GetKeyInfo\",\"keyTag\":\"a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6\"}"
            }
        ],
        "pageSize": 100,
        "currentPageNo": 1,
        "totalPageNo": 1,
        "totalCount": 1
    }
}