Platform API
このページでは、EMQX Cloud Platform APIと、セキュアなアクセス制御のためのPlatform APIキーの作成および管理方法について説明します。
APIの機能
EMQX Cloud Platform APIは、TLS証明書管理、デプロイメント管理、プロジェクト管理、および監査ログのクエリをサポートしています。
| API | デプロイメントタイプ | 説明 |
|---|---|---|
| TLS証明書管理 | EMQX DedicatedおよびDedicated Flex v5デプロイメント Platformアカウント下で作成されたEMQX v4 (4.4.x)デプロイメント | 指定されたデプロイメントのTLS証明書のライフサイクルを管理します。 |
| デプロイメント管理 | 各操作の要件を参照してください。 | デプロイメントの一覧表示、検査、起動、停止、作成を行います。DedicatedおよびDedicated Flexデプロイメントの実行用Deployment APIキーを作成します。 |
| プロジェクト管理 | 該当なし | プロジェクト一覧をクエリします。 |
| 監査ログクエリ | 該当なし | 時間範囲およびオペレーターによるアカウントレベルの監査ログをクエリします。 |
Platform APIキーの作成と管理
Platform APIキーは、Platformレベルでのアクセス管理を提供します。Rootユーザーまたは管理者アカウントでPlatform APIキーを作成および管理できます。他のロールを持つアカウントはPlatform APIキーの作成や管理ができません。
ご自身のアカウントでEMQX Cloudコンソールにログインします。
左メニューの設定をクリックし、Platform API Keyタブを選択します。
新しいキーを作成をクリックし、APIキーの説明に説明を入力します。Platform APIキーを作成をクリックします。
必要に応じて機能範囲とプロジェクト範囲を選択します。選択したプロジェクト内でAPIが使用可能になります。次へをクリックします。
APIキーとシークレットを安全に保管します。確認して戻るをクリックします。
これでPlatform APIキーが作成されました。キーをクリックするとAPI情報や範囲の変更が可能です。また、ページ上の削除アイコンをクリックしてAPIキーを削除することもできます。