请求示例示例返回结果更新数据更新数据请求 Content-Type 请求参数返回结果字段说明请求示例示例返回结果删除数据 ( 单条 / 多条 ) 删除

Size: px

Start display at page:

Download "请求示例示例返回结果更新数据更新数据请求 Content-Type 请求参数返回结果字段说明请求示例示例返回结果删除数据 ( 单条 / 多条 ) 删除"

邑上官
5 years ago
Views:

1 云存储 APIv 表操作创建表... 1 创建表请求... 1 Content-Type... 1 请求参数... 1 返回结果字段说明... 2 请求示例... 3 示例返回结果数据操作创建单条数据... 3 创建单条数据请求... 3 Content-Type... 4 请求参数... 4 返回结果字段说明... 5 请求示例... 6 示例返回结果批量创建数据... 6 批量创建数据请求... 6 Content-Type... 7 请求参数... 7 返回结果字段说明

2 请求示例示例返回结果更新数据更新数据请求 Content-Type 请求参数返回结果字段说明请求示例示例返回结果删除数据 ( 单条 / 多条 ) 删除数据请求 Content-Type 请求参数返回结果字段说明请求示例示例返回结果批量创建进度查询批量创建数据进度查询进度查询请求请求参数返回结果字段说明请求示例示例返回结果

3 3. 错误码说明注意事项

4 1. 表操作 1.1 创建表创建一个存储用户数据的表, 等同于在数据管理台手工创建一个地图创建表请求请求地址 : 服务协议 :HTTP/POST Content-Type application/x-www-form-urluncoded 请求参数名称含义规则说字段类型是否必须缺省值明 key 客户唯一用户申 string(32) 标识, 请请, 由高求服务的德地图密钥 API 后台自动分配 1

5 name 表的名称支持任 string(50) 意中英文字符数字下划线 string(280) 可选数字签名获选择数字 sig 数字签名取和使用方法签名认证的用户必填返回结果字段说明名称 status 说明返回状态取值规则 :1: 成功 ;0: 失败是否必须返回必须 info tableid status = 1,info 返回 ok status = 0,info 返回以下值 -11: 失败, 已存在相同名称表必须 -21: 失败, 已创建表达到最大数目更多返回值查看 : 错误码说明生成的数据表的唯一标识 ( 该参数是发起数据存储 API 必须以及检索 API 的参数 ) 2

6 请求示例示例返回结果 { } "info":"ok", "status":1, "tableid":"53a4093fe4b0a4a84f9b66cf 2 数据操作 2.1 创建单条数据向指定 tableid 的数据表中插入一条新数据创建单条数据请求创建单条数据地址 : 3

7 服务协议 :HTTP/POST. Content-Type application/x-www-form-urluncoded 请求参数名称含义规则说明是否必须缺省值 key 客户唯一标识用户申请, 由高德地图 API 后台自动分配 tableid 数据表唯一标识设置是以请求中的经纬度参数 (_location) 还是地址参数 (_address) loctype 定位方式来计算最终的坐标值可选 1 可选值 : 1: 经纬度 ; 2: 地址 data 新增的数据创建的数据规则 :json _name 数据名称类型 :string _locatio n 坐标类型 :string 支持点数据当时, loctype=1 4

8 规则 : 经度, 纬度, 经纬度支持到小数点后 6 位 coordty pe 坐标类型类型 :string 可选值 :autonavi;gps 可选 autona vi _addre ss 地址类型 :string 当 loctype=2 时, <custo mfield1 > 用户自定义字段 1 <custo mfield > 用户自定义字段选择数字签名 sig 数字签名数字签名获取和使用方法认证的用户必填返回结果字段说明名称说明是否必须返回 status info 返回状态取值规则 :1: 成功 ;0: 失败 status = 1,info 返回 ok status = 0,info 返回参见 : 错误码说明必须必须 _id 成功创建的数据 id 必须 5

9 请求示例示例返回结果 { } "info":"ok", "status":1, "_id":"283" 2.2 批量创建数据向指定 tableid 的数据表中通过上传文件的方式创建多条数据该接口为异步接口, 请求后立即返回后台进程 batchid, 通过批量创建数据进度查询接口查看任务执行进度和结果批量创建数据请求批量创建数据地址 : 服务协议 :HTTP/POST. 6

10 Content-Type application/multipart/form-data 请求参数名称含义规则说明是否必须缺省值 key 客户唯一标识用户申请, 由高德地图 API 后台自动分配 tableid 数据表唯一标识规则 : 1) 文件格式 :csv 文件的二进制流, 使用 UTF8 编码, 字段总数不超过 40 个 ; 2) 数据量不超过条 file 新增的数据文件且文件大小不超过 10M; 3) 字段命名规则 : 以英文字母开头, 仅由英文字母数字下划线组成, 总长度不超过 20 位 ; _name 文件中代表名称的字段 loctype 定位方式设置是以文件中的经纬度字段还是地址字段来计算可选 1 7

11 最终的坐标可选值 : 1: 经纬度 ; 2: 地址 _address 文件中代表地址的字段当 loctype=2 时, longitud e 文件中代表经度的字段当 loctype=1 时, latitude 文件中代表纬度的字段当 loctype=1 时, 可选, 仅当定位方 coordtyp e 坐标类型可选值 :autonavi;gps 式 loctype=1 autona vi 时, 该字段有效选择数字签 sig 数字签名数字签名获取和使用方法名认证的用户返回结果字段说明名称说明是否必须返回 8

12 返回状态 status info 值为 0 或 1 1: 成功 ; 0: 失败 status = 1,info 返回 ok status = 0,info 返回参见 : 错误码说明本次批处理任务的唯一标识必须必须若批量处理任务创建成功, 则返回该任务的唯一标识 batchid batchid 可选用户使用批量处理进度查询接口可查询该 batchid 对应的任务处理进度和结果每个 batchid 的有效期为 : 处理结束后 1 小时内 9

13 请求示例上传文件 sample.csv 示例 : 示例返回结果 { } "info":"ok", "status":1, "batchid":52b2ba09e4b0490b86c07ba7 10

14 2.3 更新数据指定 tableid 的数据表中更新一条数据更新数据请求更新数据请求地址 : 服务协议 :HTTP/POST. Content-Type application/x-www-form-urluncoded 请求参数名称含义规则说明是否必须缺省值 key 客户唯一标识用户申请, 由高德地图 API 后台自动分配数据表 tableid 唯一标识设置是以请求中的经纬度参数 loctype 定位方式 (_location) 还是地址参数 (_address) 来计算最终的坐标值可选 1 可选值 : 11

15 1: 经纬度 ; 2: 地址规则 :json 更新规则 : 1 只更新请求中上传的字段, 未上传的字段保留原值, 如 : data={"_id":"3","_location":" data 新增的数据 733, "}, 则本次请求仅更新 _location 字段值, 其他字段如 _name, _address 等其他用户自定义字段将保持原值 2 若希望清空某字段值, 则赋值 null 即可, 如 : data={"_id":"3","_name":null} _id 数据 id 类型 :string _name 数据名称类型 :string 可选类型 :string _locatio n 坐标支持点数据规则 : 经度, 纬度, 经纬度支持到小数点可选后 6 位 coordty pe 坐标类型类型 :string 可选值 : 可选 autona vi 12

16 autonavi gps _addre ss 地址类型 :string 可选 <custo mfield1 > 用户自定义字段 1 <custo mfield > 用户自定义字段选择数 sig 数字签名数字签名获取和使用方法字签名认证的用户必填返回结果字段说明名称含义规则说明是否必须返回 status 返回状态值为 0 或 1 1: 成功 ; 0: 失败返回的 status = 1,info 返回 ok info 状态信 status = 0,info 返回参见 : 息错误码说明 13

17 请求示例示例返回结果 { } "info":"ok", "status":1 2.4 删除数据 ( 单条 / 多条 ) 删除指定 tableid 的数据表中条数据删除数据请求删除数据请求地址 : data/delete 服务协议 :HTTP/POST. Content-Type application/x-www-form-urluncoded 14

18 请求参数名称含义规则说明是否必须缺省值 key 客户唯一标识用户申请, 由高德地图 API 后台自动分配数据表 tableid 唯一标识 8 位英文和数字混合字符串 ids 删除的数据 _id 一次请求限制 1-50 条数据, 多个 _id 用逗号隔开 sig 数字签名数字签名获取和使用方法选择数字签名认证的用户返回结果字段说明名称含义规则说明是否必须返回值为 0 或 1 status 返回状态 1: 成功 ; 0: 失败 info 返回的状态信息 status = 1,info 返回 ok status = 0,info 返回参见 : 错误码说明 success 删除成功数非负整数 15

19 目 fail 删除失败数目非负整数请求示例示例返回结果 { } "info":"ok", "status":1, "success":1, "fail":1 2.5 批量创建进度查询批量处理管理接口为用户提供查看批处理的进度和结果信息批量创建数据进度查询查询指定 batchid 的批量创建数据后台进程的进度和结果 16

