API概要

EMQX Cloudは、プラットフォームレベルの操作、ブローカーのデプロイ操作、およびEMQX Fleetsの操作のためのREST APIを提供しています。このページでは、適切なAPIタイプを選択し、共通のアクセスおよび認証要件を理解するための情報を提供します。

APIタイプ	範囲	認証情報	リファレンス
Platform API	デプロイメント、プロジェクト、TLS証明書、監査ログなど、プラットフォームレベルのリソースを管理します。	Platform APIキーとシークレット	Platform API
Broker Deployment API	クライアント、サブスクリプション、メッセージのパブリッシュ、その他のデプロイメント操作など、ブローカーのデプロイメントレベルのリソースを管理します。	デプロイメントApp IDとAppシークレット	Broker Deployment API
EMQX Fleets API	Thingタイプ、Thing、デバイスシャドウ、コマンド、ジョブ、デバイス認証情報など、Fleetsリソースを管理します。	FleetsデプロイメントAPIキーとAPIシークレット	EMQX Fleets API

APIエンドポイントへのアクセス

各APIタイプはそれぞれ固有のエンドポイントと認証情報を持っています。エンドポイントの取得方法については、対応するAPIリファレンスを参照してください。すべてのAPIはHTTPS経由でアクセスし、ネットワーク上のデータがTLSで暗号化されるようにしてください。

認証

HTTP APIはBasic認証を使用します。ユーザー名とパスワードはAPIタイプによって異なります。

• Platform APIの場合は、Platform APIキーとシークレットを使用します。作成方法はPlatform APIキーの作成と管理を参照してください。
• Broker Deployment APIの場合は、デプロイメントApp IDとAppシークレットを使用します。作成方法はデプロイメントAPIキーの作成と管理を参照してください。
• EMQX Fleets APIの場合は、FleetsデプロイメントAPIキーとAPIシークレットを使用します。作成方法はデプロイメントAPIキーを参照してください。

すべてのシークレットは作成時に一度だけ表示されます。安全に保管してください。

HTTPステータスコード

EMQX Cloud APIでよく使われるHTTPステータスコードは以下の通りです。

ステータスコード	説明
200	成功。レスポンスボディはJSON形式で詳細情報を返します。
400	クライアントのリクエストが無効（リクエストボディやパラメータが不正など）。
401	クライアント認証に失敗。認証情報が無効な可能性があります。
404	リクエストされたパスが見つからない、または対象のオブジェクトが存在しない。
422	プロパティが無効。
500	サーバー内部でリクエスト処理中にエラーが発生。