图片存储api接口,高级版和专业版支持https

图片上传接口

在线测试 在线浏览

请求方式:POST

请求地址:http://{{host}}/?a=upload

Body参数名 类型 必需 描述 示例 e.g.
bucket string 云存储名称 123456
secret_key string 安全秘钥 123456
path string 非必传,默认为空上传到根目录,也可指定文件夹目录,例如:/photo/user/ /
file file 上传文件,file与file_url,二选一,同时传时自动忽略file_url
file_url string 远程下载图片地址

返回示例:

                                {
    "code": 0,
    "msg": "图片上传成功",
    "data": {
        "id": 81223124,
        "path": "http://high-cn-01.oss.tusy.xyz/get/bilnns/2019/11/7/16e4489b6a7cb754",
        "size": 39217,
        "name": "timg.jpg",
        "apiLimit": 992
    }
}
                            
参数名 描述 类型
code 状态码,0成功,其他失败 number
msg 返回信息 string
data object
data.path 图片url链接地址 string
data.size 图片大小 number
data.name 图片名称 string
data.apiLimit 小时内剩余请求次数 number
data.id 图片id number

图片文件列表

在线测试 在线浏览

请求方式:POST

请求地址:http://{{host}}/?c=file&a=file_list

Body参数名 类型 必需 描述 示例 e.g.
bucket string 存储名称 bilnns
secret_key string 秘钥 10e195614224b3f82801da44358a0d7a
page string 页码,默认为1 1
limit string 每页数据条数,默认为10,最大100 10
start_time string 搜索上传开始时间,可空 2019-11-07
end_time string 搜索上传结束时间,可空 2019-11-08
title string 搜索图片名称或者文件路径,可空 test.jpg
path string 文件目录默认空,获取全部数据,可空 /

返回示例:

                                {
    "code": 0,
    "msg": "数据获取成功",
    "count": "1",
    "data": [
        {
            "id": 81223091,
            "path_url": "http://high-cn-01.oss.tusy.xyz/get/bilnns/2019/11/7/16e43b2dc2d491ac",
            "size": 38.3,
            "name": "timg.jpg",
            "ctime": "2019-11-07 10:30:26"
        }
    ]
}
                            
参数名 描述 类型
code number
msg string
count 总数 number
data array
data.id 图片id number
data.path_url 图片外链地址 string
data.size 图片尺寸,kb number
data.name 图片名称 string
data.ctime 创建时间 string

删除图片

在线测试 在线浏览

请求方式:POST

请求地址:http://{{host}}/?c=file&a=file_del

Body参数名 类型 必需 描述 示例 e.g.
bucket string 存储名称 bilnns
secret_key string 秘钥 10e195614224b3f82801da44358a0d7a
id string 图片id 123

返回示例:

                                {
    "code": 0,
    "msg": "图片删除成功"
}
                            
参数名 描述 类型
code 状态码 number
msg 返回信息 string

图片地址换取图片id

在线测试 在线浏览

请求方式:POST

请求地址:http://{{host}}/?c=file&a=get_file_id

Body参数名 类型 必需 描述 示例 e.g.
url string 图片地址 http://free-cn-01.oss.tusy.xyz/uba/jfs/t1/47596/1/15796/39217/5dca1245E66bff86c/819a61e17cb44952.jpg

返回示例:

                                {
    "code": 0,
    "msg": "数据获取成功",
    "data": {
        "id": 81223088
    }
}
                            
参数名 描述 类型
code number
msg string
data object
data.id 图片id number

内容存储api接口

文件上传接口,小于等于100MB

在线测试 在线浏览

请求方式:POST

请求地址:http://{{host}}/?a=upload

Body参数名 类型 必需 描述 示例 e.g.
bucket string 存储名称 test123
secret_key string api秘钥,管理后台存储详情中获得 622370808df188a4d60be3e07e03a8d6
path string 上传路径默认/,可指定任意目录例如/images/pic/,目录不存在则自动创建 /
file file 上传文件,任意文件类型,但必须包含扩展名,如果文件已存在需先删除

返回示例:

                                {
    "code": 0,
    "msg": "文件上传成功",
    "data": {
        "id": 81223153,
        "path": "http://free-cn-01.host.bilnn.com/get/test123/c-img0.png",
        "size": 21212,
        "name": "c-img0.png",
        "apiLimit": 96,
        "storage_nouse": 511.08
    }
}
                            
参数名 描述 类型
code number
msg string
data object
data.id 文件id number
data.path 文件访问url,html和txt且小于1M可直接访问,其他下载 string
data.size 文件大小,字节 number
data.name 文件名称 string
data.apiLimit 小时内api调用剩余次数 number
data.storage_nouse 存储剩余空间,MB number

大文件分块上传接口,大于100MB

在线测试 在线浏览

请求方式:POST

请求地址:http://{{host}}/?a=upload_large

