ブローカー デプロイメント API

ブローカー デプロイメント API を使用して、EMQX Cloud のブローカー デプロイメントを管理します。このページでは、安全な API アクセスのためのデプロイメント API キーの作成および管理方法について説明します。

API の機能

ブローカー デプロイメント API は、クライアント監視、メッセージのパブリッシュ、認証、認可など、デプロイメントレベルの操作をサポートします。

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

デプロイメント API キーの作成と管理

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

稼働中の Dedicated または Dedicated Flex デプロイメントでは、プラットフォーム API を使ってデプロイメント API キーを作成することも可能です。プラットフォーム API は、新しいキーに API 権限のホワイトリスト制限を設定できます。要件と制限については、デプロイメント API キーの作成 を参照してください。

Dedicated および Dedicated Flex デプロイメントでの API キー作成

Dedicated および Dedicated Flex デプロイメントでは、各 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 をクリックします。

注意

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

ソースおよび認可キャッシュ権限（v5/v6）

Dedicated および Dedicated Flex (v5/v6) デプロイメントでは、デプロイメント API キー作成・編集時に、ソース API および認可キャッシュリセット権限を選択できます。ソース API 権限により、Kafka Consumer Source などのソースをブローカー デプロイメント API 経由で管理可能です。

API Permissions の下で、Data Integration -> Actions (Source) を展開し、ソース API 権限を選択します。アプリケーションに必要なパスと HTTP メソッドのみを選択してください。

権限パス	HTTP メソッド	用途
/api/v5/sources	GET, POST, PUT, DELETE	ソースの管理
/api/v5/source_types	GET	利用可能なソースタイプの一覧取得

/api/v5/sources に対して選択した HTTP メソッドの権限は、/api/v5/sources/{id}、/api/v5/sources_summary、/api/v5/sources_probe など、/api/v5/sources で始まる API パスにも適用されます。各リクエストは、特定の API 操作でサポートされるパスとメソッドを使用する必要があります。

読み取り専用アクセスの場合は、必要な GET 権限のみ選択してください。コネクター、出力アクション、ルール API の権限はソース API へのアクセス権を付与しません。必要なソース API 権限がないリクエストは 403 を返す場合があります。

ノードレベルの認可キャッシュをリセットするには、認可権限グループ内の /api/v5/authorization/node_cache/reset に対して POST 権限を選択してください。このエンドポイントは POST のみをサポートし、EMQX 5.10.0 以降が必要です。

重要なお知らせ

これらの権限オプションが利用可能になる前に作成された API キーは、ソースおよび認可キャッシュリセット権限を自動的に持ちません。これらの API を使用するには、キーを編集し、必要な権限を選択して保存してください。

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

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

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

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

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

   重要

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

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

API キーの管理

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

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

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