您现在的位置: 开发 > geohub > 数据中心 > 数据服务 > 空间数据管理接口

空间数据管理接口 最后更新时间: 2022年06月30日

产品介绍

空间数据管理接口是一类Web API接口服务,在GeoHUB前端数据托管能力的基础上,支持开发者通过REST服务请求迅速进行数据增删改查,以提供更为专业、轻量、灵活的数据管理方式。该服务以HTTP/HTTPS形式封装多种数据搜索接口,其中包括数据集维度和内容维度两种操作。以下为调用该接口前的数据准备流程:

  1. 使用API前您需先申请Key若无高德地图API账号需要先申请账号。
  2. 前往GeoHUB数据中心创建您的数据集,并且保存上线,获取数据集ID。

适用场景

用户上传空间数据集后,需要数据集相关的增删改查操作,方便开发者灵活调用。

  • 数据集维度操作
    • 获取数据集信息列表:根据uid获取数据集列表,返回数据集详情数组
    • 数据集详情:查询单个数据集的详情,返回数据集详情对象
    • 创建空数据集:创建空数据集表,并建立相应的空间表
    • 编辑数据集:编辑数据集属性字段、类型等,并修改相应空间表的属性字段
    • 删除数据集属性:删除数据集属性字段、类型等,并删除相应空间表的属性字段
    • 删除数据集:删除数据集,并删除相应空间表
  • 内容维度操作
    • 获取feature列表获取feature列表,包括gid/geometry/properties
    • 增加单个feature:增加单个feature,输入geojson,返回gid
    • 编辑单个feature:编辑单个feature,输入geojson,返回gid
    • 批量新增feature:批量增加单个feature,输入geojson数组,返回gid数组
    • 批量编辑feature:批量编辑feature,输入geojson数组,返回gid数组
    • 删除feature:删除单个feature,或者全部删除

使用限制

三方数据空间检索接口对个人认证开发者和企业开发者开放。

使用说明

第一步,申请”Web服务API”密钥(Key);

第二步,拼接HTTP请求URL,第一步申请的Key需作为必填参数一同发送;

第三步,接收HTTP请求返回的数据(JSON或XML格式),解析数据。

如无特殊声明,接口的输入参数和输出数据编码全部统一为UTF-8。

服务文档

说明:所有请求中query请带上key和sig参数,如下:

参数名

含义

参数类型

规则说明

是否必须

缺省值

key

请求服务权限标识

string

用户在高德地图官网申请Web服务API类型Key

必填

sig

数字签名

string

数字签名获取和使用方法

可选

1. 批量读取数据集信息

该接口可返回多个数据集的相关信息,其中包括:数据集名称、数据集创建时间、数据集最近更改时间、数据集中的数据对象计数、数据集大小、数据集中的全局属性信息。

API 服务地址

URL

http://restapi.amap.com/rest/lbs/geohub/dataset/list?key=<用户的key>&sig="sig"

请求方式

Post

请求参数 (Body)

参数名

含义

参数类型

规则说明

是否必须

缺省值

dataset_id

数据集ID数组

array

数据集ID数组,未填写即返回全量数据集信息列表

(例: [dataset_id1, dataset_id2, dataset_id3])

可选

offset

每页记录数据

integer

整型, 强烈建议不超过25,若超过25可能造成访问报错

可选

20

page

页数

integer

整型

可选

1

sortby

排序方式

string

“created”:创建时间倒序排列

“modified”:更改时间倒序排列

可选

modified

返回结果

参数名

参数类型

说明

status

string

本次API访问状态,如果成功返回1,如果失败返回0。

info

string

访问状态值的说明,如果成功返回"ok",失败返回错误原因,具体见错误码说明

infocode

string

返回状态说明,10000代表正确,详情参阅info状态表

datasets

object

数据集信息

dataset_id

string

