基础

基本参数

request_url

请求地址

环境httphttps
测试http://test-rest-api.easyyun.com/v1/router/resthttps://test-rest-api.easyyun.com/v1/router/rest
正式http://rest-api.easyyun.com/v1/router/resthttps://rest-api.easyyun.com/v1/router/rest

app_key

app key代表应用的key,测试环境和正式环境的app key不一样,权限也不一样,测试环境会请求频率、文件大小等限制。申请app key请邮件

token

应用请求需要设置token,每个app key只有1个有效token,token默认有效期为24小时(86400秒);请妥善保管token。实例中提供的app_key无法更新token,请使用自己的 app key

设置token方式

curl -X POST 'http://test-rest-api.easyyun.com/v1/router/rest' \
-d 'method=config.token' \
-d 'app_key=xxx'

其他说明

为兼容不同开发语言问题,请求和响应参数字段默认为字符串,不同开发语言处理字段的时候请自行加引号或自身开发语言处理,比如"1","true"等

系统配置config

storage 存储

配置自己storage的好处 提供的url你无需下载,直接存储到你的服务器资源上。目前支持阿里云OSS。

  • storage_type 可选值阿里云:aliyun.oss、腾讯云:tencent.cos
  • storage_config值实例为{"bucket":"xxx","host":"http://xxx.xxx.com","endpoint":"xxxx.aliyuncs.com","access_key_id":"xxx","access_key_secret":"xxx"}
curl -X POST 'http://test-rest-api.easyyun.com/v1/router/rest' \
-d 'method=config.storage' \
-d 'token=xxx' \
-d 'storage_type=aliyun.oss' \
-d 'storage_config={"bucket":"xxx","host":"http://xxx.xxx.com","endpoint":"xxxx.aliyuncs.com","access_key_id":"xxx","access_key_secret":"xxx"}'

notify_url 回调地址

当使用异步通知的时候设计的回调地址,比如你有大量的任务,不想等待任务结果,使用异步方式,程序会立即返回1个request_id。主动查询异步结果

curl -X POST 'http://test-rest-api.easyyun.com/v1/router/rest' \
-d 'method=config.notify_url' \
-d 'token=xxx' \
-d 'notify_url=xxx' \
-d 'notify_token=xxx'

如果你的服务器有白名单限制,你可以通过request_id主动查询任务结果。

应用options字段

pages格式

支持格式实例说明
单个数字1
,间隔1,2,4
n-m2-4从n到m
eveneven单数
oddodd复数