Public Cloud V2.0

2026-09-20

APIの概要

Public Cloud OpenAPI V2.0は、RESTful仕様に基づくオープンプラットフォームであり、サードパーティ製クラウドプラットフォームとFlightHub 2 Public Cloud間のデータ連携と業務統合を開発者に提供することを目的としています。
OpenAPI V2.0を通じて、開発者は組織とメンバー、デバイス、飛行タスク、ライブストリームなどのデータを中心としたシステム統合を行い、デバイス監視、タスク監視、ライブストリームなどの業務アプリケーションを構築できます。

V1.0と比較して、V2.0は既存の機能を基盤として、より多くのクエリ系インターフェースおよび業務シナリオ向けインターフェースを追加しました。同時に、本バージョンではインターフェース体系を最適化し、Public CloudとOn-Premisesのインターフェースドキュメントを分離することで、インターフェースの分類をより明確にし、開発者による迅速な理解と統合を容易にするとともに、OpenAPIが今後よりアジャイルな反復サイクルへ移行することを可能にしました。

機能一覧

機能説明
組織、プロジェクトおよびメンバー情報のクエリ組織リスト、プロジェクトリスト、ユーザーリスト、権限リスト、ロール権限などの取得機能を提供します。
デバイス情報のクエリ組織またはプロジェクト配下のデバイスリスト、プロジェクトのデバイス詳細、デバイス履歴トポロジ、HMS情報、物モデル情報、映像伝送解像度などを取得でき、デバイス資産管理やステータス表示に利用できます。
飛行タスク飛行タスクの作成、タスクリストのクエリ、タスク詳細、飛行軌跡、メディアリソース、飛行記録のダウンロード、操作ログ、AI飛行アラートなどの機能をサポートします。
リアルタイム制御デバイス制御権ステータスのクエリ、制御権の取得、カメラ切り替えなどの機能をサポートします。
ライブストリームと転送ライブストリームの開始、録画タスクのクエリ、およびストリーム転送機の作成、クエリ、削除などの機能をサポートします。
飛行ルートクエリプロジェクト配下の飛行ルートリストの取得、飛行ルート詳細の取得などの機能をサポートします。
モデル再構築FlightHubの飛行タスクで収集されたメディアデータを使用してモデリングタスクを開始することをサポートします。
オープンモデリングサードパーティクラウドのメディアデータを使用してモデリングタスクを開始することをサポートします。

インターフェースドキュメント

インターフェースドキュメントには、OpenAPIの機能一覧、チュートリアル、インターフェース一覧およびインターフェースの説明が含まれます。詳細については、Open APIインターフェースドキュメントを参照してください。

サンプルソースコード

サンプルソースコードをデプロイして正常に実行すると、OpenAPI V2.0をベースに開発された機能画面を体験できます。サンプルソースコードを通じて、OpenAPIの接続方法や使用方法をすばやく理解でき、開発と統合を加速できます。

サンプルソースコード をクリックして、ソースコードと接続ガイドを入手してください。

製品アーキテクチャ

クイックスタート

認証と認可

認証と認可チュートリアルを参照し、OpenAPIの認証と認可の原理を理解した上で、X-User-TokenおよびX-Project-Uuidを取得してください。これら2つのパラメータは、ほとんどのインターフェースのヘッダーフィールドで渡される必要があり、OpenAPIのセキュリティを確保し、FlightHub 2へのアクセス制御を実現するために使用されます。

サンプルコード

1. FlightHub 2システムステータスのクエリ

FlightHub 2 Public Cloudはインターフェースを呼び出してシステムステータスをクエリします： FlightHub 2システムステータスのクエリ

```http
GET /openapi/v2.0/system_status HTTP/1.1
Host: 127.0.0.1:30812
X-Language: zh
X-Request-Id: 550e8400-e29b-41d4-a716-446655440000
X-User-Token: xxxxxxxx

インターフェースが0を返した場合、FlightHub 2システムが正常に動作していることを示します：

```http 
{
  "code": 0,
  "message": ""
}

2. 組織配下のプロジェクトリストを取得

FlightHub 2上で組織を作成し、プロジェクトを作成してデバイスをバインドします。本説明書「プラットフォーム基礎 > 組織管理」の章を参照してFlightHub 2上で関連する組織およびプロジェクトの作成操作を行った後、組織配下のプロジェクトリストを取得インターフェースを呼び出して、作成済みのプロジェクトリストを取得してください。

GET /openapi/v2.0/project?usage=complete&sort_column=create_time&sort_type=desc&page=1&page_size=20 HTTP/1.1
Host: 127.0.0.1:30812
X-Language: zh
X-Request-Id: 550e8400-e29b-41d4-a716-446655440000
X-User-Token: xxxxxxxx

作成済みのプロジェクトリストが返されます：

```http 
{
  "code": 0,
  "message": "",
  "data": {
    "list": [
      {
        "name": "c2c_test",
        "introduction": "a",
        "uuid": "93df839d-ae74-4f04-842e-2f1f81c89a66",
        "org_uuid": "105ddd05-34ce-46b6-a872-cb32b8c98f64",
        "created_at": 1702498686,
        "updated_at": 1702498686,
        "project_work_center_point": {
          "latitude": 22.906899500237845,
          "longitude": 113.69995967214662
        }
      }
    ]
  }
}

3. ライブストリーム機能を開始

本説明書の章ドキュメント《デバイス管理》を参照してFlightHub 2上でデバイスのバインド操作を行った後、ライブストリーム管理チュートリアルを参照し、ライブストリームを開始インターフェースを呼び出してライブストリーム配信を開始してください。

```http 
POST /openapi/v2.0/live-stream/start HTTP/1.1
Host: 127.0.0.1:30812
X-Project-Uuid: xxxxxxxxxx
X-Language: zh
X-Request-Id: 550e8400-e29b-41d4-a716-446655440000
Content-Type: application/json
X-User-Token:  xxxxxxxx 
Content-Length: 119

{
    "sn": "7CTDM3Dxxxxxx",
    "camera_index": "165-0-7",
    "video_expire": 7200,
    "quality_type": "adaptive"
}

ライブストリームの認証情報が返されます：data.urlを、data.url_typeに対応するベンダーのSDKと組み合わせて使用し、ライブストリームを取得してください：

```c
{
  "code": 0,
  "message": "",
  "data": {
    "expire_ts": 1779446430,
    "url": "http://127.0.0.1:30806/rtc/v1/whep/?app=live&stream=7CTDM3Dxxxxxx_165-0-7&token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwcm9kdWN0X2lkIjoiNzEzNTE5ZmIxYjRlNDRiYTlkMjdkMDJhOGRlZDk5NGQiLCJjaGFubmVsX25hbWUiOiI3Q1RETTNEMDBCWk5WWl8xNjUtMC03IiwidWlkIjoxDAxMTQsImFjdGlvbiI6InBsYiLCJleHAiOjE3NjQ3NTE2MzAsIm5iZiI6MTczMzIxNTYzMCwiaWF0IjoxNzMzMjE1NjMwfQ._AysitutpprlgYGFy4lDL_gSv4Y3hl_te-yxoFVHZb4",
    "url_type": "srs"
  }
}
Last Updated: