Platform API
本セクションでは、EMQX CloudのAPI機能と、安全なアクセス制御のためのプラットフォームAPIキーの作成および管理方法について紹介します。
APIの機能
現在、EMQX CloudはTLS証明書管理、デプロイメント管理、プロジェクト管理、および監査ログ照会APIをサポートしています。今後、さらに多くのプラットフォームレベルのAPIがサポートされる予定です。
| API | デプロイメントタイプ | 説明 |
|---|---|---|
| TLS Certificate Management | EMQX DedicatedおよびDedicated Flex v5デプロイメント プラットフォームアカウント下で作成されたEMQX v4 (4.4.x)デプロイメント | 指定されたデプロイメントのTLS証明書のライフサイクルを管理します。 |
| Deployment Management | EMQX DedicatedおよびDedicated Flex v5デプロイメント プラットフォームアカウント下で作成されたEMQX v4 (4.4.x)デプロイメント | デプロイメントの状態照会、起動、停止、作成を行います。 |
| Project Management | 対象外 | プロジェクト一覧を照会します。 |
| Audit Log Query | 対象外 | 時間範囲およびオペレーターによるアカウントレベルの監査ログを照会します。 |
プラットフォームAPIキーの作成と管理
プラットフォームAPIキーはプラットフォームレベルでのアクセス管理を提供します。プラットフォームAPIキーはルートユーザーまたは管理者アカウントで作成・管理できます。その他のロールを持つアカウントはプラットフォームAPIキーを作成または管理できません。
ご自身のアカウントでEMQX Cloudコンソールにログインします。
左側メニューから設定をクリックし、Platform API Keyタブを選択します。
Create New Keyをクリックします。API Key Descriptionに説明を入力し、Create Platform API Keyをクリックします。
必要に応じて**機能範囲（Functionality Scope）とプロジェクト範囲（Project Scope）**を選択します。APIは選択したプロジェクト内で使用可能です。Nextをクリックします。
APIキーとシークレットを安全に保管します。Confirm and Returnをクリックします。
これでプラットフォームAPIキーが作成されました。キーをクリックするとAPI情報や範囲の変更が可能です。また、ページ上の削除アイコンをクリックしてAPIキーを削除することもできます。