Get Key List

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

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

リクエスト

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

メソッド	URI
GET	/keys

リクエストヘッダ

Key Management Service APIで共通して使用されるヘッダの詳細は、Key Management Serviceのリクエストヘッダでアカウント認証方式をご参照ください。

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

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

フィールド	タイプ	必須の有無	説明
`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	-	キーリストの詳細情報
`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`: 削除予定キーの状態の詳細は、キーの状態の管理を参照
`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のレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "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
    }
}