---
title: "API Key管理"
slug: "ai-mlxp-apikey"
updated: 2026-10-20T08:56:04Z
published: 2026-10-20T08:56:04Z
canonical: "guide.ncloud-docs.com/ai-mlxp-apikey"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://guide.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API Key管理

VPC環境で利用できます。

API Keyは、ML expert Platformコンソールにログインしていない外部プログラムや自動化タスクが、ML expert Platformのリソースにアクセスする際に使用する認証手段です。Model Registry CLI/SDK、Data Manager SDK、Pipelines SDK、および非公開で運用されている推論エンドポイントの呼び出しに使用します。

本ガイドでは、API Keyの種類と権限モデル、発行・照会・削除の方法、サービスごとの使用方法について説明します。

## API Keyの種類

API Keyは、発行範囲によって2種類に分けられます。アクセスしようとするリソースがどこに属するかによって、種類を選択します。

| 種類 | 発行場所 | アクセス対象 | トークン形式 |
| --- | --- | --- | --- |
| Project API Key | **Project > Home > API Key**タブ | Projectに属するモデル、推論エンドポイント、Pipelines | `mlx-prj_`で始まる |
| Workspace API Key | **Workspace > Dashboard > API Keys**タブ | Workspaceに属するモデル、Data Managerのデータセット | `mlx-wrk_`で始まる |

- データセットは Workspaceが所有するリソースであるため、Workspace API Keyでのみアクセスできます。
- 推論エンドポイントと Pipelinesは Projectが所有するリソースであるため、Project API Keyでのみアクセスできます。
- 1つの API Keyに複数の権限をまとめて設定できます。異なる Workspaceや Projectのリソースにアクセスする必要がある場合は、それぞれ API Keyを発行します。

              参考

              

以前のバージョンで Workspace Dashboardから発行されていたアカウント単位の API Key(`mlx-`で始まる)は、今後新規に発行できなくなります。既に発行されたキーは有効期限まで引き続き使用できますが、有効期限が切れる前に本ガイドに記載されている Project API Keyまたは Workspace API Keyにローテーションしてください。

## 権限モデル

API Keyは **リソースタイプ(Type)** 、**権限レベル(Scope)** 、**対象(Target)** の組み合わせによって権限を指定します。API Keyは指定された権限の範囲内でのみ動作し、それ以外のリクエストは拒否されます。

### Project API Keyに指定できる権限

| リソースタイプ | 権限レベル | 説明 | 対象指定 |
| --- | --- | --- | --- |
| Model | reader, writer | Project Model Registryにおけるモデルの照会(reader)、作成・アップロード・削除(writer) | モデル名 |
| InferenceService | invoke | 推論エンドポイントの呼び出し | InferenceService名 |
| LLMInferenceService | invoke | LLM推論エンドポイントの呼び出し | LLMInferenceService名 |
| KubeflowPipeline | writer | Pipelines APIの呼び出し(実験・実行の作成を含む) | 指定不可(Project全体) |

### Workspace API Keyに指定できる権限

| リソースタイプ | 権限レベル | 説明 | 対象指定 |
| --- | --- | --- | --- |
| Model | reader, writer | Workspace Model Registryにおけるモデルの照会(reader)、作成・アップロード・削除(writer) | モデル名 |
| Dataset | reader, writer, admin | データセットの読み取り(reader)、作成·アップロード·Tag/Branch作成(writer)、データセット削除(admin) | データセット名 |

権限レベルは、上位レベルが下位レベルを含みます(admin ⊇ writer ⊇ reader)。

### 対象(Target)指定ルール

- 対象を指定すると、名前が一致するリソースにのみ権限が適用されます。
- 対象を指定しない場合、当該 Projectまたは Workspace内の同種のリソースすべてに権限が適用されます。
- 対象はリソースの**名前**に基づいて適用されます。発行時点で存在しない名前を指定すると、後で同じ名前のリソースが作成された際に、その権限が適用されます。
- KubeflowPipelineは対象を指定できず、常に Project全体に適用されます。

              注意

              

API Keyの権限、有効期間、タイプは、発行後に変更することはできません。権限を変更するには、既存の API Keyを削除し、新たに発行してください。

## API Key管理権限

API Keyのリスト照会、トークン表示、発行、削除は、当該 Projectまたは Workspaceの **Admin**ロールを持つユーザーのみが行うことができます。API Keyのリストにはトークンの原文が含まれるため、Writer、Readerのロールには API Keyタブが表示されません。

| タスク | Project API Key | Workspace API Key |
| --- | --- | --- |
| リスト照会・トークン表示・発行・削除 | Project Admin | Workspace Admin |

ロールを指定する方法は、[Members](/docs/ja/ai-mlxp-pmembermngt)や [Member Settings](/docs/ja/ai-mlxp-membermngt)をご参照ください。

