Platform API

本セクションでは、EMQX Platform APIの機能と、安全なアクセス制御のためのPlatform APIキーの作成および管理方法について説明します。

APIの機能

現在、EMQX PlatformはTLS証明書管理、デプロイメント管理、およびプロジェクト管理のAPIをサポートしています。今後、さらに多くのプラットフォームレベルのAPIがサポートされる予定です。

API	デプロイタイプ	説明
TLS Certificate Management	EMQX Dedicated v5 デプロイメント Platformアカウント配下で作成されたEMQX v4 (4.4.x) デプロイメント	指定したデプロイメントのTLS証明書のライフサイクルを管理します。
Deployment Management	EMQX Dedicated v5 デプロイメント Platformアカウント配下で作成されたEMQX v4 (4.4.x) デプロイメント	デプロイメントの状態照会、起動、停止、作成を行います。
Project Management	該当なし	プロジェクト一覧の照会を行います。

Platform APIキーは、Platformレベルでのアクセス管理を提供します。Platform APIキーはRootユーザーまたは管理者アカウントで作成および管理できます。その他のロールを持つアカウントではPlatform APIキーの作成や管理はできません。

ご自身のアカウントでEMQX Platformにログインします。
右上のユーザーアイコンをクリックし、Platform API Key を選択してPlatform APIキーのページにアクセスします。
Create New Key をクリックします。API Key Description に説明を入力し、Create Platform API Key をクリックします。
必要に応じて Functionality Scope と Project Scope を選択します。選択したプロジェクト内でAPIが利用可能になります。Next をクリックします。
APIキーとシークレットを安全に保管します。Confirm and Return をクリックします。

これでPlatform APIキーが作成されました。キーをクリックするとAPI情報やスコープの変更が可能です。また、ページ上の削除アイコンをクリックしてAPIキーを削除することもできます。