getLoginKeyList

VPC環境で利用できます。

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

リクエスト

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

メソッド	URI
GET \| POST	/vserver/v2/getLoginKeyList

参考

ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`regionCode`	String	Optional	リージョンコード getRegionListを参照照会結果の最初のリージョン(デフォルト)
`keyName`	String	Optional	認証キー名入力しないとレスポンス結果に認証キーの全リストを表示
`pageNo`	Integer	Optional	ページ番号 0~N (デフォルト: 0) 最初のページ: `0`または`1`を入力
`pageSize`	Integer	Conditional	ページごとの項目数 1~1000 (デフォルト: 1) `pageNo`入力時、必ず入力
`responseFormatType`	String	Optional	レスポンスデータの形式 `xml`(デフォルト) \| `json`

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/getLoginKeyList
?regionCode=KR
&keyName=test-***
&responseFormatType=json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`getLoginKeyListResponse`	Object	-	レスポンス結果
`getLoginKeyListResponse.loginKeyList`	Array	-	認証キーリスト: LoginKeyListを参照
`getLoginKeyListResponse.requestId`	String	-	リクエスト ID UUID形式
`getLoginKeyListResponse.returnCode`	String	-	レスポンスコード
`getLoginKeyListResponse.returnMessage`	String	-	レスポンスメッセージ

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

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

レスポンス例

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

{
    "getLoginKeyListResponse": {
        "loginKeyList": [
            {
                "fingerprint": "**:**:**:23:e4:fc:2f:35:21:1a:17:13:84:89:c1:e7",
                "keyName": "test-***",
                "createDate": "2025-06-25T17:22:29+0900"
            }
        ],
        "requestId": "5c560acf-c698-49ed-b16e-5dc92a3f406a",
        "returnCode": "0",
        "returnMessage": "success"
    }
}