## API Key発行

Project API Keyを発行する方法は、次の通りです。Workspace API Keyは、**Workspace > Dashboard > API Keys**タブで同様の方法で発行します。

1. ML expert Platformコンソールで Projectを選択し、**Home > API Key**タブに移動します。
2. リスト上部にある **Add**をクリックします。発行されたキーが1つもない場合は、画面中央の**追加**ボタンをクリックします。
3. **API Key発行**のポップアップに以下の項目を入力します。
  - **API Key名**: 英小文字(a-z)、数字(0-9)、ハイフン(-)を使用して、63文字以内で入力します。先頭と末尾は、英小文字または数字にする必要があります。
  - **有効期間(日)**: 1~365の整数を入力するか、入力欄の右側にある**7d**、**30d**、**90d**、**365d**のいずれかを選択します。デフォルト値は30日で、入力欄の下に有効期限が予定されている時刻が表示されます。
  - **説明**(オプション): 利用先や発行対象を256文字以内で記入します。
  - **Permissions**: リソースタイプ、権限レベル、対象を選択します。権限をさらに追加するには、**権限追加**ボタンをクリックします。権限は1つ以上追加する必要があり、同じ(リソースタイプ、権限レベル)組み合わせは1回のみ追加できます。
4. **発行**をクリックします。
  - 発行直後は、リストのステータスが**発行中**と表示される場合があります。しばらくしてからリストを更新すると、トークンを確認できます。

              参考

              

- 有効期間の最大値は、プラットフォームの運用設定によって異なる場合があります。デフォルトの上限は365日です。
- 有効期間は発行時刻から計算され、延長することはできません。有効期限が切れた後も引き続き使用する必要がある場合は、有効期限が切れる前に新しい API Keyを発行し、使用先のキーをローテーションしてください。

## API Key照会

**Home > API Key**タブ(Workspaceは **Dashboard > API Keys**タブ)のリストには、API Key名、Permissions、Expiration At(有効期限)、ステータス、発行者、説明が表示されます。トークン値を確認する方法は、次の通りです。

1. リストから確認したい API Keyの行にある**表示**をクリックします。
2. **API Key表示**画面で、名前、発行者、説明、有効期限、Permissions、トークンを確認し、**確認**をクリックします。

トークンのみをクリップボードにコピーするには、行の**コピー**をクリックします。

リストのステータスは次の通りです。

| ステータス | 説明 |
| --- | --- |
| 発行中 | トークンを作成中です。しばらくしてから再度確認します。 |
| 有効期限間近 | 有効期限が間近に迫っている API Keyです。ローテーションの準備をします。 |
| Expired | 有効期限が切れた API Keyです。認証には使用できず、削除できます。 |
| 現在なし | Permissions列に表示されるバッジです。権限の対象として指定された名前のリソースが現在存在しないことを意味し、同じ名前のリソースが作成されると、権限が適用されます。 |

              注意

              

トークンはパスワードと同様に扱ってください。ソースコードリポジトリ、チャット、ドキュメントにトークンを残さないでください。漏洩の疑いがある場合は、直ちに削除し、新たに発行してください。

## API Key削除

API Keyを削除すると、当該トークンを介して送信されるリクエストは直ちに拒否されます。

1. **Home > API Key**タブ(Workspaceは **Dashboard > API Keys**タブ)に移動します。
2. リストから削除したい API Keyの行のチェックボックスを選択します。一度に1つだけ選択できます。
3. リストの上部にある **Delete**をクリックします。
4. **API Key削除**画面で**削除**をクリックします。

有効期限が切れた API Keyも、同じ方法で削除します。

## API Key使用

APIキーは、HTTPリクエストの `Authorization` ヘッダに Bearerトークンとして送信します。各サービスの使用方法は、次の通りです。

### 推論エンドポイントの呼び出し

推論エンドポイントを非公開で運用するには、`InferenceService` または `LLMInferenceService`に次のアノテーションを設定します。アノテーションを設定しない場合、エンドポイントは認証なしで呼び出すことができます。

```
metadata:
  annotations:
    mlx.navercorp.com/access-mode: restricted
```

非公開エンドポイントは、次の2つの方法で呼び出すことができます。

- 対象 `InferenceService`(または `LLMInferenceService`)に `invoke` 権限を持つ Project API Key
- 当該 Projectメンバーの kubeconfigトークン

Project API Keyで呼び出す例は、次の通りです。エンドポイント URLは、リリースしたサービスの `IngressRoute`で確認します。推論サービスのリリースと `IngressRoute` 設定については、[Serving](/docs/ja/ai-mlxp-pserving)をご参照ください。

```
curl -H "Authorization: Bearer {API Key}" \
  -H "Content-Type: application/json" \
  https://{推論エンドポイント URL}/v1/models/{InferenceService名}:predict \
  --data-binary @input.json
```

              参考

              

