获取上传地址

接口描述：

  • 获取上传地址不会返回上传所需要的各个参数值，只是返回上传地址和上传时所需要的数据结构。

请求 URL：

  • http|https://host/api/v1/upload/method/get.upload.url/

请求方式：

  • GET
  • POST

是否授权：

  • 需要授权

业务参数：

参数名 类型 是否必须 范围值 默认值 示例值 描述
module string 否 见附属 A aliyun 模块名

附属 A： 参数module的值可从「获取上传模块列表」中获取，当参数值为空或不传入则默认取系统设置中配置的默认上传模块。

响应参数：

参数名 类型 是否返回 示例值 描述
status integer 是 200 状态码
message string 是 success 消息信息
data object 是 [] 返回对象
data 类型 是否返回 示例值 描述
upload_url string 是 http://… 默认上传地址
module string 是 careyshop 模块名
param array 是 [] 上传时需要用到的参数
param 类型 是否返回 示例值 描述
name string 是 x:parent_id 参数名
type string 是 hidden 参数类型(属性)
default string 是 0 参数默认值

CareyShop(本地上传) 响应示例：

  1. {
  2.   "status": 200,
  3.   "message": "success",
  4.   "data": {
  5.     "upload_url": "http://host/api/v1/upload/method/add.upload.list.html",
  6.     "module": "careyshop",
  7.     "param": [
  8.       {
  9.         "name": "x:replace",
  10.         "type": "hidden",
  11.         "default": ""
  12.       },
  13.       {
  14.         "name": "x:parent_id",
  15.         "type": "hidden",
  16.         "default": 0
  17.       },
  18.       {
  19.         "name": "x:filename",
  20.         "type": "hidden",
  21.         "default": ""
  22.       },
  23.       {
  24.         "name": "token",
  25.         "type": "hidden",
  26.         "default": ""
  27.       },
  28.       {
  29.         "name": "file",
  30.         "type": "file",
  31.         "default": ""
  32.       }
  33.     ]
  34.   }
  35. }

七牛云 KODO 响应示例：

  1. {
  2.   "status": 200,
  3.   "message": "success",
  4.   "data": {
  5.     "upload_url": "http://upload-jjh.qiniup.com/",
  6.     "module": "qiniu",
  7.     "param": [
  8.       {
  9.         "name": "x:replace",
  10.         "type": "hidden",
  11.         "default": ""
  12.       },
  13.       {
  14.         "name": "x:parent_id",
  15.         "type": "hidden",
  16.         "default": 0
  17.       },
  18.       {
  19.         "name": "x:filename",
  20.         "type": "hidden",
  21.         "default": ""
  22.       },
  23.       {
  24.         "name": "key",
  25.         "type": "hidden",
  26.         "default": ""
  27.       },
  28.       {
  29.         "name": "token",
  30.         "type": "hidden",
  31.         "default": ""
  32.       },
  33.       {
  34.         "name": "file",
  35.         "type": "file",
  36.         "default": ""
  37.       }
  38.     ]
  39.   }
  40. }

阿里云 OSS 响应示例：

  1. {
  2.   "status": 200,
  3.   "message": "success",
  4.   "data": {
  5.     "upload_url": "http://careyshop.oss-cn-hangzhou.aliyuncs.com/",
  6.     "module": "aliyun",
  7.     "param": [
  8.       {
  9.         "name": "x:replace",
  10.         "type": "hidden",
  11.         "default": ""
  12.       },
  13.       {
  14.         "name": "x:parent_id",
  15.         "type": "hidden",
  16.         "default": 0
  17.       },
  18.       {
  19.         "name": "x:filename",
  20.         "type": "hidden",
  21.         "default": ""
  22.       },
  23.       {
  24.         "name": "OSSAccessKeyId",
  25.         "type": "hidden",
  26.         "default": ""
  27.       },
  28.       {
  29.         "name": "policy",
  30.         "type": "hidden",
  31.         "default": ""
  32.       },
  33.       {
  34.         "name": "Signature",
  35.         "type": "hidden",
  36.         "default": ""
  37.       },
  38.       {
  39.         "name": "callback",
  40.         "type": "hidden",
  41.         "default": ""
  42.       },
  43.       {
  44.         "name": "key",
  45.         "type": "hidden",
  46.         "default": ""
  47.       },
  48.       {
  49.         "name": "success_action_status",
  50.         "type": "hidden",
  51.         "default": 200
  52.       },
  53.       {
  54.         "name": "file",
  55.         "type": "file",
  56.         "default": ""
  57.       }
  58.     ]
  59.   }
  60. }

备注:

  1. 不同的上传地址需要用到的请求参数也不同，系统会返回需要用到的请求参数，并且会存在默认值，在没有特殊情况下一般使用默认值即可。

  2. 众多参数中需要注意x:*类型的参数，该参数属于系统自义定参数，参数值被系统所处理，其余参数是 OOS 运营商所需要使用的，在「获取上传Token」可获得，只要原样填写即可。

    • x:replace替换上传资源时使用，新上传时无需理会。(默认值为空字符)
    • x:parent_id表示该资源所属资源编号，就是说这个文件归哪个文件夹所有。(默认值为0，根目录下)
    • x:filename上传后的自定义文件名，默认为空字符，表示使用原始文件名。(默认值为空字符)

  3. 上传需要提早渲染好(获取Token之后)模板，参数和参数值准备完毕后再提交上传请求。