Deployment API

このセクションでは、EMQX Deployment API の概要を説明し、Deployment API キーを安全に作成および管理する方法について解説します。

API の機能

EMQX Deployment API は、クライアント監視、メッセージのパブリッシュ、認証、認可など、デプロイメントレベルでの機能を管理します。

API リファレンス	デプロイメントタイプ	説明
サーバレスデプロイメントAPI	サーバレスデプロイメント	サーバレスデプロイメントにおけるクライアント、サブスクリプション、メッセージパブリッシュの操作管理。
専用および専用FlexデプロイメントAPI	専用および専用Flex（v5）デプロイメント	専用（v5）デプロイメントにおける各種操作の管理。v4 Deployment API にアクセスする場合は、v4 API を参照してください。
BYOCデプロイメントAPI（専用デプロイメントと同じ）	BYOC（v5）デプロイメント	BYOC（v5）デプロイメントにおける各種操作の管理。

Deployment API キーの作成と管理

Deployment API キーは、EMQX Deployment API へのアクセスを認証および認可するために使用されます。API キーの作成および管理方法は、デプロイメントのタイプとバージョンによって異なります。

専用（v4/v5）デプロイメントでの API キー作成

専用（v4）および専用（v5）デプロイメントでは、各 API キーにカスタムのメモを追加し、細かいアクセス権限を割り当てることが可能です。

1. 対象のデプロイメントの Deployment Overview ページにアクセスします。

2. Deployment API Key セクションで、+ New API Key をクリックします。

3. 表示されるダイアログで以下を設定します：

   • Note（任意）：キーの目的や範囲を識別するための説明を追加します。
   • API Permissions：
     • 必要に応じて HTTP メソッド（GET、POST、PUT、DELETE）を選択します。
     • 特定の API エンドポイントをフィルタリングまたは検索します。
     • カテゴリーレベルのチェックボックスで全カテゴリまたは個別の API を選択できます。
   

4. Confirm をクリックすると、生成された App ID と App Secret が表示されます。

   重要

   App Secret はキー作成時に一度だけ表示されます。後で取得できないため、安全に保管してください。

5. ダイアログの Close をクリックします。

注意

権限機能が導入される前に作成された専用（v4）API キーは、デフォルトでフルアクセス権を持ち、メモは空欄、作成日時はリストに表示されません。完全な権限管理と作成日時の記録を得るために、古い API キーは削除して再作成することを推奨します。

サーバレスデプロイメントでの API キー作成

サーバレスデプロイメントでは、API キーは自動的にフルアクセス権で生成されます。サーバレスデプロイメントは権限設定やメモ欄をサポートしていません。

1. 対象のサーバレスデプロイメントの Deployment Overview ページにアクセスします。

2. Deployment API Key セクションで、+ New API Key をクリックします。

3. システムが自動的に App ID と App Secret を生成し、確認ダイアログに表示します。

   重要

   App Secret はキー作成時に一度だけ表示されます。後で取得できないため、安全に保管してください。

4. ダイアログの Close をクリックします。

API キーの管理

• 編集（専用 v5 および v4）：メモの更新や割り当てられた API 権限の変更が可能です。

• 削除：API キーを削除すると、即座にアクセス権が取り消されます。

• アクセス権の表示：キーのエントリを展開して、割り当てられた権限を確認できます（専用 v5 および v4）。