数据集ID(如:728c0d71-506e-47c8-b65e-916e46549422

dataset_name

string

数据集名称

created

string

数据集创建时间

modified

string

数据集最近更改时间

feature_cnt

integer

数据对象计数(如:点+线+面对象个数)

size

float

数据集大小(单位:MB)

properties_info

object

全局属性信息

property

name

string

属性名称

type

string

属性类型("string"/"boolean"/"number")

响应示例

{
    "status": "1",
    "info": "success",
    "infocode": "10000",
    "datasets": [
        {
            "dataset_id": "14c83abf-7140-41d0-8250-20ce7cab3cdd",
            "dataset_name": "测试1",
            "created": "2022-01-10T08:18:01.544Z",
            "modified": "2022-01-10T08:18:04.603Z",
            "feature_cnt": 50,
            "properties_info": {
                "属性1": "string",
                "属性2": "number",
                "属性3": "boolean"
            },
            "size": 0.12
        }
    ]
}

2. 读取单个数据集信息

该接口可返回单个数据集的相关信息,其中包括:数据集名称、数据集创建时间、数据集最近更改时间、数据集中的数据对象计数、数据集大小、数据集中的全局属性信息。

API 服务地址

URL

http://restapi.amap.com/rest/lbs/geohub/dataset/detail?key=<用户的key>&sig="sig"&?dataset_id=<用户的dataset_id>

请求方式

Get

请求参数 (Query)

参数名

含义

参数类型

规则说明

是否必须

缺省值

dataset_id

数据集ID

string

数据集ID数(如:728c0d71-506e-47c8-b65e-916e46549422)

必填

返回结果

同「批量读取数据集信息」返回参数一致,但仅返回单个数据集信息。具体参数详见上文。

响应示例

{
    "status": "1",
    "info": "success",
    "infocode": "10000",
    "datasets": [
        {
            "dataset_id": "14c83abf-7140-41d0-8250-20ce7cab3cdd",
            "dataset_name": "测试1",
            "created": "2022-01-10T08:18:01.544Z",
            "modified": "2022-01-10T08:18:04.603Z",
            "feature_cnt": 50,
            "properties_info": {
                "属性1": "string",
                "属性2": "number",
                "属性3": "boolean"
            },
            "size": 0.12
        }
    ]
}

3. 创建空数据集

该接口可以创建全新的空数据集。需指定数据集名称,可选择配置全局属性(属性名称:属性类型)。

API 服务地址

URL

http://restapi.amap.com/rest/lbs/geohub/dataset/create?key=<用户的key>&sig="sig"

请求方式

Post

请求参数 (Body)

参数名

含义

参数类型

规则说明

是否必须

缺省值

dataset_name

数据集名称

string

数据集创建时所使用的名称

必填

prop_setting

属性配置

object

设置全局属性的属性名称,以及对应的属性类型(包括:string/number/boolean) 例:

"prop_setting": {

"prop_name1":"number",

"prop_name2":"boolean",

"prop_name3":"string"

}

可选

返回参数

同「读取单个数据集信息」返回参数一致,但仅返回单个数据集信息。具体参数详见上文。

响应示例

{
    "status": "1",
    "info": "ok",
    "infocode": "10000",
    "datasets": {
        "dataset_id": "6fa6aea3-54a7-4d99-b292-767acded3283",
        "dataset_name": "测试2",
        "created": "2022-01-10T11:33:43.115Z",
        "modified": "2022-01-10T11:33:43.115Z",
        "feature_cnt": 0,
        "properties_info": {
            "属性1": "string",
            "属性2": "number",
            "属性3": "boolean"
        },
        "size": 0
    }
}

4. 编辑数据集信息

该接口可对数据集进行重命名,并修改数据集的全局属性。

API 服务地址

URL

http://restapi.amap.com/rest/lbs/geohub/dataset/update?key=<用户的key>&sig="sig"

请求方式

Post

请求参数 (Body)

参数名

含义

参数类型

规则说明

是否必须

缺省值

dataset_id

数据集ID

string

数据集ID(如:728c0d71-506e-47c8-b65e-916e46549422)

必填

dataset_name

数据集名称

string

数据集名称(如需修改数据集名称,填写该项)

可选

prop_setting

属性配置

object

设置全局属性的属性名称,以及对应的属性类型(包括:string/number/boolean)

例:

"prop_setting": {

"prop_name1":"number",

"prop_name2":"boolean",

"prop_name3":"string"

}

可选

返回参数

同「读取单个数据集信息」返回参数一致,详见上文。

响应示例

{
    "status": "1",
    "info": "success",
    "infocode": "10000",
    "datasets": {
        "dataset_id": "6fa6aea3-54a7-4d99-b292-767acded3283",
        "dataset_name": "test_name_change",
        "created": "2022-01-10T11:33:43.115Z",
        "modified": "2022-01-10T11:35:50.966Z",
        "properties_info": {
            "属性0": "string"
        },
        "feature_cnt": 0,
        "size": 0
    }
}

5. 删除数据集全局属性

删除数据集中单个/多个全局属性。

API 服务地址

URL

http://restapi.amap.com/rest/lbs/geohub/dataset/delprops?key=<用户的key>&sig="sig"

请求方式

Post

请求参数 (Body)

参数名

含义

参数类型

规则说明

是否必须

缺省值

dataset_id

数据集ID

string

数据集ID(如:728c0d71-506e-47c8-b65e-916e46549422)

必填

prop_name

属性名称数组

array

属性名称数组[prop_name1, prop_name2, prop_name3]

必填

注意:删除属性会删除对应空间表中feature对应的属性

返回参数

参数名

参数类型

说明

status

string

本次API访问状态,如果成功返回1,如果失败返回0。

info

string

访问状态值的说明,如果成功返回"ok",失败返回错误原因,具体见错误码说明

infocode

string

返回状态说明,10000代表正确,详情参阅info状态表

success

boolean

false: 删除失败          true:删除成功

响应示例

{
    "status": "1",
    "info": "ok",
    "infocode": "10000",
    "success": true
}

6. 删除数据集

API 服务地址

URL

http://restapi.amap.com/rest/lbs/geohub/dataset/delete?key=<用户的key>&sig="sig"

请求方式

Post

请求参数 (Body)

参数名

含义

参数类型

规则说明

是否必须

缺省值

dataset_id

数据集ID数组

array

数据集ID数组 [dataset_id1, dataset_id2, dataset_id3]

必填

注意:已发布的数据集不可删除

返回参数

参数名

参数类型

说明

status

string

本次API访问状态,如果成功返回1,如果失败返回0。

info

string

访问状态值的说明,如果成功返回"ok",失败返回错误原因,具体见错误码说明

infocode

string

返回状态说明,10000代表正确,详情参阅info状态表

success

boolean

false: 删除失败      true:删除成功

响应示例

{
    "status": "1",
    "info": "ok",
    "infocode": "10000",
    "success": true
}

7. 读取数据集内容

该接口可读取数据集中的所有数据对象,包括数据对象的地理位置坐标及其相关属性。

API 服务地址

URL

http://restapi.amap.com/rest/lbs/geohub/geo/feature/list?key=<用户的key>&sig="sig"&?parameters

请求方式

Get

请求参数 (Query)

参数名

含义

参数类型

规则说明

是否必须

缺省值

dataset_id

数据集ID

string

数据集ID(如:728c0d71-506e-47c8-b65e-916e46549422)

必填

gid

feature唯一标识

integer

用于识别feature的唯一标识

可选

offset

每页记录数据

integer

整型, 强烈建议不超过25,若超过25可能造成访问报错

可选

20

page

页数

integer

整型

可选

1

返回参数

名称

类型

说明

status

string

本次API访问状态,如果成功返回1,如果失败返回0。

info

string

访问状态值的说明,如果成功返回"ok",失败返回错误原因,具体见错误码说明

infocode

string

返回状态说明,10000代表正确,详情参阅info状态表

dataset_id

string

数据集ID(如:728c0d71-506e-47c8-b65e-916e46549422)

objects

object

符合关键字筛选条件的数据对象

gid

integer

用于识别feature的唯一标识

geometry

coordinates

array

点对象(array):[39.23489, 127.32487]

线/面对象(array):

[[39.23489, 127.32487], [39.23489, 127.32487] ,...]

type

string

Point/Polyline/Polygon/MultiPoint/MultiPolyline/MultiPolygon

properties

property1

name

string

属性名称

value

string/number/boolean

属性值

property2

name

string

属性名称

value

string/number/boolean

属性值

...

...

...

...

响应示例

{
    "status": "1",
    "info": "ok",
    "infocode": "10000",
    "dataset_id": "14c83abf-7140-41d0-8250-20ce7cab3cdd",
    "objects":[
    	   {
            "gid": 1,
            "geometry": {
                "type": "Polygon",
                "coordinates": [
                    [
                        [
                            120.17529296875,
                            30.2459106445313
                        ],
                        [
                            120.160095214844,
                            30.2459106445313
                        ],
												...
                    ]
                ]
            },
            "properties": {
                "属性1": "清波街道",
                "属性2": 37,
                "属性3": true
            }
        },
        ...
    ]
}

8. 增加单个数据对象

API 服务地址

URL

http://restapi.amap.com/rest/lbs/geohub/geo/feature/add?key=<用户的key>&sig="sig"

请求方式

Post

请求参数 (Body)

参数名

含义

参数类型

规则说明

是否必填

默认值

dataset_id

数据集ID

string

数据集ID(如:728c0d71-506e-47c8-b65e-916e46549422

必填

geometry

coordinates

feature坐标点

array

点对象(array):[39.23489, 127.32487]

线/面对象(array):

[[39.23489, 127.32487], [39.23489, 127.32487] ,...]

必填

type

feature类型

string

Point/Polyline/Polygon/MultiPoint/MultiPolyline/MultiPolygon

必填

properties

property1

name

属性名称

string

指定属性名称

可选

value

属性值

string/

number/

boolean

为属性赋值

可选

property2

name

属性名称

string

指定属性名称

可选

value

属性值

string/

number/

boolean

为属性赋值

可选

注意:properties中的属性值必须在数据集prop_setting设置的返回之内和类型保持一致,否则返回失败

返回参数

参数名

参数类型

说明

status

string

本次API访问状态,如果成功返回1,如果失败返回0。

info

string

访问状态值的说明,如果成功返回"ok",失败返回错误原因,具体见错误码说明

infocode

string

返回状态说明,10000代表正确,详情参阅info状态表

gid

integer

用于识别feature的唯一标识

success

boolean

false: 增加失败

true:增加成功

响应示例

{
    "status": "1",
    "info": "ok",
    "infocode": "10000",
    "gid": 51,
    "success": true
}

9. 编辑单个数据对象

API 服务地址

URL

http://restapi.amap.com/rest/lbs/geohub/geo/feature/edit?key=<用户的key>&sig="sig"

请求方式

Post

请求参数 (Body)

参数名

含义

参数类型

规则说明

是否必须

缺省值

dataset_id

数据集ID

string

数据集ID(如:728c0d71-506e-47c8-b65e-916e46549422)

必填

gid

feature唯一标识

integer

用于识别feature的唯一标识

必填

geometry

coordinates

feature坐标点

array

点对象(array):[39.23489, 127.32487]

线/面对象(array):

[[39.23489, 127.32487], [39.23489, 127.32487] ,...]

可选

type

feature类型

string

Point/Polyline/Polygon/MultiPoint/MultiPolyline/MultiPolygon

properties

property1

name

属性名称

string

指定属性名称

可选

value

属性值

string/

number/

boolean

为属性赋值

property2

name

属性名称

string

指定属性名称

value

属性值

string/

number/

boolean

注意:properties中的属性值必须在数据集prop_setting设置的范围之内和类型保持一致,否则返回失败

返回参数

参数名

参数类型

说明

status

string

本次API访问状态,如果成功返回1,如果失败返回0。

info

string

访问状态值的说明,如果成功返回"ok",失败返回错误原因,具体见错误码说明

infocode

string

返回状态说明,10000代表正确,详情参阅info状态表

gid

integer

用于识别feature的唯一标识

success

boolean

false: 增加失败

true:增加成功

响应示例

{
    "status": "1",
    "info": "ok",
    "infocode": "10000",
    "gid": 51,
    "success": true
}

10. 批量增加数据对象

API 服务地址

URL

http://restapi.amap.com/rest/lbs/geohub/geo/feature/bulkadd?key=<用户的key>&sig="sig"

请求方式

Post

请求参数 (Body)

参数名

含义

参数类型

规则说明

是否必须

缺省值

dataset_id

数据集ID

string

数据集ID(如:728c0d71-506e-47c8-b65e-916e46549422

必填

features

feature1

geometry

coordinates

feature坐标点

array

点对象(array):[39.23489, 127.32487]

线/面对象(array):

[[39.23489, 127.32487], [39.23489, 127.32487] ,...]

必填

type

feature类型

string

Point/Polyline/Polygon/MultiPoint/MultiPolyline/MultiPolygon

properties

property1

name

属性名称

string

指定属性名称

可选

value

属性值

string/

number/

boolean

为属性赋值

property2

name

属性名称

string

指定属性名称

value

属性值

string/

number/

boolean

为属性赋值

feature2

...

注意:properties中的属性值必须在数据集prop_setting设置的范围内和类型保持一致,否则返回失败

返回参数

参数名

参数类型

说明

status

string

本次API访问状态,如果成功返回1,如果失败返回0。

info

string

访问状态值的说明,如果成功返回"ok",失败返回错误原因,具体见错误码说明

infocode

string

返回状态说明,10000代表正确,详情参阅info状态表

gid

array

批量增加feature后,为各个feature生成的gid组成的数组

success

boolean

false: 增加失败

true:增加成功

success_cnt

integer

成功上传个数

响应示例

{
    "status": "1",
    "info": "ok",
    "infocode": "10000",
    "gid": [
        53,
        54
    ],
    "success": true,
    "success_cnt": 2
}

11. 批量编辑数据对象

API 服务地址

URL

http://restapi.amap.com/rest/lbs/geohub/geo/feature/bulkedit?key=<用户的key>&sig="sig"

请求方式

Post

请求参数 (Body)

参数名

含义

参数类型

规则说明

是否必须

缺省值

dataset_id

数据集ID

string

数据集ID(如:728c0d71-506e-47c8-b65e-916e46549422

必填

features

feature1

geometry

coordinates

feature坐标点

array

点对象(array):[39.23489, 127.32487]

线/面对象(array):

[[39.23489, 127.32487], [39.23489, 127.32487] ,...]

必填

type

feature类型

string

Point/Polyline/Polygon/MultiPoint/MultiPolyline/MultiPolygon

properties

property1

name

属性名称

string

指定属性名称

可选

value

属性值

string/

number/

boolean

为属性赋值

property2

name

属性名称

string

指定属性名称

value

属性值

string/

number/

boolean

为属性赋值

feature2

...

注意:properties中的属性值必须在数据集prop_setting设置的返回之内和类型保持一致,否则返回失败

返回参数

参数名

参数类型

说明

status

string

本次API访问状态,如果成功返回1,如果失败返回0。

info

string

访问状态值的说明,如果成功返回"ok",失败返回错误原因,具体见错误码说明

infocode

string

返回状态说明,10000代表正确,详情参阅info状态表

gid

array

批量增加feature后,为各个feature生成的gid组成的数组

success

boolean

false: 增加失败

true:增加成功

success_cnt

integer

成功上传个数

响应示例

{
    "status": "1",
    "info": "ok",
    "infocode": "10000",
    "gid": [
        53,
        54
    ],
    "success": true,
    "success_cnt": 2
}

12. 删除数据对象

API 服务地址

URL

http://restapi.amap.com/rest/lbs/geohub/geo/feature/delete?key=<用户的key>&sig="sig"

请求方式

Post

请求参数

参数名

含义

参数类型

规则说明

是否必须

缺省值

gid

featureID

array

用于识别feature的唯一标识所组成的数组

必填

dataset_id

数据集ID

string

数据集ID(如:728c0d71-506e-47c8-b65e-916e46549422

必填

delete_all

清库选项

boolean

true:清库

可选

返回参数

参数名

参数类型

说明

status

string

本次API访问状态,如果成功返回1,如果失败返回0。

info

string

访问状态值的说明,如果成功返回"ok",失败返回错误原因,具体见错误码说明

infocode

string

返回状态说明,10000代表正确,详情参阅info状态表

success

boolean

false: 删除失败

true:删除成功

success_cnt

integer

成功删除个数

failed_gids

array

删除失败的gid数组

响应示例

{
    "status": "1",
    "info": "ok",
    "infocode": "10000",
    "failed_gids": [],
    "success": true,
    "success_cnt": 2
}

示例
中心
常见
问题
智能
客服