---
title: "getLoginKeyList"
slug: "compute-vserver-server-loginkey-getloginkeylist"
tags: ["Server"]
updated: 2026-09-17T09:57:39Z
published: 2026-09-17T09:57:39Z
canonical: "api.ncloud-docs.com/compute-vserver-server-loginkey-getloginkeylist"
---

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

# getLoginKeyList

VPC環境で利用できます。

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

## リクエスト

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

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

              参考

              

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

### リクエストヘッダ

Server APIで共通して使用されるヘッダの詳細は、[Serverのリクエストヘッダ](/docs/ja/compute-vserver#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)をご参照ください。

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

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

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `regionCode` | String | Optional | リージョンコード - [getRegionList](/docs/ja/compute-vserver-server-common-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](/docs/ja/common-vapidatatype-loginkeylist)を参照 |
| `getLoginKeyListResponse.requestId` | String | - | リクエスト ID - UUID形式 |
| `getLoginKeyListResponse.returnCode` | String | - | レスポンスコード |
| `getLoginKeyListResponse.returnMessage` | String | - | レスポンスメッセージ |

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

Server APIで共通して使用されるレスポンスステータスコードの詳細は、[Serverのレスポンスステータスコード](/docs/ja/compute-vserver#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)をご参照ください。

### レスポンス例

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

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