Get Protection Key List

VPC環境で利用できます。

シークレット保護キーに指定可能な KMSキーリストを照会します。

リクエスト

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

メソッド	URI
GET	/api/v1/keys

リクエストヘッダ

Secret Manager APIで共通して使用されるヘッダの詳細は、Secret Managerのリクエストヘッダをご参照ください。

リクエスト例

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

curl --location --request GET 'https://secretmanager.apigw.ntruss.com/api/v1/keys' \
--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	-	KMSキーリスト

keyList

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

フィールド	タイプ	必須の有無	説明
`keyId`	String	-	キーの識別子
`keyTag`	String	-	キータグ
`keyName`	String	-	キー名
`keyStatus`	String	-	キーの状態 `ENABLE` \| `DISABLE` `ENABLE`: 使用可能 `DISABLE`: 使用停止
`keyType`	String	-	キータイプ `AES256` \| `RSA2048` `AES256`: 対称キー方式の AES暗号(AES 256-GCM96)を使用する256ビットキー `RSA2048`: 非対称キー方式の RSA暗号(RSA 2048)を使用する2048ビットキー

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

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

レスポンス例

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

{
    "code": "SUCCESS",
    "data": {
        "keyList": [
            {
                "keyId": 0,
                "keyTag": "",
                "keyName": "Secret Manager Default Key",
                "keyStatus": "",
                "keyType": ""
            },
            {
                "keyId": 12345,
                "keyTag": "*****a8e99ef1ba49b9c190a0cb4f6fb20cff86dd3a3017fd6ee05aea8b*****",
                "keyName": "test-***",
                "keyStatus": "ENABLE",
                "keyType": "AES256"
            }
        ]
    }
}