---
title: "Get Key List"
slug: "security-kms2-key-list"
updated: 2026-09-17T09:58:23Z
published: 2026-09-17T09:58:23Z
canonical: "api.ncloud-docs.com/security-kms2-key-list"
---

> ## 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 List

Classic/VPC環境で利用できます。

キーリストを照会します。

## リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

| メソッド | URI |
| --- | --- |
| GET | /kms/v1/keys |

### リクエストヘッダ

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)でアカウント認証方式をご参照ください。

### リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `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 | - | キーリストの詳細情報: [KeyList](/docs/ja/security-kms2-key-list#KeyList) |
| `currentPageNo` | Integer | - | 現在のページ番号 |
| `totalPageNo` | Integer | - | 総ページ番号 |
| `totalCount` | Integer | - | レスポンス結果数 |

#### KeyList

`KeyList`の説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `keyId` | Integer | - | キーの識別子 |
| `keyTag` | String | - | キータグ - キー名から派生したキーの固有 ID - キータグは機密情報として扱われない |
| `keyName` | String | - | キー名 - キー名は機密情報として扱われない |
| `keyType` | String | - | キータイプ - `AES256` \| `RSA2048` \| `ECDSA` - `AES256`: 対称鍵方式の AES暗号(AES 256-GCM96)を使用する256bitのキー - 最大32KBのデータ暗号化が可能 - `RSA2048`: 非対称鍵方式の RSA暗号(RSA 2048)を使用する2048bitのキー - 暗号化・復号化、署名、検証機能をいずれも使用できるが、処理速度は一番遅い - 最大190byteのデータ暗号化、最大8KBのデータ署名が可能 - `ECDSA`: 非対称鍵方式の ECDSA暗号(ECDSA-P256)を使用する256bitのキー - 最大8KBのデータ署名が可能 |
| `data.status` | String | - | キーの状態 - `ENABLE` \| `DISABLE` \| `REVOKE` - `ENABLE`: 使用可能 - `DISABLE`: 使用停止 - `REVOKE`: 削除予定 - キーの状態の詳細は、[キーの状態の管理](https://guide.ncloud-docs.com/docs/ja/kms-status)を参照 |
| `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のレスポンスステータスコード](/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": {
        "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
    }
}
```