在开始您的阅读前，请先查看本节，了解当前教程文档的结构与内容、获得阅读指引。

## 阅读公告

* 我们暂不提供 DJI Pilot 2 单独的安装包，将它内置在遥控器固件包中。DJI Pilot 2 安装方式：[Pilot2 怎么安装？哪里能够获取到安装包？](https://sdk-forum.dji.net/hc/zh-cn/articles/6177232395801-Pilot2-%E6%80%8E%E4%B9%88%E5%AE%89%E8%A3%85-%E5%93%AA%E9%87%8C%E8%83%BD%E5%A4%9F%E8%8E%B7%E5%8F%96%E5%88%B0%E5%AE%89%E8%A3%85%E5%8C%85-)。
* 我们整理了用户在实践过程中可能会出现的疑问并给出了对应的解答与指导，同时对教程文档的内容进行了补充说明。请查看[知识库](https://sdk-forum.dji.net/hc/zh-cn/categories/900001352083-%E4%B8%8A%E4%BA%91API)。
* 若您对文档内容有什么疑问，请点击任意页面右下角的“文档反馈”标志，反馈您的问题并留下您的邮箱，我们将与您联系。
* 若您有技术问题，请通过[DJI 技术支持社区](https://sdk-forum.dji.net/hc/zh-cn)反馈或者[提交表单](https://sdk-forum.dji.net/hc/zh-cn/requests/new)，会有技术人员跟进您的问题。


## 文档阅读地图

* 我们将 “产品类型枚举“ 置于基本介绍中的 [产品支持](https://developer.dji.com/doc/cloud-api-tutorial/cn/overview/product-support.html)。
* 我们将 “航线文件格式” 置于 API 介绍中的[DJI WPML](https://developer.dji.com/doc/cloud-api-tutorial/cn/api-reference/dji-wpml/overview.html)。

<div>
<div style="text-align: center"><p></p>
</div>
<div align=center><img src="https://terra-1-g.djicdn.com/71a7d383e71a4fb8887a310eb746b47f/cloudapi/v1.6/cloudapi-map.png" width="auto" ></div>
</div>

## API 总览

* 当前仅机场支持 `设备属性设置` 与 `设置直播镜头` 协议。
* 若用户的云服务无法访问外网（即 WAN），需实现 `配置更新` 功能，下发可被云服务访问的 NTP 服务的 URL，以实现时钟同步，否则航线任务将无法正常执行。
* 航线相关协议中，`创建航线任务`已废弃，请使用`下发任务`与`执行任务`。

<div>
<div style="text-align: center"><p></p>
</div>
<div align=center><img src="https://terra-1-g.djicdn.com/71a7d383e71a4fb8887a310eb746b47f/cloudapi/v1.6/cloud-api-overview.png" width="auto" ></div>
</div>

## 功能集合

<table width="100%" style="display: table; table-layout:fixed;">
<thead>
   <tr>
        <th>功能</th>
        <th>Pilot 接口实现</th>
        <th>机场接口实现</th>
    </tr>
</thead>
<tbody>
    <tr>
        <td>Pilot 与云端连接</td>
        <td>App端 API（JSBridge）：<br/>License 认证<br/>加载功能模块-API 模块<br/>获取 Token<br/>加载功能模块-设备上云模块<br/>设置工作空间 ID<br/>设置平台名称<br/></td>
        <td>-</td>
    </tr>
    <tr>
        <td>机场与云端连接</td>
        <td>-</td>
        <td>云端API（MQTT）：<br/>获取设备绑定信息<br/>查询设备绑定对应的组织信息<br/>使用设备绑定码绑定对应组织<br/></td>
    </tr>
    <tr>
        <td>态势感知</td>
        <td>App端 API（JSBridge）：<br/>加载功能模块-加载态势感知模块<br/><br/>云端 API（HTTPS）：<br/>获取设备拓扑列表<br/>自定义图标<br/>设备状态推送<br/>设备拓扑更新<br/><br/>云端 API（WebSocket）：<br/>消息发布</td>
        <td>-</td>
    </tr>
    <tr>
        <td>设备管理</td>
        <td>待整理</td>
        <td>云端API（MQTT）：<br/>设备属性推送<br/>设备拓扑更新<br/>设备属性设置</td>
    </tr>
    <tr>
        <td>直播功能</td>
        <td>App端 API（JSBridge）：<br/>加载功能模块-直播模块<br/><br/>云端API（MQTT）：<br/>直播能力更新<br/>开始直播<br/>停止直播<br/>设置直播清晰度<br/><br/>App端 API（JSBridge）：<br/>App端 手动发起直播</td>
        <td>云端API（MQTT）：<br/>直播能力更新<br/>开始直播<br/>停止直播<br/>设置直播清晰度<br/>设置直播镜头<br/></td>
    </tr>
    <tr>
        <td>地图元素</td>
        <td>App端 API（JSBridge）：<br/>加载功能模块-地图元素模块<br/><br/>云端API（HTTPS）：<br/>获取地图元素<br/>创建地图元素<br/>更新地图元素<br/>删除地图元素<br/><br/>云端API（WebSocket）：<br/>地图元素 - 消息发布<br/></td>
        <td>-</td>
    </tr>
    <tr>
        <td>媒体管理</td>
        <td>App端 API（JSBridge）：<br/>加载功能模块-加载媒体模块<br/><br/>云端API（HTTPS）：<br/>文件快传<br/>获取已经存在的文件精简指纹<br/>获取上传临时凭证<br/>媒体文件上传结果上报<br/></td>
        <td>云端API（MQTT）：<br/>获取上传临时凭证<br/>媒体文件上传结果上报</td>
    </tr>
    <tr>
        <td>航线管理</td>
        <td>App端 API（JSBridge）：<br/>加载功能模块-航线模块<br/><br/>云端API（HTTPS）：<br/>获取上传临时凭证<br/>获取航线文件列表<br/>获取航线文件下载地址<br/>获取重复的航线文件名称<br/>航线文件上传结果上报<br/>批量收藏航线文件<br/>批量取消收藏航线文件<br/></td>
        <td>云端API（MQTT）：<br/>创建航线任务(废弃)<br/>上报飞行任务进度和状态<br/>下发任务<br/>执行任务<br/>取消任务<br/>任务资源获取</td>
    </tr>
    <tr>
        <td>跳转第三方 App</td>
        <td>App端 API（JSBridge）：<br/>跳转到第三方 App</td>
        <td>-</td>
    </tr>
    <tr>
        <td>通过 JSBridge 获取日志</td>
        <td>App端 API（JSBridge）：<br/>获取日志路径<br/>设置日志加密 key<br/>清除日志加密 key</td>
        <td>-</td>
    </tr>
    <tr>
        <td>HMS 功能</td>
        <td>-</td>
        <td>云端API (MQTT)：<br/>健康告警</td>
    </tr>
    <tr>
        <td>远程调试</td>
        <td>-</td>
        <td>云端API (MQTT)：<br/>任务进度<br/>命令<br/>任务</td>
    </tr>
    <tr>
        <td>固件升级</td>
        <td>-</td>
        <td>云端API (MQTT)：<br/>固件升级进度<br/>固件升级</td>
    </tr>
    <tr>
        <td>远程日志</td>
        <td>-</td>
        <td>云端API (MQTT)：<br/>获取设备可上传的文件列表<br/>发起日志文件上传<br/>上传状态更新<br/>文件上传进度通知<br/></td>
    </tr>
    <tr>
        <td>指令飞行</td>
        <td>-</td>
        <td>云端API (MQTT)：<br/>飞行控制类指令（DRC 指令）<br/>负载控制类指令<br/>flyto 指令<br/>一键起飞指令</td>
    </tr>
</tbody>
</table>