`InferenceService`の `invoke` 権限は、predictor、transformer、explainerの各コンポーネント全体に適用されます。アノテーションを `restricted`で削除するか、`public`に置き換えると、再度認証なしで呼び出すことができます。

### Pipelines SDK

ML Expert Platform以外(ローカル PC、CIサーバなど)で Pipelines SDKを使用してパイプラインを実行するには、`KubeflowPipeline` `writer` 権限を持つ Project API Keyが必要です。

```
import kfp

client = kfp.Client(
    host="https://{ML expert Platformドメイン}/pipeline",
    existing_token="{API Key}",
    namespace="p-{Project名}",
)
```

- `KubeflowPipeline` 権限のない API Keyで呼び出すと、`403 APIKey does not grant KubeflowPipeline access` エラーが発生します。権限は発行後に追加できないため、新しい API Keyを発行してください。
- Workspace API Keyは Pipelines APIには使用できません。
- プロジェクトを作成した直後は、`403 project serviceaccount not provisioned` エラーが発生することがあります。しばらくしてから再度お試しください。

パイプラインの作成方法については、[Pipelines](/docs/ja/ai-mlxp-ppipelines)をご参照ください。

### Model Registry CLI/SDK

Model Registry CLI/SDKでは、環境変数 `MLX_APIKEY` または `mlx configure` コマンドを使用して API Keyを設定します。

```
export MLX_ENDPOINT_URL="https://{ML expert Platformドメイン}"
export MLX_APIKEY="{API Key}"
```

- Projectのモデルでは `Model` 権限を持つ Project API Key、Workspaceのモデルでは `Model` 権限を持つ Workspace API Keyを使用します。
- モデルの照会・ダウンロードには `reader`、モデル・バージョンの作成、およびファイルのアップロード・削除には `writer` 権限が必要です。
- 推論サービスが Model Registryのモデルをダウンロードする際に使用する `storage-config` Secretにも、`Model` `reader` 権限を持つ API Keyを指定します。

詳しい使用方法は、[Model Registry](/docs/ja/ai-mlxp-pmodelregistry)をご参照ください。

### Data Manager SDK

Data Manager SDKは、`Dataset` 権限を持つ Workspace API Keyを使用してログインします。

```
from mlx.sdk.data import login

login("{API Key}", "{ML expert Platformドメイン}")
```

| タスク | 必要な権限レベル |
| --- | --- |
| データセットのリスト・詳細を照会、ダウンロード | reader |
| データセットの作成、アップロード、Tagと Branchの作成 | writer |
| データセット削除 | admin |

特定のデータセットのみ許可するには、権限の対象としてデータセット名を指定します。詳しい使用方法は、[Data Manager](/docs/ja/ai-mlxp-datamanager)をご参照ください。

## API Keyと kubeconfigの比較

ML expert Platformは API Key以外に Project単位の `kubeconfig`も提供します。用途に合わせて選択します。

| 項目 | API Key | kubeconfig |
| --- | --- | --- |
| 用途 | 外部プログラム・自動化タスクが Model Registry、Data Manager、Pipelines、推論エンドポイントにアクセス | ユーザーが `kubectl`で Project Namespaceにワークロードを作成・照会 |
| 権限基準 | 発行時に指定したリソースタイプ・権限レベル・対象 | ユーザーの Projectメンバーロール(Admin/Writer/Reader) |
| 発行主体 | Projectまたは Workspace Admin | Projectメンバー本人 |
| 有効期間 | 1~365日(デフォルトは30日) | 1日~運用設定の上限(デフォルトは90日) |
| 有効期限前に失効 | 削除すると直ちに無効となる | 不可(メンバーから除外する場合は権限のみ回収) |

kubeconfigの発行方法は、[Overview](/docs/ja/ai-mlxp-pscreen)をご参照ください。

## トラブルシューティング

| 症状 | 原因 | 解決方法 |
| --- | --- | --- |
| コンソールに API Keyタブが表示されない | Adminロールではない | Projectまたは Workspace Adminに発行をリクエスト |
| 401エラー | トークンの入力ミス、有効期限切れの API Key、削除された API Key | コンソールでステータスを確認し、必要に応じて再発行 |
| 403エラー | リクエストしたリソースに対する権限または対象が API Keyにない、または異なるタイプの API Keyが使用されている(例: Workspace API Keyで Pipelinesを呼び出し) | 必要な権限と対象を含む、適切なタイプの API Keyを新たに発行 |
| データセットの削除が403エラーにより拒否される | `Dataset` 権限レベルが adminではない | `Dataset` `admin` 権限が付与された Workspace API Keyを発行 |
| 発行直後にトークンが表示されない | トークン作成中 | しばらくしてからリストを更新 |