---
title: "Get Key Info"
slug: "security-kms2-key-info"
updated: 2026-09-17T09:58:23Z
published: 2026-09-17T09:58:23Z
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/ja/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 | キータグ - キー名から派生したキーの固有 ID - [Get Key List](/docs/ja/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 | - | キータグ - キー名から派生したキーの固有 ID - REST APIで暗号化または復号化をリクエストする際に使用 - キータグは機密情報として扱われない |
| `data.keyName` | String | - | 作成時に指定されたキーの固有名 - キー名は機密情報として扱われない |
| `data.nrn` | String | - | NAVERクラウドプラットフォームで使用されるリソース識別子 - NRNは機密情報扱いしない |
| `data.baseUrl` | String | - | キーバウンダリーごとの API呼び出しドメイン(エンドポイント) |
| `data.keyType` | String | - | キータイプ - [Create Key](/docs/ja/security-kms2-create-key)を参照 |
| `data.status` | String | - | キーの状態 - `ENABLE` \| `DISABLE` \| `REVOKE` - `ENABLE`: 使用可能 - `DISABLE`: 使用停止 - `REVOKE`: 削除予定 - キーの状態の詳細は、[キーの状態の管理](https://guide.ncloud-docs.com/docs/ja/kms-status)を参照 |
| `data.keystoreId` | Integer | - | ユーザーに割り当てられた論理的キーストア識別子 |
| `data.currentVersion` | Integer | - | キーの現在のバージョン - キーの最新バージョンが表示される |
| `data.protectionType` | String | - | キーの保存方法 - `BASIC` \| `COMMON_HSM` - `BASIC`: 内部ストレージに暗号化された形で保存 - `COMMON_HSM`: Hardware Security Module(HSM)に保存 |
| `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/ja/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}"
        }
    }
}
```