20 进度查询请求进度查询请求地址 : 服务协议 :HTTP/GET. parameters 代表的参数包括参数和可选参数所有参数均使用和号字符 (&) 进行分隔下面的列表枚举了这些参数及其可能的值请求参数名称含义规则说明是否必须缺省值 key 客户唯一标识用户申请, 由高德地图 API 后台自动分配 tableid 数据表唯一标识 batchid 批量处理任务唯一标识 sig 数字签名数字签名获取和使用方法选择数字签名认证的用户返回结果字段说明名称含义规则说明是否必须返回 status 返回状态值为 0 或 1 1: 成功 ; 17

21 0: 失败 info 返回的状态信息 status = 1,info 返回 ok status = 0,info 返回参见 : 错误码说明 progress 处理进度取值范围 [0,100] 可选 imported 已导入的数据数目非负整数可选取值范围 : 非负整数 - 当 loctype=1 时, 只要用户传入合规的经纬度, 系统都将认为是准确定位 - 当 loctype=2 时, 当系统能够 locaccurate 定位准确数目根据传入地址精确定位坐标到以下 4 类结果上时, 系统认为可选是准确定位 : 1) 道路交叉路口 ; 2) 公交站台地铁站 ; 3) 门牌号 ; 4) 兴趣点 (POI); 取值范围 : 非负整数 locinaccurate 定位可能偏差数目当 loctype=2, 即用地址进行定位时, 会因为地址不够精确或可选系统地址库缺失, 造成系统计 18

22 算出的坐标可能不在用户所期望的位置, 系统将此情形认为定位可能偏差如, 当地址为 XX 省或 XX 省 XX 市 XX 区 XX 街道等范围较大的区域时此参数主要作为提醒使用, 并不影响该条数据的任何操作取值范围 : 非负整数 - 当 loctype=1 时, 若用户传入空的或非法的坐标时, 则 locfail 定位失败数目系统认为定位失败 ; - 当 loctype=2 时, 若系统根可选据传入地址法计算出坐标, 至坐标为空则该条数据请求示例 b0bc61deeb7629&batchid=52b2ba09e4b0490b86c07ba7&key=< 用户 key> 示例返回结果 { 19

23 } "info":"ok", "progress ":87, "imported ":269, "locaccurate ":230, "locinaccurate ":27 "locfail ":12, 3. 错误码说明 stauts( 请求状态码 ) 0( 请求失败 ) info( 状态码对应说明 ) info 值枚举如下 : tableid 不存在 _id 不存在服务器维护中参数缺失或格式非法账号未激活或已被冻结 UNKNOWN_ERROR:code (code = -101~-404 之间, 表示云图服务内部错误 ;code = -41, 表示 key 和 tableid 不在同一高德用户账户下, 权访问 ) SERVICE_NOT_EXIST ( 表示 : 请求的服务不存在 ) IN VALID_USER_KEY( 表示 :key 效 ) USER_VISIT_TOO_FREQUENTLY ( 表示 : 用户访问过于频繁, 服务不响应 ) NOT_SUPPORT_HTTPS ( 表示 : 不支持 HTTPS 请求 ) INVALID_USER_IP ( 表示 : 用户 IP 效 ) INVALID_USER_SIGNATURE ( 表示 : 该服务响应错误 ) INVALID_USER_SCode ( 表示 : 用户安全码未通过 ) 未知错误 ( 以上错误之外的未定义的错误 ) 20

24 4. 注意事项 API 服务密钥 : 高德云图存储 API 使用 API 密钥来标识用户的应用服务请求 url 中的 key 参数为参数, 需要填入此密钥所以, 使用接口前请获取 Key, 若高德地图 API 账号需要先申请账号编码格式 : 如特殊声明, 接口的输入参数和输出数据编码全部统一为 UTF- 8 21

酒神 (长篇小说)

酒神 (长篇小说) 酒神 ( 长篇小说 ) 作家 : 莫言第一章一省人民检察院的特级侦察员丁钩儿搭乘一辆拉煤的解放牌卡车到市郊的罗山煤矿进行一项特别调查沿途, 由于激烈思索, 脑袋膨胀, 那顶本来晃晃荡荡的五十八号咖啡色鸭舌帽竟紧紧地箍住了头

请求示例 示例返回结果 更新数据 更新数据请求 Content-Type 请求参数 返回结果字段说明 请求示例 示例返回结果 删除数据 ( 单条 / 多条 ) 删除

请求示例示例返回结果更新数据更新数据请求 Content-Type 请求参数返回结果字段说明请求示例示例返回结果删除数据 ( 单条 / 多条 ) 删除