Body参数名 类型 必需 描述 示例 e.g.
bucket string 存储名称 test123
secret_key string api秘钥,管理后台存储详情中获得 10e195614224b3f82801da44358a0d7a
path string 上传路径默认/,可指定任意目录例如/images/pic/,目录不存在则自动创建 /
file string 上传文件,任意文件类型,但必须包含扩展名,如果文件已存在需先删除
file_name string 上传文件名例如:1.jpg a.mp4
total_blob_num string 分块总数,例如40MB大小文件,每块4MB大小,分块总数就是10,单块最大4MB可小于该值 100
blob_num string 当前上传块,默认1,没上传完一次该值加一,但不能大于总块数 1

详细说明:

注意:

临时块文件只保留一个小时,一小时内可断点续传


当code==0时即为上传完毕,会出现data数据反馈

当code==1时即为当前文件块已上传完毕,需要继续上传下个文件块

{

  "code": 1,

  "msg": "请继续上传文件"

}

返回示例:

                                {
    "code": 0,
    "msg": "文件上传成功",
    "data": {
        "id": 81223153,
        "path": "http://free-cn-01.host.bilnn.com/get/test123/c-img0.png",
        "size": 21212,
        "name": "c-img0.png",
        "apiLimit": 96,
        "storage_nouse": 511.08
    }
}
                            
参数名 描述 类型
code number
msg string
data object
data.id 文件id number
data.path 文件访问url,html和txt且小于1M可直接访问,其他下载 string
data.size 文件大小,字节 number
data.name 文件名称 string
data.apiLimit 小时内api调用剩余次数 number
data.storage_nouse 存储剩余空间,MB number

新建文件夹

在线测试 在线浏览

请求方式:POST

请求地址:http://{{host}}/?a=mkdir

Body参数名 类型 必需 描述 示例 e.g.
bucket string 存储名称 test123
secret_key string api秘钥,管理后台存储详情中获得 622370808df188a4d60be3e07e03a8d6
path string 文件夹路径默认/,可指定任意目录例如/images/pic/,文件夹只能使用中英文 _ - /test

返回示例:

                                {
    "code": 0,
    "msg": "文件夹创建成功",
    "data": {
        "path": "test123/test/",
        "apiLimit": 95
    }
}
                            
参数名 描述 类型
code number
msg string
data object
data.path 文件夹路径 string
data.apiLimit 小时内api调用剩余次数 number

删除文件或文件夹

在线测试 在线浏览

请求方式:POST

请求地址:http://{{host}}/?c=file&a=file_del

Body参数名 类型 必需 描述 示例 e.g.
bucket string 存储名称 test123
secret_key string api秘钥,管理后台存储详情中获得 622370808df188a4d60be3e07e03a8d6
id string 文件或文件夹id 81223154

返回示例:

                                {
    "code": 0,
    "msg": "文件删除成功"
}
                            
参数名 描述 类型
code number
msg string

获取文件列表

在线测试 在线浏览

请求方式:POST

请求地址:http://{{host}}/?c=file&a=file_list

Body参数名 类型 必需 描述 示例 e.g.
bucket string 存储名称 test123
secret_key string api秘钥,管理后台存储详情中获得 622370808df188a4d60be3e07e03a8d6
limit string 每页返回的最大条数,默认10 100
path string 文件路径默认/根目录,可指定文件夹例如/images/ /
page string 页码,默认为1 1
start_time string 可为空,搜索创建开始时间2020-2-18 10:55:13
end_time string 可为空,搜索创建结束时间2020-2-18 11:55:13
title string 可为空,搜索文件名称

返回示例:

                                {
    "code": 0,
    "msg": "数据获取成功",
    "count": "6",
    "data": [
        {
            "id": 81223154,
            "path_url": "http://free-cn-01.host.bilnn.com/get/test123/",
            "size": 0,
            "name": "test",
            "folder": "1",
            "ctime": "2020-02-17 15:58:43"
        },
        {
            "id": 81223150,
            "path_url": "http://free-cn-01.host.bilnn.com/get/test123/",
            "size": 0,
            "name": "345",
            "folder": "1",
            "ctime": "2020-02-16 13:47:15"
        },
        {
            "id": 81223153,
            "path_url": "http://free-cn-01.host.bilnn.com/get/test123/c-img0.png",
            "size": 20.71,
            "name": "c-img0.png",
            "folder": "0",
            "ctime": "2020-02-17 15:53:50"
        },
        {
            "id": 81223152,
            "path_url": "http://free-cn-01.host.bilnn.com/get/test123/b-r.png",
            "size": 3.89,
            "name": "b-r.png",
            "folder": "0",
            "ctime": "2020-02-17 15:52:20"
        },
        {
            "id": 81223151,
            "path_url": "http://free-cn-01.host.bilnn.com/get/test123/bg.png",
            "size": 42.87,
            "name": "bg.png",
            "folder": "0",
            "ctime": "2020-02-17 14:24:39"
        },
        {
            "id": 81223144,
            "path_url": "http://free-cn-01.host.bilnn.com/get/test123/使用帮助.txt",
            "size": 0.41,
            "name": "使用帮助.txt",
            "folder": "0",
            "ctime": "2020-02-16 12:35:00"
        }
    ],
    "storage_nouse": 511.08,
    "storage_total": 512
}
                            
