矢量瓦片集

获取矢量瓦片集列表

请求 URL：

• http://host:port/heycloud/api/data/vtileset/list

请求方式：

• GET

请求 Header：

字段	类型	是否必选	说明
x-heycloud-admin-session	String	是	通过 session 提供管理权限
x-heycloud-account-id	String	是	帐号的唯一标识符，如为 * 则表示不过滤帐户

请求参数:

参数名称	类型	可选值	是否必须	默认值	说明
search	String	-	否	-	搜索的文本
sortField	String	-	否	createdAt	排序的字段
sortType	String	desc | asc	否	desc	排序的类型
offset	Number	-	否	0	返回结果的偏移量，用于分页
limit	Number	-	否	11	返回结果的数量，用于分页

请求示例

GET http://host:port/heycloud/api/data/vtileset/list?search=&offset=0&limit=11

正确响应示例：

{
  "result": [
    {
      "id": "53bafec8-9abf-402e-90df-83a64be0add3",
      "accountId": "",
      "title": "搜索",
      "createdAt": "2021-06-16T06:38:48.818Z",
      "extent": null,
      "revision": "5",
      "sr": "web-mercator"
    }
  ]
}

错误响应示例：

{
  "error": "ERROR",
  "message": "错误信息"
}

获取矢量瓦片集的元数据

请求 URL：

• http://host:port/heycloud/api/data/vtileset/:vtilesetId/meta

请求方式：

• GET

请求 Header：

字段	类型	是否必选	说明
x-heycloud-admin-session	String	是	通过 session 提供管理权限
x-heycloud-account-id	String	是	帐号的唯一标识符，如为 * 则表示不过滤帐户

请求参数:

参数名称	类型	可选值	是否必须	默认值	说明
vtilesetId	String	-	是	-	矢量瓦片集的 ID

请求示例

GET http://host:port/heycloud/api/data/vtileset/xxxxx/meta

正确响应示例：

{
  "result": {
    "id": "53bafec8-9abf-402e-90df-83a64be0add3",
    "accountId": "",
    "title": "搜索",
    "createdAt": "2021-06-16T06:38:48.818Z"
  }
}

错误响应示例：

{
  "error": "ERROR",
  "message": "错误信息"
}

根据条件查询记录

请求 URL：

• http://host:port/heycloud/api/data/vtileset/:vtilesetId/query

请求方式：

• POST

请求 Header：

字段	类型	是否必选	说明
x-heycloud-admin-session	String	是	通过 session 提供管理权限
x-heycloud-account-id	String	是	帐号的唯一标识符，如为 * 则表示不过滤帐户

请求参数:

参数名称	类型	可选值	是否必须	默认值	说明
vtilesetId	String	-	是	-	矢量瓦片集的 ID
sortField	String	-	否	z	排序的字段
sortType	String	desc | asc	否	desc	排序的类型
offset	Number	-	否	0	返回结果的偏移量，用于分页
limit	Number	-	否	11	返回结果的数量，用于分页

请求示例

POST http://host:port/heycloud/api/data/vtileset/xxxxx/query

{
  "offset": 0,
  "limit": 11
}

正确响应示例：

{
  "result": [
    {
      "z": 0,
      "x": 0,
      "y": 0,
      "createdAt": "..."
    }
  ]
}

错误响应示例：

{
  "error": "ERROR",
  "message": "错误信息"
}

根据 Z/X/Y 获取一个瓦片数据

请求 URL：

• http://host:port/heycloud/api/data/vtileset/:vtilesetId/:z/:x/:y

请求方式：

• GET

请求 Header：

字段	类型	是否必选	说明
x-heycloud-admin-session	String	是	通过 session 提供管理权限
x-heycloud-account-id	String	是	帐号的唯一标识符，如为 * 则表示不过滤帐户

请求参数:

参数名称	类型	可选值	是否必须	默认值	说明
vtilesetId	String	-	是	-	矢量瓦片集的 ID
z	Number	-	是	-	Z
x	Number	-	是	-	X
y	Number	-	是	-	Y

请求示例

GET http://host:port/heycloud/api/data/vtileset/xxxxx/:z/:x/:y

正确响应示例：

{
  "result": [
    {
      "vtilesetId": "..."
    }
  ]
}

错误响应示例：

{
  "error": "ERROR",
  "message": "错误信息"
}

根据 Z/X/Y 删除一个瓦片

请求 URL：

• http://host:port/heycloud/api/data/vtileset/:vtilesetId/:z/:x/:y/delete

请求方式：

• POST

请求 Header：

字段	类型	是否必选	说明
x-heycloud-admin-session	String	是	通过 session 提供管理权限
x-heycloud-account-id	String	是	帐号的唯一标识符，如为 * 则表示不过滤帐户

请求参数:

参数名称	类型	可选值	是否必须	默认值	说明
vtilesetId	String	-	是	-	矢量瓦片集的 ID
z	Number	-	是	-	Z
x	Number	-	是	-	X
y	Number	-	是	-	Y

请求示例

POST http://host:port/heycloud/api/data/vtileset/xxxxx/:z/:x/:y/delete

正确响应示例：

{
  "result": [
    {
      "id": "...",
      "deletedAt": "..."
    }
  ]
}

错误响应示例：

{
  "error": "DELETE_NOTHING",
  "message": "没有删除任何内容"
}

更新标题

请求 URL：

• http://host:port/heycloud/api/data/vtileset/:vtilesetId/updateTitle

请求方式：

• POST

请求 Header：

字段	类型	是否必选	说明
x-heycloud-admin-session	String	是	通过 session 提供管理权限
x-heycloud-account-id	String	是	帐号的唯一标识符

请求参数:

参数名称	类型	可选值	是否必须	默认值	说明
title	String	-	是	-	更新的标题
vtilesetId	String	-	是	-	矢量瓦片集的 ID

请求示例

POST http://host:port/heycloud/api/data/vtileset/xxxxx/updateTitle

{
  title: "xxx"
}

正确响应示例：

{
  "result": [
    {
      "title": "xxx"
    }
  ]
}

错误响应示例：

{
  "error": "ERROR",
  "message": "错误信息"
}