--- title: "Get Key Info" slug: "security-kms2-key-info" updated: 2026-09-17T09:16:56Z published: 2026-09-17T09:16:56Z canonical: "api.ncloud-docs.com/security-kms2-key-info" --- > ## Documentation Index > Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt > Use this file to discover all available pages before exploring further. # Get Key Info Classic/VPC 환경에서 이용 가능합니다. 키의 상세 정보를 조회합니다. ## 요청 요청 형식을 설명합니다. 요청 형식은 다음과 같습니다. | 메서드 | URI | | --- | --- | | GET | /kms/v1/keys/{keyTag} | ### 요청 헤더 Key Management Service API에서 공통으로 사용하는 헤더에 대한 정보는 [Key Management Service 요청 헤더](/docs/security-kms#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%942%EA%B3%84%EC%A0%95%EC%9D%B8%EC%A6%9D)에서 계정 인증 방식을 참조해 주십시오. ### 요청 경로 파라미터 요청 경로 파라미터에 대한 설명은 다음과 같습니다. | 필드 | 타입 | 필수 여부 | 설명 | | --- | --- | --- | --- | | `keyTag` | String | Required | 키 태그 - 키 이름에서 파생된 키의 고유 식별자 - [Get Key List](/docs/security-kms2-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.nrn` | String | - | NCP에서 사용되는 리소스 식별자 - NRN은 기밀 정보로 취급되지 않음 | | `data.baseUrl` | String | - | 키 바운더리 별 API 호출 도메인(엔드포인트) | | `data.keyType` | String | - | 키 타입 - [Create Key](/docs/security-kms2-create-key) 참조 | | `data.status` | String | - | 키 상태 - `ENABLE` \| `DISABLE` \| `REVOKE` - `ENABLE`: 사용 가능 - `DISABLE`: 사용 중지 - `REVOKE`: 삭제 예정 - 키 상태에 대한 자세한 내용은 [키 상태 관리](https://guide.ncloud-docs.com/docs/kms-status) 참조 | | `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 형식 - 삭제 예정 상태의 키에만 포함 | | `data.migrationInfo.migrationId` | String | - | 전환 식별자 - 전환 실패의 키에만 포함 | | `data.migrationInfo.status` | String | - | 전환 상태 - 전환 실패의 키에만 포함 | | `data.migrationInfo.targetBoundary` | String | - | 전환 대상 바운더리 - `KR` \| `JPN` - `KR`: 한국 리전 - `JPN`: 일본 리전 - 전환 실패의 키에만 포함 | | `data.migrationInfo.startDate` | Long | - | 전환 시작 일시(밀리초) - Unix Timestamp 형식 - 전환 실패의 키에만 포함 | | `data.migrationInfo.errorMessage` | String | - | 전환 실패 사유 - 전환 실패의 키에만 포함 | ### 응답 상태 코드 Key Management Service API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 [Key Management Service 응답 상태 코드](/docs/security-kms#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C2)를 참조해 주십시오. ### 응답 예시 응답 예시는 다음과 같습니다. ``` { "code": "SUCCESS", "data": { "keyId": 12345, "keyTag": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5r6", "keyName": "{KEY_NAME}", "nrn": "nrn:PUB:KMS::7891:Key/000-12345", "keyType": "AES256", "status": "ENABLE", "keystoreId": 1234, "currentVersion": 1, "protectionType": "BASIC", "memo": "{KEY_DESCRIPTION}", "isConvergent": true, "isAutoRotation": true, "rotationPeriod": 90, "nextRotationDate": 1741156631314, "registerDate": 1733380631000, "baseUrl": "https://ocapi.ncloud.com", "migrationInfo": { "migrationId": "334ddd32-1008-4262-a8a6-eeb83a4e4640", "status": "FAILED", "targetBoundary": "JPN", "startDate": 1763347406000, "errorMessage": "{MIGRATION_ERROR_MESSAGE}" } } } ```