Skip to content

EMQX Fleets デプロイメントの管理

このページでは、EMQX Fleets デプロイメントの管理操作について説明します。デプロイメントの概要の監視、APIキーの管理、デプロイメント設定の構成などが含まれます。

デプロイメント概要

デプロイメント概要 ページは、Fleets デプロイメントのメインダッシュボードです。以下の情報を表示します。

指標説明
Thing Typesこのデプロイメントで定義されている Thing Types の総数
Things登録されているデバイスの総数
Things Online / Offline現在オンラインおよびオフラインのデバイス数
Statusデプロイメントの状態:実行中または停止中
Cloud Platformこのデプロイメントをホストしているクラウドプロバイダー
Regionデプロイメントが稼働しているリージョン
Created Atデプロイメント作成日時

デプロイメント API キー

APIキーは、Fleets REST API へのプログラムによるアクセスを可能にします。各キーには、特定のエンドポイントおよびHTTPメソッドにスコープされた独自のAPI権限セットがあります。

このデプロイメントの APIエンドポイント は、デプロイメント概要ページの Deployment API Key セクションの上部に表示されます。すべてのFleets REST API呼び出しのベースURLとしてこのURLを使用してください。

text
https://{deploymentId}.ala.gcp.fleets.mqttce.net:8443

すべてのAPIリクエストは、APIキーとシークレットを使用したBasic認証で認証してください。

text
Authorization: Basic <base64(apiKey:apiSecret)>

deployment_api_keys

APIキーの作成

  1. デプロイメント概要 ページで、Deployment API Key セクションに移動します。

  2. + New API Key をクリックします。

  3. キーの Name を入力します。

  4. API Permissions で、このキーがアクセスを許可されるエンドポイントとHTTPメソッドを選択します。メソッドボタン(GET、POST、PUT、PATCH、DELETE)でメソッドごとにフィルターするか、検索ボックスでパスのプレフィックスをフィルターできます。

    キーに実際に必要な権限のみを付与してください。例えば、デバイスがデータを報告するために使用するキーは POST /api/v1/thing-datas のみが必要です。読み取り専用の監視用キーは /api/v1/things/api/v1/thing-types への GET アクセスのみが必要です。Select All は管理やテスト目的のみに使用してください。

    new_api_key
  5. Confirm をクリックします。生成された API KeyAPI Secret がダイアログに表示されます。

    TIP

    API Secret は作成時に一度だけ表示されます。安全に保管してください。後から取得することはできません。

  6. Close をクリックします。

APIキーの管理

  • 権限の表示:キーの左側にある展開矢印をクリックすると、割り当てられた API Permissions がリソースパスごとにグループ化されて表示されます。
  • 編集Actions 列の編集アイコンをクリックして、Name の更新や API Permissions の変更ができます。
  • 削除Actions 列の削除アイコンをクリックすると、アクセスが即座に取り消されます。

重要なお知らせ

実行中のアプリケーションやデバイスで使用されているAPIキーを削除すると、それらの連携が即座に停止します。削除前にキーが使用されていないことを必ず確認してください。

デプロイメント設定

デプロイメント設定 ページには、デプロイメントの構成詳細が表示されます。

項目説明
Deployment Name編集可能。編集アイコンをクリックして名前を変更します。
Deployment IDこのデプロイメントの一意の識別子。API呼び出しやサポート依頼で使用されます。
Plan現在のプラン(例:Starter)。
Network IDこのデプロイメントのネットワーク識別子。
Cloud Platformクラウドプロバイダー(読み取り専用)。
Regionデプロイメントのリージョン(読み取り専用)。
Billing Method現在の課金方法(例:従量課金)。

デプロイメント名の変更

  1. デプロイメント設定 に移動します。
  2. Deployment Name の横にある編集アイコンをクリックします。
  3. 新しい名前を入力して確定します。

次のステップ