接口参数 若无特殊说明,接口参数同时支持GET和POST传递;推荐:查询/删除用GET,创建/更新用POST。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
object | 字符串 | 必须 | 设置文件名称 | ||
content | 字符串 | 必须 | 待上传的文件内容 |
在线测试
参数 | 是否必填 | 值 |
---|---|---|
s | 固定 | |
uuid | 可选 | |
token | 可选 | |
return_data | 可选 | |
object | 必须 | |
content | 必须 |
客户端请求示例
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
请求:
{你的接口域名}/?s=App.OSS_Aliyun.PutObject&object=test.hmtl&content=haha&app_key={你的app_key}&sign={动态签名}
返回(重点关注info.url即可,对应上传成功后的地址):
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"server": "AliyunOSS",
"date": "Tue, 02 Jun 2020 14:11:24 GMT",
"content-length": "0",
"connection": "keep-alive",
"x-oss-request-id": "5ED65E0C5369E8383519E6CD",
"etag": "\"4E4D6C332B6FE62A63AFE56171FD3725\"",
"x-oss-hash-crc64ecma": "12320981391698477175",
"content-md5": "Tk1sMytv5ipjr+Vhcf03JQ==",
"x-oss-server-time": "44",
"info": {
"url": "http://yesapi2.oss-cn-beijing.aliyuncs.com/test.hmtl",
"content_type": null,
"http_code": 200,
"header_size": 310,
"request_size": 434,
"filetime": -1,
"ssl_verify_result": 0,
"redirect_count": 0,
"total_time": 0.119515,
"namelookup_time": 0.004217,
"connect_time": 0.03995,
"pretransfer_time": 0.040002,
"size_upload": 4,
"size_download": 0,
"speed_download": 0,
"speed_upload": 33,
"download_content_length": 0,
"upload_content_length": 4,
"starttransfer_time": 0.119451,
"redirect_time": 0,
"redirect_url": "",
"primary_ip": "59.110.190.24",
"certinfo": [],
"primary_port": 80,
"local_ip": "172.18.36.145",
"local_port": 59338,
"method": "PUT"
},
"oss-request-url": "http://yesapi2.oss-cn-beijing.aliyuncs.com/test.hmtl", // 重点关注info.url即可,对应上传成功后的地址
"oss-redirects": 0,
"oss-stringtosign": "PUT\nTk1sMytv5ipjr+Vhcf03JQ==\napplication/octet-stream\nTue, 02 Jun 2020 14:11:24 GMT\n/yesapi2/test.hmtl",
"oss-requestheaders": {
"Accept-Encoding": "",
"Content-Length": "4",
"Content-Md5": "Tk1sMytv5ipjr+Vhcf03JQ==",
"Content-Type": "application/octet-stream",
"Date": "Tue, 02 Jun 2020 14:11:24 GMT",
"Host": "yesapi2.oss-cn-beijing.aliyuncs.com",
"Authorization": "OSS LTAIswNj9Bevh5gI:FjykiUsNTke+0/TVbYiEUE9Tw54="
},
"body": ""
},
"msg": "V2.1.1 YesApi App.OSS_Aliyun.PutObject"
}
接口返回及数据结构
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.info.url | 字符串 | 成功上传后返回的OSS链接 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
ret异常错误码
错误码 | 错误类型 | 错误描述信息 | 解决方法 |
---|---|---|---|
ret = 200 | 成功 | 请求成功 | |
ret = 400 | 客户端非法请求 | 表示客户端参数错误 | 1、根据接口文档的接口参数,提供正确的参数 |
ret = 404 | 客户端非法请求 | 表示接口服务不存在 | 1、查看小白接口大全,确保接口服务名称拼写正确 |
ret = 500 | 小白接口异常 | 表示服务端内部错误 | 1、进入QQ交流群897815708,反馈问题;2、或者提交工单,一天内回复 |
常见问题FAQ
Q1 问:出现 414 Request-URI Too Large 时怎么解决?答:对于全部参数,改用POST方式传递,并且从GET链接里面去掉。
Q2 问:浏览器请求和在线测试接口正常,但本地程序无法正常获取接口结果。答:需要注意UTF编码,以及存在中文和特殊字符时的URL编码。GET请求参数应统一进行URL编码后再请求,POST表单数据正常传递即可。
Q3 问:请求接口时提示JSON格式错误。答:请先阅读,然后检测本地传递的参数是否符合JSON格式,使用JSON在线工具辅助检测,注意双引号和特殊符号。确认无误后再重新请求API接口。
Q4 问:出现 405 不允许跨域请求 时怎么办?答:可以追加GET参数 &yesapi_allow_origin=1
,或参考用反向代理解决跨域问题等3种解决方案。
Q4 问:在wx内无法访问yesapi.cn或okayapi.com域名,怎么办?答:由于曾经短链跳转使用被wx误封域名,可以帮忙进行申诉。申诉后截图联系我们,获取15万次接口流量奖励。