---
title: "プレイヤーリストの照会"
slug: "vpe-api-list"
updated: 2026-09-17T09:58:18Z
published: 2026-09-17T09:58:18Z
canonical: "api.ncloud-docs.com/vpe-api-list"
---

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

# プレイヤーリストの照会

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

プレイヤーリストを照会します。

## リクエスト

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

| メソッド | URI |
| --- | --- |
| GET | /api/v1/players |

### リクエストヘッダ

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

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

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

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `page_no` | Integer | Optional | ページ番号 - 1~1000 (デフォルト: 1) |
| `page_size` | Integer | Optional | ページごとの項目数 - 10~1000 (デフォルト: 10) |
| `sort_type` | String | Optional | 作成日基準のソート順序 - `desc` (デフォルト) \| `asc` - `desc`: 降順 - `asc`: 昇順 |

### リクエスト例

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

```
curl --location --request GET 'https://vpe.apigw.ntruss.com/api/v1/players' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--header 'x-ncp-region_code: KR'
```

## レスポンス

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

### レスポンスボディ

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

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `code` | String | - | レスポンスコード |
| `message` | String | - | レスポンスメッセージ |
| `result` | Object | - | レスポンス結果 |
| `result.list` | Array | - | プレイヤーリスト: [list](/docs/ja/vpe-api-list#list) |
| `result.total` | Integer | - | レスポンス結果数 |
| `result.page_no` | Integer | - | ページ番号 |
| `result.page_size` | Integer | - | ページごとの項目数 |
| `result.page_count` | Integer | - | ページの総数 |
| `result.pricing` | String | - | 料金プラン - `free` \| `pay` - `free`: 無料 - `pay`: 有料 |

#### `list`

`list`の説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `no` | Integer | - | プレイヤー番号 |
| `name` | String | - | プレイヤー名 |
| `version` | String | - | プレイヤー SDKバージョン |
| `access_key` | String | - | プレイヤー Access Key |
| `updated_at` | String | - | プレイヤー更新日時 - ISO 8601形式 |
| `created_at` | String | - | プレイヤー作成日時 - ISO 8601形式 |

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

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

### レスポンス例

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

```
{
    "code": "200",
    "message": "ok",
    "result": {
        "list": [
            {
                "no": 6284,
                "name": "player001",
                "version": "latest",
                "access_key": "5a2f************************1830",
                "updated_at": "2025-08-12T02:17:10.000+00:00",
                "created_at": "2025-08-12T02:17:10.000+00:00"
            },
            {
                "no": 6159,
                "name": "player000",
                "version": "1.1.3",
                "access_key": "7848************************102d",
                "updated_at": "2025-08-12T02:23:31.000+00:00",
                "created_at": "2025-05-27T05:34:37.000+00:00"
            }
        ],
        "total": 2,
        "page_no": 1,
        "page_size": 10,
        "page_count": 1,
        "pricing": "pay"
    }
}
```