Table of Contents

API —— 更新 Spatial Map 地图信息

此接口通过指定的 mapId 更新地图信息。支持类似 HTTP PATCH 的更新方式,即仅修改请求中提供的参数,未提供的参数将保持原样。

1. 接口基本信息

  • 接口地址https://armap-api-<cn1,na1>.easyar.com/map/{mapId}
  • 请求方法PUT
  • 请求格式multipart/form-data
  • 响应格式*/* (通常为 application/json)

2. 认证方式

该接口支持以下两种鉴权模式:

  1. 基于 Token 认证
    • HeaderAuthorization: [token]
    • 参数:需附带 AppId
  2. 基于签名(Signature)认证
    • 使用 APIKeyAPISecretAppId 和参数生成签名进行校验。
    • 签名计算的详细算法,参考 API Key 签名方法

3. 请求参数

3.1 路径参数 (Path Parameters)

参数名称 类型 是否必选 描述
mapId String 空间地图的唯一标识符(MapId)。

3.2 表单参数 (Form Parameters)

由于采用 multipart/form-data 格式,以下参数需通过表单字段提交。

参数名称 类型 是否必选 描述
file File 新的地图数据文件。
name String 地图显示名称。
gps String 地图关联的 GPS 坐标(如:"121.4541,31.2221")。
tag String 地图标签。
meta String 自定义元数据(通常为 Base64 编码字符串)。
clusterInfo String 集群相关信息。
emeBlocklist String EME 黑名单配置,默认为 "[]"。

4. 响应数据结构 (ARMapDTO)

当请求成功(statusCode 为 0)时,返回结果 result 将包含更新后的地图对象详情。

字段名称 类型 描述
statusCode Integer 状态码。0 代表成功。
msg String 状态描述信息。
timestamp DateTime 服务器响应时间戳。
result Object 更新后的 ARMapDTO 对象。

ARMapDTO 对象结构

字段名称 类型 描述
mapId String 地图唯一标识。
name String 地图名称。
status String 地图当前状态。
size Integer (int64) 地图文件大小(字节)。
gps String 地图关联的 GPS 坐标信息。
tag String 地图标签。
meta String 自定义元数据。
md5 String 更新后地图文件的 MD5 校验码。
modified DateTime 最后修改时间。

5. 状态码 (Status Codes)

Http Code 含义 说明
200 OK 请求成功。
201 Created 更新成功并已创建相关记录。
401 Unauthorized 认证失败,请检查 Token 或签名。
403 Forbidden 无权访问该资源。
404 Not Found 未找到指定的 mapId

Status Code 错误码

6. 示例响应 (JSON)

{
  "statusCode": 0,
  "msg": "success",
  "timestamp": "2026-01-30T10:00:00Z",
  "result": {
    "mapId": "e61db301-e80f-4025-b822-9a00eb48d8d2",
    "name": "updated_office_scene",
    "status": "active",
    "gps": "121.4541,31.2221",
    "modified": "2026-01-30T10:00:00Z"
  }
}