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"
  }
}