API —— 删除 Spatial Map 地图
此接口用于通过 mapId 永久删除指定的 Spatial Map(空间地图)数据。
1. 接口基本信息
- 接口地址:
https://armap-api-<cn1,na1>.easyar.com/map/{mapId} - 请求方法:
DELETE - 响应格式:
*/*(通常为application/json)
2. 认证方式
该接口支持以下两种鉴权模式:
- 基于 Token 认证:
- Header:
Authorization: [token] - 参数:需附带
appId。
- Header:
- 基于签名(Signature)认证:
- 参数:需附带
appId、apiKey、timestamp、signature。 - 签名计算的详细算法,参考API Key 签名方法。
- 参数:需附带
3. 请求参数
3.1 路径参数 (Path Parameters)
| 参数名称 | 类型 | 是否必选 | 描述 |
|---|---|---|---|
| mapId | String | 是 | 空间地图的唯一标识符(MapId)。 |
4. 响应数据结构 (ARMapDTO)
当请求成功(statusCode 为 0)时,返回结果 result 将包含被删除地图的快照信息。
| 字段名称 | 类型 | 描述 |
|---|---|---|
| mapId | String | 地图唯一标识。 |
| name | String | 地图名称。 |
| status | String | 地图当前状态。 |
| size | Integer (int64) | 地图文件大小。 |
| meta | String | 自定义元数据。 |
| previewUrl | String | 预览图下载链接。 |
| emeUrl | String | EME 资源链接。 |
| md5 | String | 文件的 MD5 校验码。 |
| created | DateTime | 创建时间。 |
| modified | DateTime | 最后修改时间。 |
5. 状态码
| Http Code | 含义 | 说明 |
|---|---|---|
| 200 | OK | 请求成功,返回删除的地图对象。 |
| 401 | Unauthorized | 认证失败,请检查 Token 或签名。 |
| 403 | Forbidden | 无权访问该资源。 |
Status Code 错误码
6. 示例响应 (JSON)
{
"statusCode": 0,
"msg": "success",
"timestamp": "2026-01-30T10:00:00Z",
"result": {
"mapId": "string",
"name": "example_map",
"status": "inactive",
"size": 1024
}
}