1. 公共基础
【私有化】司空 2 OpenAPI V2.0
  • 调用指南
    • 认证鉴权教程
    • 错误码
    • 请求结构
    • 返回结果
    • 公共参数
  • 公共基础
    • 公共基础教程
    • 系统健康与接入
      • DRC 服务健康检查
    • 接入与授权
      • STS 凭证
        • 获取业务模块定制 STS 凭证
        • 获取项目级文件直传 STS 凭证
        • 获取飞行记录上传 STS 凭证
    • 安全
      • 解密飞行记录中的设备序列号(SN)
  • 组织与项目
    • 组织与项目教程
    • 项目管理
      • 项目配置
        • 获取项目自动录制配置
        • 配置项目自动录制规则
      • 项目基础信息
        • 创建项目
        • 更新项目信息
        • 获取项目详情
        • 删除项目
      • 快速加入
        • 查询快速加入项目信息
        • 通过快速加入码加入项目
    • 组织管理
      • 查询组织项目列表
      • 更新当前用户订阅设置
      • 获取组织详情
      • 更新组织信息
    • 成员与权限管理
      • 角色与权限
        • 获取项目权限树定义
        • 查询组织内项目角色列表
        • 批量创建项目级自定义角色
        • 查询角色权限映射 (角色 ID → 权限列表)
        • 删除组织自定义角色
        • 更新自定义角色
      • 组织成员
        • 批量移除组织成员
        • 查询组织成员列表
        • 批量添加组织成员
        • 批量更新组织成员信息
        • 查询当前用户在该组织内的身份与配置
        • 更新当前用户的组织呼号
        • 当前用户退出组织
      • 项目成员
        • 获取项目团队成员(在线)
        • 获取项目用户列表
        • 更新当前用户的项目呼号
  • 设备管理
    • 设备管理教程
    • 设备配置
      • HMS 事件
        • 获取组织设备 HMS 事件列表
        • 更新组织设备 HMS 已读时间
        • 更新项目设备 HMS 已读时间
        • 批量获取项目设备 HMS 事件
      • 设备影子
        • 更新组织设备影子配置
        • 更新项目设备影子配置
        • 查询组织设备物模型属性当前值
      • 通用配置指令
        • 对组织设备下发自定义指令(通用 cmds 通道)
        • 查询组织设备指令执行进度
        • 批量查询组织设备指令执行进度
        • 对项目内设备下发指令
      • 网络管理
        • 查询设备当前 NTP 服务器配置
        • 启动设备网络速度检测任务
        • 查询设备网络测速任务结果
        • 查询机库网络配置
        • 检测机库网络连接
        • 查询 4G 模组 APN 配置
      • RTK 配置
        • 查询设备的 RTK 网络账号信息
        • 自定义网络 RTK 标定
      • 对频管理
        • 查询设备对频信息
        • 设备对频指令下发
        • 查询中继扫描结果
        • 查询中继非配对连接结果
        • 查询配对请求结果
      • SIM 卡管理
        • 查询设备 SIM 卡套餐与流量信息
      • 项目设备配置
        • 修改项目设备配置参数
        • 获取项目设备配置
    • 设备列表管理
      • 项目设备列表
        • 修改组织设备的当前工作项目
        • 获取项目设备列表
        • 获取项目内单个设备详情
        • 修改项目内设备项目呼号
        • 获取项目历史拓扑设备列表
        • 获取项目设备物模型
      • 组织设备列表
        • 查询组织设备简表
        • 批量修改组织设备呼号
        • 修改单个组织设备呼号
        • 批量移除组织设备
        • 查询组织设备运维列表
        • 查询组织内某类设备的机型主键列表
        • 查询组织设备在线工作配额
  • 实时控制
    • 实时控制教程
    • 飞行控制指令
      • 实时指令
        • 查询项目内设备命令执行进度
        • 下发飞行控制指令
      • 空中任务
        • 创建空中下发航线任务
        • 控制航线任务(暂停 / 继续 / 取消)
      • 指点飞行
        • 获取飞行任务的设备推荐结果
        • 飞向目标点(一键起飞)
        • 发起飞向多目标点任务
        • 更新进行中的飞向目标点任务
        • 结束飞向目标点任务
      • 智能环绕
        • 进入 POI 环绕模式
        • 退出 POI 环绕模式
        • 更新 POI 环绕速度
        • 查询 POI 任务状态
      • 接力任务
        • 创建接力任务(双机轮转)
        • 计算接力任务的最佳接力位置
        • 编辑接力任务配置
        • 触发接力机主动起飞
        • 更新接力任务运行状态(暂停 / 恢复 / 取消)
        • 主动切换接力任务的执行机
    • 控制权管理
      • 设备控制权
        • 设备控制权操作(组织设备运维)
        • 查询设备控制权状态(组织设备运维)
        • 获取(占用)云控角色
        • 查询项目设备控制权状态
        • 查询设备最近正在操作的项目内用户列表
        • 设备控制权操作
      • 云控权限
        • 申请云控授权(向遥控器发起)
        • 批量查询飞行器云控权状态
        • 获取(占用)云控权限
        • 释放云控权限
    • 负载控制
      • 相机控制
        • 下发负载控制指令
      • PSDK 设备
        • 下发 PSDK 指令
      • 喊话器
        • 打开飞行器双向语音通道
        • 打开 DRC 实时控制通道
        • 查询喊话器资源列表
        • 创建喊话器资源
        • 删除喊话器资源
        • 编辑喊话器资源
        • 获取喊话器音频上传 STS 凭证
    • 起降协调
      • 查询起降协调区(TCA)实时状态
  • 飞行任务
    • 飞行任务教程
    • 任务查询
      • 获取当前活动航线任务(DRC 实时控制)
      • 获取当前活动航线任务(任务管理)
      • 按 UUID 批量查询飞行任务详情
      • 查询飞行任务时间冲突列表
      • 获取飞行任务详细信息(V2,含执行明细)
      • 查询机场最近 / 当前任务
      • 获取任务飞行轨迹(V2)
    • 飞行记录
      • 导出与下载
        • 飞行记录文件下载
        • 查询飞行任务导出历史
        • 导出飞行任务记录(生成 zip 异步任务)
        • 取消 / 删除导出任务
      • 操作日志
        • 查询飞行任务操作日志(V2)
    • 任务管理
      • 创建飞行任务
      • 创建飞行任务(高级版,返回子任务)
      • 检查飞行任务是否满足下发条件
      • 标记任务为已读状态
      • 检查飞行任务阻飞项
      • 支持断点续飞的立即任务
      • 删除飞行任务
      • 编辑飞行任务
      • 获取飞行任务详情
      • 下发任务媒体优先上传指令
      • 创建续飞任务(保留原断点)
      • 更新飞行任务挂起状态(挂起 / 解除挂起 / 取消)
      • 查询飞行任务列表
    • AI 飞行告警
      • 按设备 SN 查询有 AI 告警的飞行架次列表
      • 查询历史 AI 告警记录
  • 航线
    • 航线教程
    • 下载与上传
      • 打包资源到 KMZ(精准复拍流程)
      • 查询航线异步导入状态
      • 保存航线时 KMZ 上传完成回调
      • 航线 KMZ 文件导入回调
      • 批量下载航线 / 文件夹(打包 zip)
    • 航线列表管理
      • 获取航线 KMZ 下载 URL 并 302 重定向
      • 复制航线
      • 收藏航线 / 媒体资源
      • 取消收藏航线 / 媒体资源
      • 多航线拼接为一条
      • 航线库文件列表查询(V1)
      • 删除指定航线(默认软删进回收站)
      • 更新航线元信息(改名 / 锁定 / 恢复回收站)
      • 获取单条航线详情
    • 航线文件 CRUD
      • 创建航线文件夹
      • 批量删除航线 / 文件夹
      • 批量移动航线 / 文件夹到目标文件夹
      • 批量更新航线 / 文件夹锁定状态
  • 地图
    • 地图教程
    • 地图标注
      • 标注图层管理
        • 移动 / 重排图层与要素
        • 删除单个标注图层(文件夹)
        • 更新标注图层(改名 / 重排)
        • 分发标注图层到设备端
        • 锁定 / 解锁标注图层
        • 取消分发标注图层
        • 批量删除标注图层 / 要素
        • 创建标注图层(文件夹)
        • 查询标注图层(文件夹)列表
      • 标注要素管理
        • 批量修改图层下要素的显示状态
        • 清空指定图层下的所有标注要素
        • 在指定图层下创建标注要素
        • 批量导入图层及标注(KML 风格 JSON)
        • 导出图层组下要素(KML 风格 JSON)
        • 删除单个标注要素
        • 更新标注要素(改名 / 改坐标 / 改样式 / 改顺序)
      • 自定义图标
        • 查询项目自定义点位图标库
        • 注册自定义点位图标
        • 删除自定义点位图标
    • 信号热力图
      • 查询组织级信号热力图
      • 查询项目级信号热力图
    • 空域安全
      • 自定义飞行区
        • 查询项目下的飞行区域列表
        • 创建飞行区域
        • 触发飞行区配置同步到设备
        • 删除飞行区域
        • 更新飞行区域
    • 离线地图
      • 获取离线地图地表模型下载 URL
      • 触发离线地图包同步到机库
      • 获取项目离线地图详情
      • 配置项目离线地图清单(启动新一次更新)
      • 取消离线地图模型更新
  • 直播
    • 直播教程
    • 直播分享与转发
      • 旁路推流
        • 创建 / 开启 / 关闭 / 更新码流转发器
        • 查询当前组织的旁路转码器列表
        • 停止并删除指定旁路转码器(C2C 直播旁路)
      • 直播分享
        • 获取设备直播分享详情
        • 查询项目下所有直播分享链接
    • 直播推流
      • 项目维度
        • 启动直播流(项目维度)
        • 更新观众 Token(项目维度
        • 切换镜头(项目维度)
        • 切换直播相机(项目维度)
        • 上报观众加入直播房间状态(项目维度)
        • 停止直播流(项目维度)
        • 设置直播质量(项目维度,飞行器源端推流档位)
        • 查询设备直播与录制状态(项目维度)
      • 组织维度
        • 停止直播流(组织维度)
        • 设置直播质量(组织维度,飞行器源端推流档位)
        • 上报观众加入直播房间状态(组织维度)
        • 启动直播流(组织维度)
        • 切换镜头(组织维度,同时控制飞行器源端硬件)
        • 更新观众 Token(组织维度)
        • 切换直播相机(组织维度)
    • 录制任务管理
      • 开始云端录制(项目维度)
      • 停止云端录制(项目维度)
      • 查询设备录制任务列表(项目维度)
      • 启动项目内直播流
      • 查询设备录制任务列表(组织维度)
      • 开始云端录制(组织维度)
      • 停止云端录制(组织维度)
      • 停止项目内直播录制
  • 媒体
    • 媒体教程
    • 飞行任务关联
      • 按 flight_id 查飞行任务媒体
      • 批量按 flight_ids 查飞行媒体
    • 文件统计与查询
      • 获取媒体文件计数(按文件夹粒度)
      • 获取媒体文件总数(项目全量)
      • 获取媒体资源文件(图 + 文件夹)
    • 媒体文件 CRUD
      • 批量设置媒体地图显示状态
      • 批量删除媒体文件 -进回收站
      • 创建媒体文件夹
      • 获取媒体文件列表
      • 媒体文件裁剪
      • 批量移动媒体文件
      • 删除单个媒体文件
      • 获取媒体文件详情
      • 更新媒体文件信息
      • 批量硬删媒体文件-不进回收站
    • 下载与上传
      • 快速上传媒体文件
      • 导入媒体文件
      • 检查新文件指纹存在状态
      • 涂鸦回调
      • 媒体上传完成回调
      • 检查 zip 打包任务状态
      • 打包媒体文件为 zip
      • 获取媒体文件下载 URL
    • 标签管理
      • 为媒体文件添加标签
      • 删除媒体文件标签
      • 获取项目下的媒体文件标签列表
  • 模型
    • 模型教程
    • 模型重建
      • 模型重建坐标系
      • 获取飞行任务文件夹列表 V2
      • 获取实时建图任务列表
      • 发起实时建图任务(Realtime2D)
      • 获取项目模型库默认设置
      • 发起后处理重建任务(Post 2D / 3D)
      • 获取后重建默认兴趣区域
      • 获取后重建质量报告下载链接
      • 后重建任务重试
      • 停止后重建任务
      • 模型上传完成回调(客户端调用,非 OSS 验签)
      • 查询可用于模型重建的航线列表
    • 模型库
      • 模型文件管理
        • 批量删除模型文件
        • 获取项目模型文件列表
        • 创建模型文件夹
        • 批量切换模型上图状态
        • 锁定 / 解锁模型文件
        • 批量移动模型文件
        • 组织内模型共享
        • 获取模型文件总数
        • 删除单个模型文件
        • 获取模型文件详情
        • 更新模型基本信息
        • 获取模型文件下载 URL
        • 发起模型格式 / 坐标系转换任务
        • 获取项目可用的坐标系(WKT)列表
      • 地图展示
        • 批量设置实时建图模型的地形加载状态
        • 调整实时建图模型展示顺序(拖拽排序)
        • 更新建图任务元属性(改名 / 显隐 / 分发 / 取消分发 / 切换地形)
        • 获取地图页模型图层列表
        • 批量切换地图模型图层属性
        • 调整地图模型图层叠加顺序
  • 开放建模
    • 开放建模教程
    • 错误码
    • 更新日志
    • 算法参数介绍
    • 获取正在重建中的模型详情
    • 获取资源详情
    • 删除资源
    • 获取上传凭证
    • 开始重建任务
    • 上传回调
    • 停止重建任务
    • 获取模型详情
    • 删除模型
  • 回收站
    • 回收站教程
    • 单条硬删媒体文件
    • 从回收站恢复文件
    • 永久删除回收站文件
    • 获取媒体回收站文件列表
    • 修改媒体回收站配置
    • 获取媒体回收站配置
    • 获取模型库回收站磁盘统计
    • 获取媒体回收站磁盘统计
  • 高级能力
    • 高级能力教程
    • 变化检测
      • 媒体变化检测
        • 发起媒体找不同任务
        • 查询媒体找不同任务列表
        • 删除找不同任务
        • 修改找不同任务名称等属性
        • 获取找不同任务详情
        • 评价找不同任务
        • 批量修改找不同结果状态
        • 删除变化区域
        • 添加变化区域(人工标注)
        • 更新变化区域属性
        • 获取媒体上传 STS 凭证
        • 媒体找不同任务预检
        • 查看找不同检测报告
        • 获取照片组 AI 找不同结果列表
        • 获取结果组中的变化区域详情
      • 模型变化检测
        • 发起模型对比任务(找不同)
        • 查询模型对比任务列表
        • 修改模型对比任务名称等属性
        • 获取模型对比任务结果详情
        • 删除模型对比任务
        • 批量更新模型对比差异
        • 删除模型对比差异
        • 添加模型对比差异(人工标注)
        • 更新模型对比单个差异详情
        • 获取模型对比检测报告
        • 查询适合做模型对比的候选模型
        • 评价模型对比任务
  • 数据模型
    • 默认目录
      • StsCredentials
      • ProjectShareLinkDetail
      • DrcStartStreamResp
      • PutWorkspacesWaylinesBatchDeleteResp
      • PutWorkspacesWaylinesLockStatusResp
      • GetWorkspacesOfflineMapsUrlResp
      • GetWorkspacesOfflineMapsResp
      • GetWorkspacesAirSenseWarningsResp
      • PostCommonWeatherReportResp
      • GetWorkspacesWebWaylinesResp
      • PostFlightTasksAdvancedReq
      • C0034_ListOrgUsers_Resp
      • C0038_GetProjectUserPermissionTree_Resp
      • C0030_ListProjectIndividuals_Resp
      • C0031_ListProjectUsers_Resp
      • C0095_Op_Resp
      • C0096_HMS_get_Resp
      • C0077_Op_get_Resp
      • C0058_Op_Resp
      • C0575_GetHistory_Resp
      • C0564_GetTopologies_Resp
      • C0580_GetInFlight_Resp
      • C0160_GetFlightTaskAdvanced_Resp
      • C0617_GetFlightTasks_Resp
      • StsResult
      • C0619_CreateBatchDownload_Resp
      • FlightOperationVO
      • FlightTask
      • C0253_get_convertersVolcList_Resp
      • User
      • C0587_CreateStreamsSwitch_Resp
      • C0589_GetTopologiesCmds_Resp
      • C0604_GetRecordDevice_Resp
      • C0607_GetRecordDevice_Resp
      • GetWorkspacesFilesCompareFilesResp
      • DeviceModelInfo
      • DeviceState_drone_other
      • DeviceState_ea210dock
      • Position
      • DeviceState_ea210drone
      • ProjectTeamGetDevicesRspItem
      • DeviceState_ea220dock
      • ProjectTeamGetDevicesRspItemBaseTopo
      • DeviceState_ea220drone
      • DeviceState_ea230dock
      • DeviceModelEnum
      • DeviceState_ea230drone
      • DeviceState_rc510
      • DeviceState_rc701
      • DeviceState_rc_other
      • DeviceState_wa345
      • DeviceState_wm265
      • StartStreamResp
      • Device
      • Project
      • ProjectTeamGetDevicesRsp
      • StatisticsInfo
      • ChunkedFile
      • Ancestor
      • MediaFileItem
      • GetOrganizationsDevicesResp
      • GetOrganizationsManageDevicesResp
      • PostWorkspacesFlightTasksDeviceRecommendationResp
      • GetWorkspacesFlightTasksInFlightResp
      • PutWorkspacesReconstructionsResp
      • PutWorkspacesFlightAreasResp
      • GetProjectFlightAreasUrlResp
      • PutProjectFlightAreasResp
      • GetProjectFlightAreasResp
      • PostModelReconstructPreCheckResp
      • GetWorkspacesReconWaylinesResp
      • GetModelListFlightFoldersResp
      • GetModelListFlightFoldersV2Resp
      • GetWorkspacesDriveStatisticsResp
      • GetWorkspacesFilesResp
      • GetWorkspacesFilesUrlResp
      • PostWorkspacesFilesPreviewCallbackResp
      • GetDiffMediaListResp
      • PostWorkspacesStsResp
      • GetDiffModelListResp
      • GetWorkspacesDriveStatisticsTrashResp
      • GetWorkspacesMapsModelsResp
      • GetWorkspacesStsResp
      • GetWorkspacesResourcesResp
      • PostWorkspacesResourcesResp
      • PutWorkspacesResourcesResp
      • Operation
      • Exception
      • FlightReplay
      • ListTaskWayline
      • FolderUploadInfo
      • Resp
      • TaskType
      • FlightTaskType
      • TaskStatus
      • MediaPosition
      • ApiEnvelope
      • UserContactInformation
      • LiveTokenResult
      • OrganizationIndustryType
      • OrganizationUnitsConfig
      • OrganizationGeoCagingConfig
      • OrganizationDeviceBindCode
      • ProjectWorkCenterPoint
      • CloudWeatherBlockingConfig
      • weatherBlocking
      • AirportWeatherStationBlockingConfig
      • ProjectShareConfig
      • ProjectFastJoin
      • DeviceControlOperationReq
      • DeviceControlOperationRsp
      • DeviceHmsInfo
      • DeviceShadowsDesired
      • ProjectTeamUpdateDeviceShadowReq
      • DeviceTopo
      • TopoGatewayDevice
      • TopoNodeDevice
      • TopoHostDevice
      • ActionType
      • TargetType
      • AiLinkHeartBeatRequest
      • AiLinkStartStreamRequest
      • ChangeCameraStreamParam
      • CommonStreamStruct
      • RecordTask
      • RecordTaskList
      • SetQualityParam
      • StartRecordParam
      • StartStreamParam
      • StopStreamParam
      • StreamRecordResp
      • StreamStateParam
      • UpdateWebTokenItem
      • UpdateWebTokenParam
      • ParentFileInfos
      • TagItem
      • TagListOutput
      • WaylineInfo
      • ZipCheckOutput
      • Organization
      • DeviceControlStatus
      • DeviceControlCollection
      • DevicePrePreemptiveQueue
      • UserExperienceImprovement
      • ServiceError
      • ProjectWeatherBlocking
      • ChangeLensStreamParam
      • PagyInfo
      • DriveStatisticsOutput
      • StreamGroup
      • MediaFileListOutput
      • GetOrganizationsManageDevicesDeviceModelKeyResp
      • PostCommonCloudControlFunctionResp
      • GetOrganizationsDevicesRtkAccountInfoResp
      • GetOrganizationsByUuidManageDevicesCmdsResp
      • PostWorkspacesFlightTasksDroneTakeOffResp
      • PostWorkspacesFlightTasksFlyToPointsResp
      • GetWorkspacesFlightTasksDefaultNameResp
      • PostProjectsFlightTasksInFlightWayLineTaskResp
      • GetWorkspacesFlightTasksPoiTaskResp
      • PostWorkspacesFlightTasksPoiEnterResp
      • PostWorkspacesFlightTasksRelayMissionsPositionsResp
      • PostWorkspacesFlightTasksRelayMissionsActiveTakeoffResp
      • PostProjectsRtChannelsResp
      • PostProjectsVoiceChannelsResp
      • DeleteProjectsShareLiveResp
      • PostWorkspacesElementGroupsElementsResp
      • DeleteWorkspacesElementsResp
      • PutWorkspacesElementsResp
      • DeleteWorkspacesByWorkspaceIdElementGroupsResp
      • DeleteWorkspacesElementGroupsElementsResp
      • PostWorkspacesElementGroupsResp
      • DeleteWorkspacesByWorkspaceIdElementGroupsByGroupIdResp
      • PutWorkspacesElementGroupsResp
      • PostWorkspacesElementGroupsUndistributionResp
      • PutWorkspacesElementGroupsElementsStatusResp
      • PutWorkspacesElementGroupsLockStatusResp
      • PostWorkspacesElementGroupsDistributionResp
      • PutWorkspacesWorkspaceIdMediasShowOnMapResp
      • GetWorkspacesReconstructionsResp
      • GetWorkspacesFlightAreasResp
      • PostWorkspacesFlightAreasResp
      • DeleteWorkspacesFlightAreasResp
      • DeleteProjectFlightAreasResp
      • PostProjectFlightAreasResp
      • PostWorkspacesUploadCallbackResp
      • GetWorkspacesDefaultSettingsResp
      • PostModelStartRebuildResp
      • GetWorkspacesReconstructionsInterestAreaResp
      • GetWorkspacesReconstructionsReportResp
      • PostWorkspacesFilesResp
      • DeleteWorkspacesByWorkspaceIdFilesResp
      • DeleteWorkspacesByWorkspaceIdFilesByIdResp
      • GetWorkspacesWktsResp
      • PostWorkspacesFilesMoveResp
      • GetWorkspacesFilesTilesListResp
      • PostDiffMediaStartResp
      • GetDiffMediaTaskIdGetDetailResp
      • DeleteDiffMediaTaskIdResp
      • GetDiffMediaTaskIdGetReportResp
      • GetWorkspacesByWorkspaceIdComparatorsByTaskUuidResultGroupsResp
      • GetWorkspacesByWorkspaceIdComparatorsByTaskUuidResultGroupsByResultUuidResp
      • PostWorkspacesComparatorsResultGroupsDiffDetailResp
      • DeleteWorkspacesComparatorsResultGroupsDiffDetailResp
      • PostDiffModelStartResp
      • GetDiffModelTaskIdGetResultResp
      • PostWorkspacesComparatorsDiffDetailResp
      • DeleteWorkspacesComparatorsDiffDetailResp
      • GetDiffModelTaskIdGetReportResp
      • GetWorkspacesComparatorsMatchImageResp
      • GetWorkspacesGetKeyListResp
      • GetWorkspacesTilesJsonResp
      • PutModelBatchToggleDisplayResp
      • GetWorkspacesFileCountResp
      • DeleteDiffModelTaskIdResp
      • DeleteWorkspacesResourcesResp
      • PostOrganizationsAiInsideAlgorithmFileUploadResp
      • GetOrganizationsDevicesSimInfoResp
      • GetProjectsShareReportResp
      • DeleteProjectsShareReportResp
      • GetProjectsShareAnalyzerResp
      • GetProjectsShareModelResp
      • GetWorkspacesElementIconsResp
      • PostWorkspacesElementIconsResp
      • DeleteWorkspacesElementIconsResp
      • PostProjectSignalMapsResp
      • PostOrganizationsAiLinkAlgorithmsResp
      • DeleteOrganizationsAiLinkAlgorithmsResp
      • PutOrganizationsAiLinkAlgorithmsResp
      • GetOrganizationsAiLinkAlgorithmsResp
      • PostOrganizationsAiLinkAlgorithmsInstancesResp
      • DeleteOrganizationsAiLinkAlgorithmsInstancesResp
      • PutOrganizationsAiLinkAlgorithmsInstancesResp
      • GetOrganizationsAiLinkAlgorithmsInstancesResp
      • GetProjectsAiLinkAlgorithmsInstancesResp
      • ApiPagedEnvelope
      • GetOrganizationsDevicesEsimInfoResp
      • InitPermissionTreeNode
      • DroneControlsSnapshot
      • DeviceHmsInfoItem
      • PostWorkspacesWaylinesMoveResp
      • PutWorkspacesWaylineMoveResp
      • DeleteWorkspacesWaylinesByIdResp
      • PutWorkspacesWaylinesByIdResp
      • PostWorkspacesWaylinesByIdCopyResp
      • PostWorkspacesFavoritesResp
      • DeleteWorkspacesFavoritesResp
      • PostWorkspacesWaylinesConcatResp
      • PostWorkspacesOfflineMapsPackagesResp
      • PostWorkspacesOfflineMapsResp
      • DeleteWorkspacesOfflineMapsResp
      • PostCommonWeatherReportV2Resp
      • PostOrgManageDevicesCareEncryptSnResp
      • DeleteWorkspacesFlightTasksFlyToPointsResp
      • PostDrcCloudControlAuthResp
      • GetDrcCloudControlsResp
      • PostDrcCloudControlsResp
      • DeleteDrcCloudControlsResp
      • C0026_GetAutoRecordConfig_Resp
      • C0070_Op_get_Resp
      • C0073_Op_Resp
      • C0442_SIM_get_Resp
      • C0081_Op_get_Resp
      • C0086_Op_Resp
      • C0085_Op_Resp
      • C0467_GEOCaging_Resp
      • C0048_Op_get_Resp
      • C0050_Op_Resp
      • C0494_GetOnlineDeviceQuota_Resp
      • C0579_GetDefaultName_Resp
      • C0112_ProjectListcommandstatus_Resp
      • C0125_PoiGettask_Resp
      • C0145_GetRecordsSummary_Resp
      • C0147_ListExportTasks_Resp
      • C0148_ExportRecords_Resp
      • C0143_GetOperationLog_Resp
      • C0162_GetWaylineInfo_Resp
      • C0006_listFlightAlerts_Resp
      • C0559_GetAiAlertRecord_Resp
      • C0362_GetWaylineImportState_Resp
      • C0266_deleteWorkspacesWorkspaceIdElementGroupsGroupId_Resp
      • C0272_postWorkspacesWorkspaceIdElementGroupsGroupIdDistribution_Resp
      • C0333_get_tile_list_recon_files_Resp
      • C0401_get_model_get_key_list_Resp
      • C0402_get_model_get_tileset_any_Resp
      • C0396_getTrashConfig_Resp
      • C0241_get_projectsProjectUuidShareShareId_Resp
      • C0249_put_projectsProjectUuidShareShareId_Resp
      • C0247_put_projectUuidShareShareIdToggle_Resp
      • C0586_GetDeviceLinks_Resp
      • C0590_CreateTopologiesCmds_Resp
      • C0593_CreateRecordStop_Resp
      • C0594_GetControlStatus_Resp
      • C0600_GetOperationUsers_Resp
      • C0230_get_projectUuidDevicesDeviceSnRecords_Resp
      • C0222_post_stopRecord_Resp
      • C0226_post_startStream_Resp
      • C0612_CreateRecordStop_Resp
    • 默认目录
  1. 公共基础

公共基础教程

功能介绍#

公共基础模块提供司空 2 私有化版的基础设施级能力,按子标签划分:
系统健康与接入:服务存活探针,供运维平台 / 负载均衡 / 监控告警链路使用,业务侧不应直接依赖。
接入与授权 / STS 凭证:用于客户端「直传文件到对象存储」的临时凭证申请,覆盖项目通用上传、业务模块定制上传、飞行记录上传三类场景。
安全:飞行记录中加密形式的设备 SN 解密能力,便于调用方把任务详情中的加密 SN 还原为明文用于设备查询 / 展示。
私有化版本的对象存储可以是 OSS / S3 / MinIO 等,由现场部署决定;接口返回的 data.endpoint / data.bucket / data.object_key_prefix 已经按部署形态适配,调用方按返回值直接对接即可,不要硬编码任何 endpoint。
STS 凭证有过期时间(data.credentials.expire 字段为剩余有效秒数,不是 unix 时间戳),客户端应在过期前续签或重新申请,过期后继续使用会被对象存储 SDK 拒绝。
凭证返回的 data.object_key_prefix 是强制约束:服务端会按该前缀做项目数据隔离,凭证只能在该前缀下读写文件,超出前缀会被对象存储拒签。
STS 响应的完整字段(含 provider / region / bucket / endpoint / object_key_prefix 与嵌套的 credentials.{access_key_id, access_key_secret, security_token, expire})参见 返回结果 → 成功返回示例。

接口使用流程#

系统健康检查#

DRC 服务对外暴露的探针接口。当响应 HTTP 200 且 code = 0 时认为服务就绪。
调用步骤:
1.
调用 DRC 服务健康检查 (GET /openapi/v2.0/drc/health),无需任何业务参数(且不需要 x-user-token)。
2.
用 HTTP 状态码 + body code 联合判定:HTTP=200 且 code=0 即代表 DRC 服务可用;其他情况视为不可用,触发监控告警或流量摘除。

项目级文件直传(通用 STS)#

最常用的「客户端直传 → 对象存储」流程,不区分业务模块:
调用步骤:
1.
调用 获取项目级文件直传 STS 凭证 (POST /openapi/v2.0/storage/api/v1/workspaces/{workspace_id}/sts),路径参数 workspace_id 即为目标项目 UUID(参见 公共参数 → Path 参数)。
2.
拿到响应中嵌套结构的字段:data.{provider, region, bucket, endpoint, object_key_prefix} 以及 data.credentials.{access_key_id, access_key_secret, security_token, expire}。
3.
在客户端使用对象存储 SDK(OSS / S3 / MinIO)以临时凭证发起 PUT;对象 key 必须以服务端返回的 data.object_key_prefix 起头,否则会被拒绝。
4.
凭证临近过期时(data.credentials.expire 是剩余有效秒数)重新调用本接口续签。

业务模块定制 STS#

适用于一些有专门 OSS 路径规划的业务模块(如媒体下载、模型上传、变化检测报告等):
调用步骤:
1.
调用 获取业务模块定制 STS 凭证 (POST /openapi/v2.0/storage/api/v1/projects/{proj_uuid}/custom-sts),body 字段:
usage(必填,string):所属业务模块。spec 当前只声明了枚举值 alert-pdf-share;其他取值需要后端先开通。
temp(可选,bool):是否为临时数据(临时数据有更短的清理周期)。
path(可选,string):可选的子路径。
2.
服务端按 usage + temp + path 拼出限定的 data.object_key_prefix,并签发只能在该前缀下读写的临时凭证。响应字段结构与 项目级文件直传 STS 一致(嵌套 data.credentials)。
3.
客户端按业务模块约定的对象 key 规则使用凭证。
一般业务集成不需要直接调用本接口,通常封装在各业务模块的"上传 / 导入"流程内部;只有自定义扩展业务时需要主动调用。
当 usage 取值未授权(不在后端配置的允许集合内)时,后端 file-storage 会以 HTTP 200 + 业务 code = 217009(message: "invalid path")拒绝;不是 200400。

飞行记录上传#

每架次飞行结束后,机场或 Pilot 会把飞控记录、黑匣子日志等原始数据上传到云端,使用专用 STS:
调用步骤:
1.
调用 获取飞行记录上传 STS 凭证 (GET /openapi/v2.0/manage/api/v1/workspaces/{uuid}/flight-tasks/sts-info)。
2.
拿到限定到「该项目-该架次」目录前缀的 STS 凭证后,按对象存储协议直接 PUT 文件。
3.
文件上传完成后,由「飞行任务」模块的回调或主动查询接口确认归档状态(详见 飞行任务教程)。

解密飞行记录中的设备 SN#

飞行任务记录中的设备 SN 以加密形式(Base64 字符串)存储。当调用方拿到飞行任务详情后需要把这些加密 SN 用于设备查询或展示时,调用本接口批量还原。
调用步骤:
1.
通过飞行任务模块拿到任务详情,识别其中的加密 SN 字段。
2.
调用 解密飞行记录中的设备序列号(SN) (POST /openapi/v2.0/manage/api/v1/workspaces/{workspace_id}/flight-tasks/decrypt-sn),请求体 { "encrypted_sns": ["<base64-1>", "<base64-2>", ...] },encrypted_sns 为必填。
3.
收到明文 SN 后再用于设备查询、设备拓扑展示等流程。
该接口仅做双向映射:传入加密 SN 列表,返回对应的明文 SN 列表,不涉及业务校验。
私有化部署中加密密钥由部署方维护;调用方收到的明文 SN 与"设备管理"接口能查到的 SN 一致,可直接用作 device_sn / sn 参数。

与对象存储交互的常见问题#

下面是对象存储侧(OSS / S3 / MinIO 协议层)常见的拒绝原因,与司空 OpenAPI 的业务错误码无关:
现象可能原因处理建议
上传 403 / AccessDenied对象 key 没有以 data.object_key_prefix 起头 / 凭证已过期 / 操作不在 STS 授权列表(如越权 DELETE)检查 key 拼接、expire 剩余秒数、操作权限是否被 STS 授予
上传 403 / InvalidAccessKeyId客户端缓存了旧凭证 / 凭证已过期清理缓存并重新申请 STS
上传慢 / 失败对象存储 endpoint 不可达私有化部署中 endpoint 可能位于内网,确认调用方网络可达;必要时联系部署方做 NAT / 域名解析
修改于 2026-06-11 09:02:55
上一页
公共参数
下一页
DRC 服务健康检查
Built with