参数名 描述 类型
code number
msg string
count number
data array
data.id 文件或文件夹id number
data.path_url 访问url string
data.size 文件大小KB number
data.name 文件或文件夹名称 string
data.folder 0是文件,1是文件夹 number
data.ctime 创建时间 string
storage_nouse 剩余空间MB number
storage_total 空间总大小MB number

获取文件详情

在线测试 在线浏览

请求方式:POST

请求地址:http://{{host}}/?c=file&a=file_view

Body参数名 类型 必需 描述 示例 e.g.
bucket string 存储名称 test123
secret_key string api秘钥,管理后台存储详情中获得 622370808df188a4d60be3e07e03a8d6
id string 文件或文件夹id 81223153

返回示例:

                                {
    "code": 0,
    "msg": "数据获取成功",
    "data": {
        "id": 81223153,
        "path_url": "http://free-cn-01.host.bilnn.com/get/test123/c-img0.png",
        "size": 20.71,
        "name": "c-img0.png",
        "ctime": "2020-02-17 15:53:50",
        "password": null,
        "share_url": "http://free-cn-01.host.bilnn.com/?c=file&a=share&code=eCAkGikIdEp_ZS5f"
    }
}
                            
参数名 描述 类型
code number
msg string
data object
data.id 文件id number
data.path_url 访问url string
data.size 文件大小kb number
data.name 文件名称 string
data.ctime 创建时间 string
data.password 分享密码(只对分享链接有效),如果不设置打开分享链接即可下载,如果设置必须输入分享密码才可以下载 string
data.share_url 分享链接,考虑到用户可能需要将指定文件发送出去而不暴露url链接,这里返回了一个加密后的分享链接,访问分享链接可下载文件 string

设置访问密码

在线测试 在线浏览

请求方式:POST

请求地址:http://{{host}}/?c=file&a=set_password

Body参数名 类型 必需 描述 示例 e.g.
bucket string 存储名称 test123
secret_key string api秘钥,管理后台存储详情中获得 622370808df188a4d60be3e07e03a8d6
id string 文件id 81223153
password string 访问密码,取消密码改值传空 123456

返回示例:

                                {
    "code": 0,
    "msg": "密码设置成功"
}
                            

文件地址换取文件id

在线测试 在线浏览

请求方式:POST

请求地址:http://{{host}}/?c=file&a=get_file_id

Body参数名 类型 必需 描述 示例 e.g.
url string url链接地址 http://free-cn-01.host.bilnn.com/get/test123/c-img0.png

返回示例:

                                {
    "code": 0,
    "msg": "数据获取成功",
    "data": {
        "id": 81223153
    }
}
                            
参数名 描述 类型
code number
msg string
data object
data.id 文件或文件夹id number

获取文件缩略图

在线测试 在线浏览

请求方式:GET

请求地址:http://文件url?style=large

详细说明:

例如:

文件地址为:https://high-cn-01.host.bilnn.com/get/high01/video.mp4

获取缩略图地址为:https://high-cn-01.host.bilnn.com/get/high01/video.mp4?style=large

图片是这个下载地址,不影响在web中使用

附录

环境变量

免费-国内-01
变量名 变量值
host free-cn-01.oss.bilnn.com
免费-国外-01
变量名 变量值
host free-en-01.oss.bilnn.com
高级-国内-01
变量名 变量值
host high-cn-01.oss.bilnn.com
高级-国外-01
变量名 变量值
host high-en-01.oss.bilnn.com
专业-国内-01
变量名 变量值
host pro-cn-01.oss.bilnn.com
专业-国外-01
变量名 变量值
host pro-en-01.oss.bilnn.com
免费-内容存储-01
变量名 变量值
host free-cn-01.host.bilnn.com
高级-内容存储-01
变量名 变量值
host high-cn-01.host.bilnn.com
专业-内容存储-01
变量名 变量值
host pro-cn-01.host.bilnn.com

状态码

状态码 描述
code=0 成功
code<>0 错误,具体错误信息,查看msg错误信息
HTTP request failed! HTTP/1.1 404 Not Found 文件未找到
HTTP request failed! HTTP/1.1 Connection exceeded 并发限制
HTTP request failed! HTTP/1.1 Incorrect status 存储状态错误
HTTP request failed! HTTP/1.1 Storage expiration 存储已到期
HTTP request failed! HTTP/1.1 403 Forbidden 目录禁止浏览
在线编辑
Top