Get Key Version List

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

キーのバージョンリストを照会します。

リクエスト

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

メソッド	URI
GET	/keys/{keyTag}/versions

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`keyTag`	String	Required	キータグキー名から派生したキーの固有 ID Get Key Listを通じて確認 REST APIで暗号化または復号化をリクエストする際に使用キータグは機密情報として扱われない

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://ocapi.ncloud.com/kms/v1/keys/a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6/versions' \
--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.keyTag`	String	-	照会したキーのタグ
`data.currentVersion`	Integer	-	現在のキーのバージョン
`data.versionList`	Array	-	キーのバージョン別詳細情報

`versionList`

versionListの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`version`	Integer	-	キーのバージョン
`status`	String	-	キーの状態 `ENABLE` \| `DISABLE` `ENABLE`: 使用可能(バージョンを有効化) `DISABLE`: 使用不可(バージョンを無効化)
`statusDate`	Long	-	キーの状態の変更日時(ミリ秒) Unix Timestamp形式
`rotatedDate`	Long	-	キーのローテーション日時(ミリ秒) Unix Timestamp形式

レスポンスステータスコード

Key Management Service APIで共通して使用されるレスポンスステータスコードの詳細は、Key Management Serviceのレスポンスステータスコードをご参照ください。

レスポンス例

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

{
    "code": "SUCCESS",
    "data": {
        "keyTag": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6",
        "currentVersion": 2,
        "versionList": [
            {
                "version": 1,
                "status": "ENABLE",
                "statusDate": 1733875954000,
                "rotatedDate": 1732603460000
            },
            {
                "version": 2,
                "status": "ENABLE",
                "rotatedDate": 1733875426000
            }
        ]
    }
}