Eyeblue Cloud Disk API
Entity
Before introducing the interfaces in each controller in detail, it is necessary to introduce the entities in the Eyeblue Cloud Disk. All entity Base classes are Base
Base
Base
is defined as follows. All entities that will be persisted in the database will inherit Base
. When 'Controller' returns entities to the front end, it will serialize fields and values into json strings, where the key is consistent with the json
tag after each entity field
type Base struct {
Uuid string `gorm:"primary_key" json:"uuid"` //A unique identifier
Sort int64 `json:"sort"` //A field, usually a timestamp, used for sorting
UpdateTime time.Time `json:"updateTime"` //UpdateTime
CreateTime time.Time `json:"createTime"` //CreateTime
}
2
3
4
5
6
7
8
Pager
When the front end requests a list, it usually returns a Pager
, Pager
is the list of various entities installed
type Pager struct {
Page int `json:"page"` //Current page, 0 base
PageSize int `json:"pageSize"` //The size of each page
TotalItems int `json:"totalItems"` //Total number of entries
TotalPages int `json:"totalPages"` //The total number of pages
Data interface{} `json:"data"` //Array of entities
}
2
3
4
5
6
7
8
9
Matter
Matter
represents a file (a folder is a special file). In order to avoid duplication of file
with the system, Matter
is used here. This entity is the most important and basic entity of blue-eye cloud disk
type Matter struct {
Base //Inheritance Base, that is the Base of Uuid, Sort, ModifyTime, CreateTime here also
Puuid string `json:"puuid"` //The uuid of the folder in which it is located, if in the root directory, this field is root
UserUuid string `json:"userUuid"` //The user uuid that created this file
Username string `json:"username"` //The user name to create this file
Dir bool `json:"dir"` //Whether the file is a folder
Name string `json:"name"` //File name with suffix. For example:avatar.jpg
Md5 string `json:"md5"` //Md5 value of the file, which is not currently implemented, as a reserved field
Size int64 `json:"size"` //File size, unit byte. For example, if a file is 1M in size, then this will be: 1048576
Privacy bool `json:"privacy"` //If true, the file can only be downloaded by the author or super administrator. If false, everyone can download the file through the download link
Path string `json:"path"` //The path of the file on disk. The front end does not need to care about this field. But this field is critical when the backend is looking for files
Times int64 `json:"times"` //Download times
Parent *Matter `gorm:"-" json:"parent"` //The parent of the file, matter, will not be persisted to the data set. This field is a temporary assembly of matter details
Children *Matter `gorm:"-" json:"-"` //The file's sublevel matter array, which will not be persisted to the data set, is a temporary assembly of matter details
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
User
User
represents the User
type User struct {
Base //Inherit Base, same as above
Role string `json:"role"` //Roles, with the following enumerated values:GUEST(It is not persisted to the database),USER,ADMINISTRATOR
Username string `json:"username"` //Username, useful in the Matter path field
Password string `json:"-"` //Passwords are not returned to the front end by default
AvatarUrl string `json:"avatarUrl"` //Image Url
LastIp string `json:"lastIp"` //IP at last login
LastTime time.Time `json:"lastTime"` //Last login time
SizeLimit int64 `json:"sizeLimit"` //This user allows the maximum size of a single file to be uploaded
TotalSizeLimit int64`json:"totalSizeLimit"` //The maximum size of files that this user allows to upload
TotalSize int64 `json:"totalSize"` //Total size of files uploaded by this user
Status string `json:"status"` //State with the following enumerated values:OK,DISABLED
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
Preference
Preference
is the Preference setting of the whole website. This entity is responsible for the name, logo, favicon, copyright, record number and other information of the website.
type Preference struct {
Base //inherit Base, function is the same as above
Name string `json:"name"` //website name
LogoUrl string `json:"logoUrl"` //url of the website logo
Copyright string `json:"copyright"` //copyright information
Record string `json:"record"`
AllowRegister bool `json:"allowRegister"` //whether automatic registration is allowed
Version string `json:"version"` //currently running version of the blue eye blog, this field is not modifiable and hardcoded every time it is published
DownloadDirMaxSize int64 `json:"downloadDirMaxSize"` //size limit
DownloadDirMaxNum int64 `json:"downloadDirMaxNum"` //number of files
DefaultTotalSizeLimit int64 `json:"defaultTotalSizeLimit"` //user default total size limit
}
2
3
4
5
6
7
8
9
10
11
12
13
14
UploadToken
Token for uploading to strangers
type UploadToken struct {
Base // inherit Base, function is the same as above
UserUuid string `json:"userUuid"` // the user who issues the token, any user in the system can issue the token
FolderUuid string `json:"folderUuid"` // to upload a file with this token, you must upload it under this folder
MatterUuid string `json:"matterUuid"` // the stranger uploads the uuid of the finished file
ExpireTime time.Time `json:"expireTime"` // expiration time
Filename string `json:"filename"` // this must be the name of the file you upload with this token
Privacy bool `json:"privacy"` // upload files with this token must be private or private
Size int64 `json:"size"` // this size is required to upload a file with this token
Ip string `json:"ip"` // use this token to upload the IP of the stranger
}
2
3
4
5
6
7
8
9
10
11
12
13
DownloadToken
A token used for downloading to strangers. If Privacy=true, it means that only you or the super administrator can download it. If certain users who you trust can also download it, then a DownloadToken
needs to be generated for these users to download
type DownloadToken struct {
Base // inherit Base, function is the same as above
UserUuid string `json:"userUuid"` // the user who issues this token
MatterUuid string `json:"matterUuid"` // this token can only be used to download this file
ExpireTime time.Time `json:"expireTime"` // expiration date
Ip string `json:"ip"` // the IP of the downloader
}
2
3
4
5
6
7
8
9
10
Dashboard
Eyeblue Cloud Disk control panel, showing cloud disk statistics: PV/UV, 'active' files, active IP
type Dashboard struct {
Base // inherit Base, function is the same as above
InvokeNum int64 `json:"invokeNum"` // link relative ratio,The ratio of change in quantity over two consecutive unit periods, such as two consecutive weeks
TotalInvokeNum int64 `json:"totalInvokeNum"` // total link relative ratio
Uv int64 `json:"uv"` // the UV
TotalUv int64 `json:"totalUv"` // total UV
MatterNum int64 `json:"matterNum"` // total number of documents on that day
TotalMatterNum int64 `json:"totalMatterNum"` // total number of documents
FileSize int64 `json:"fileSize"` // total file size of the day
TotalFileSize int64 `json:"totalFileSize"` // total file size
AvgCost int64 `json:"avgCost"` // the average time taken reflects the overall response speed of the server
Dt string `json:"dt"` // date
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
Share
File sharing record
type Share struct {
Base // inherit Base, function is the same as above
Name string `json:"name"` // share the name of the record
ShareType string `json:"shareType"` // Shared type, file/folder/mixed type
Username string `json:"username"` // users who share the record
UserUuid string `json:"userUuid"` // share the user id of the record
DownloadTimes int64 `json:"downloadTimes"` // download times
Code string `json:"code"` // extraction code
ExpireInfinity bool `json:"expireInfinity"`// whether it expires or not
ExpireTime time.Time `json:"expireTime"` // expiration time
DirMatter *Matter `json:"dirMatter"` // folder file
Matters []*Matter `json:"matters"` // file collection
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
WebResult
WebResult
is not an entity that will be persisted to the database. WebResult
is a layer of packaging when controller
returns data to the front end. With WebResult
, the data returned by each interface will be more uniform, facilitating the unified processing of the front end
type WebResult struct {
Code int `json:"code"` //Status code, the specific meaning of each code reference below
Msg string `json:"msg"` //A one-sentence description of the result of the request will usually indicate the cause of the error, or modify permissions and other small operations prompted by `operation success`
Data interface{} `json:"data"` //The content may be an entity, or it may be a Pager.
}
2
3
4
5
6
7
8
The corresponding relationship of the status code is as follows:
const (
RESULT_CODE_OK = 200 //Normal
RESULT_CODE_LOGIN = -400 //Not logged in
RESULT_CODE_UNAUTHORIZED = -401 //No permission
RESULT_CODE_BAD_REQUEST = -402 //Request error
RESULT_CODE_NOT_FOUND = -404 //Could not find
RESULT_CODE_LOGIN_EXPIRED = -405 //Login date
RESULT_CODE_LOGIN_INVALID = -406 //This login user is not a valid user
RESULT_CODE_FORM_INVALID = -410 //The submitted form was not validated
RESULT_CODE_FREQUENCY = -420 //Too many requests
RESULT_CODE_SERVER_ERROR = -500 //Server error
RESULT_CODE_NOT_AVAILABLE = -501 //Remote service unavailable
RESULT_CODE_CONCURRENCY = -511 //Concurrent abnormal
RESULT_CODE_SERVICE_NOT_FOUND = -600 //The remote micro service was not found
RESULT_CODE_SERVICE_TIME_OUT = -610 //Remote micro service connection timeout
RESULT_CODE_UTIL_EXCEPTION = -700 //Universal exception
)
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
Return specification
Eyeblue Cloud Disk adopts the mode of front and back end separation. When the front end calls the back end interface, urls start with /API
and return json strings
The key of the returned json string is the lowercase Camel-Case, specifically referring to the
json
tag in the entity classThe time format returned is
yyyy-mm-dd HH: MM :ss
(for example: 2018-01-06 17:57:00).
The returned contents are all packaged by WebResult
, so they have a high degree of uniformity. Here we agree on some statements, which will not be repeated when Controller
is introduced later
Returns an
XX
entityRefers to
Code=200
ofWebResult
,Data= an XX entity object'
For example: if a
User
is returned, the front end will receive the following json string:{ "code": 200, "msg": "", "data": { "uuid": "eed2c66d-1de6-47ff-645e-b67beaa10365", "sort": 1514803034507, "modifyTime": "2018-01-06 18:00:58", "createTime": "2018-01-01 18:37:15", "role": "USER", "username": "demo", "avatarUrl": "/api/alien/download/ea490cb6-368e-436d-71c0-fcfb08854c80/1180472.png", "lastIp": "124.78.220.82", "lastTime": "2018-01-06 18:00:58", "sizeLimit": 1048576, "totalSizeLimit": 104857600, "totalSize": 10485760, "status": "OK" } }
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19Returns
XX
ofPager
Refers to the
Code=200
ofWebResult
,Data= Pager
of XXFor example:
User
returnsPager
, and the front end receives the following json string:{ "code": 200, "msg": "", "data": { "page": 0, "pageSize": 10, "totalItems": 2, "totalPages": 1, "data": [ { "uuid": "6a661938-8289-4957-4096-5a1b584bf371", "sort": 1515057859613, "modifyTime": "2018-01-04 17:26:01", "createTime": "2018-01-04 17:24:20", "role": "ADMINISTRATOR", "username": "simba", "avatarUrl": "/api/alien/download/d1e453cb-3170-4bdb-73f2-fa0372ee017b/1180480.png", "lastIp": "180.173.103.207", "lastTime": "2018-01-04 17:26:01", "sizeLimit": -1, "totalSizeLimit": 104857600, "totalSize": 10485760, "status": "OK" }, { "uuid": "e59be6a3-f806-463e-553a-4c5892eedf78", "sort": 1514881002975, "modifyTime": "2018-01-02 16:16:43", "createTime": "2018-01-02 16:16:43", "role": "USER", "username": "blog_dev", "avatarUrl": "/api/alien/download/fdca6eee-d009-4eb3-5ad4-15ba3701cb2e/jump.jpg", "lastIp": "", "lastTime": "2018-01-02 16:16:43", "sizeLimit": 1048576, "totalSizeLimit": 104857600, "totalSize": 10485760, "status": "OK" } ] } }
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42Error message: yyy
Refers to
Code=-400
ofWebResult
,Msg=yyy
(the specific values of Code here refer to the Code table above)For example: return error message: "new folder already exists, please use another name." , the front end will receive the following json string:
{ "code": -700, "msg": "new folder already exists, please use another name.", "data": null }
1
2
3
4
5Success message: zzz
Refers to
Code=200
ofWebResult
,Msg= ZZZ
(refer to the Code table above for specific values here)For example: return success message: "deleted successfully." , the front end will receive the following json string:
{ "code": 200, "msg": "deleted successfully", "data": null }
1
2
3
4
5
Interface
All interfaces of Eyeblue Cloud Disk are defined in controller
, and the following controller
is defined in total:
name | code file | description |
---|---|---|
PreferenceController | preference_controller.go | Website title, logo, copyright description and other information added, deleted and checked |
MatterController | matter_controller.go | Create folders, upload files, delete files, modify permissions, etc |
UserController | user_controller.go | Log in and manage users in the operation station |
AlienController | alien_controller.go | Third party authorized upload, download, preprocessing |
DashboardController | dashboard_controller.go | Cloud disk control panel, view the overall data, PU/PV access |
ShareController | share_controller.go | Share, operate, get and download Shared files/folders |
Each interface has different access levels. Three access levels are defined in the system, which are:
tourist
< user
< administrator
PreferenceController
This Controller is responsible for preferences in the website, and it mainly operates on Preference
entities
/api/preference/fetch
function : read website preferences, website name, logo, copyright, record information, zip download size limit, zip download number limit, user default total size limit, whether to allow automatic registration is read from this interface
access level : tourist
,user
, administrator
request parameter : none
returns: an Preference
entity
/api/preference/edit
function : edit website preferences, modify website name, logo, copyright, record information, zip download size limit, zip download number limit, user default total size limit, whether to allow independent registration
access level : administrator
request parameters:
Name | type | required | description |
---|---|---|---|
name | string | required | site name |
logoUrl | string | optional | website logoUrl, if not, use Eyeblue Cloud Disk logo by default |
faviconUrl | string | optional | Website faviconUrl, if not filled in default USES Eyeblue Cloud Disk favicon.ico |
copyright | string | optional | Website copyright |
record | string | optional | Website record |
downloadDirMaxSizeStr | int | optional | Zip download size limit |
downloadDirMaxNumStr | int | optional | Limited number of zip downloads |
defaultTotalSizeLimitStr | int | optional | User default total size limit |
allowRegisterStr | bool | optional | Whether automatic registration is allowed or not |
returns: an Preference
entity
/api/preference/system/cleanup
function : reset the system, operate carefully
access level : administrator
request parameters
Name | type | required | description |
---|---|---|---|
password | string | required | administrator user password is required |
return: success message "reset successful"
MatterController
This Controller is responsible for creating folders, uploading files, modifying file paths, deleting files, modifying file access permissions, etc., mainly operating Matter
entities
/api/matter/create/directory
function : create folders
access level : registered user
, administrator
request parameters:
Name | type | required | description |
---|---|---|---|
userUuid | string | required | Unique identifier of the user, the file is stored under that user name |
puuid | string | required | The directory in which the directory is to be created, if created in the root directory, pass root |
name | string | required | Folder name, cannot contain the following special symbol: < > \| * ? / \ |
return: the Matter
entity of the newly created folder
/api/matter/upload
function : upload files
The level of access:user
, administrator
Request parameters:
Name | type | required | description |
---|---|---|---|
userUuid | string | required | Unique identifier of the user, the file is stored under that user name |
puuid | string | optional | Which directory to upload the file to |
file | file | required | Binary file, in the browser is selected by <input type="file" name="file"/> |
alien | bool | optional | Whether it is a third-party file, the default is false |
privacy | bool | optional | Private file, default true |
return: just uploaded the Matter
entity of this file
/api/matter/crawl(command line tool)
function:Get the file through the url
The level of access:registered user
, administrator
Request parameters:
Name | type | required | description |
---|---|---|---|
url | string | optional | File url path |
destPath | string | optional | path of objective |
filename | string | required | file name |
return: just uploaded the Matter
entity of this file
/api/matter/delete
function:Delete files or folders
The level of access:user
, administrator
Request parameters:
Name | type | required | description |
---|---|---|---|
uuid | string | required | Uuid of the file or folder to delete |
return: Successful information "deletion successful"
/api/matter/delete/batch
function:Batch delete files or folders
The level of access:user
, administrator
Request parameters:
Name | type | required | description |
---|---|---|---|
uuids | string | required | Uuids for files or folders to be deleted, separated by commas (,) |
return: Successful information "deletion successful"
/api/matter/rename
function:Rename files or folders
The level of access:user
, administrator
Request parameters:
Name | type | required | description |
---|---|---|---|
uuid | string | required | uuid of the file |
name | string | required | The new name cannot contain the following special symbols:< > \| * ? / \ |
return: Just renamed the Matter
entity of this file
/api/matter/change/privacy
function:Change the public and private properties of the file
The level of access:user
, administrator
Request parameters:
Name | type | required | description |
---|---|---|---|
uuid | string | required | uuid of the file |
privacy | bool | optional | Private file, default false |
return: Success information "setup successful"
/api/matter/move
function:Move a folder or file to another folder
The level of access:user
, administrator
Request parameters:
Name | type | required | description |
---|---|---|---|
srcUuids | string | required | Uuids for files or folders to be moved, separated by commas (,) |
destUuid | string | required | Target folder, root directory with root |
return: Success information "setup successful"
/api/matter/detail
function:View file details
The level of access:user
, administrator
Request parameters:
Name | type | required | description |
---|---|---|---|
uuid | string | required | The uuid of the file |
return: The Matter
entity of this file
/api/matter/page
function:Get a list of files and subfolders under a folder by pagination
The level of access:user
, administrator
Request parameters:
Name | type | required | description |
---|---|---|---|
puuid | string | optional | Folder uuid, if the root directory with root |
page | int | optional | Current page, 0 base, default 0 |
pageSize | int | optional | Number of entries per page, default 200 |
userUuid | string | optional | Filter the file owner to use the currently logged user uuid for normal users. |
name | string | optional | Fuzzy filter file name |
dir | bool | optional | Filter whether it is a folder |
orderDir | DESC orASC | optional | Sort by folder, DESC descending, ASC ascending |
orderCreateTime | DESC orASC | optional | Sort by creation time, DESC descending, ASC ascending |
orderUpdateTime | DESC orASC | optional | Sort by last modified time, DESC descending, ASC ascending |
orderSort | DESC orASC | optional | Default sort, DESC descending, ASC ascending |
orderTimes | DESC orASC | optional | Sort by download times, DESC descending, ASC ascending |
orderSize | DESC orASC | optional | Sort by file size, DESC descending, ASC ascending |
orderName | DESC orASC | optional | Sort by name, DESC in descending order, ASC in ascending order |
extensions | string | optional | Filter by file suffix name, comma (,) separated. Example:jpg,png,pdf |
shareUuid | string | optional | Shared uuid, if empty, puuid is required |
shareCode | string | optional | Extract the code |
shareRootUuid | string | optional | Share the root uuid |
return: Pager entity with Matter entities
/api/matter/mirror
function:Map local files to the Eyeblue Cloud Disk (command line tool)
The level of access:user
, administrator
Request parameters:
Name | type | required | description |
---|---|---|---|
srcPath | string | required | Original file path |
destPath | string | optional | The target path |
overwrite | bool | optional | Override, default false |
/api/matter/zip
function:Bulk up the files and download them
The level of access:user
, administrator
Request parameters:
Name | type | required | description |
---|---|---|---|
uuids | string | required | Uuids for files or folders to be downloaded, separated by commas (,) |
UserController
This Controller is responsible for creating folders, uploading files, deleting files, modifying permissions, etc., mainly operating Matter
entities
/api/user/login
function:login
The level of access:user
, administrator
Request parameters:
Name | type | required | description |
---|---|---|---|
username | string | required | user name |
password | string | required | password |
return: The User
entity of the current login
/api/user/authentication/login
function:Authorize change login
The level of access:user
, administrator
Request parameters:
Name | type | required | description |
---|---|---|---|
authentication | string | required | Authorization verification information |
return: The User
entity of the current login
/api/user/register
function:Self-help registration
The level of access:tourist
, user
, administrator
Request parameters:
Name | type | required | description |
---|---|---|---|
username | string | required | user name |
password | string | required | password |
return: The User
entity of the current login
/api/user/edit
function:Edit the user
The level of access:user
, administrator
Request parameters:
Name | type | required | description |
---|---|---|---|
uuid | string | required | User uuid to edit |
avatarUrl | string | required | Head portrait |
sizeLimit | int | required | User upload single file limit, unit byte. If negative number means unlimited |
totalSizeLimit | string | required | This user is allowed to upload the maximum total file size, unit byte |
role | string | optional | role |
return: Edit User
entity
/api/user/detail
function:View user details
The level of access:user
, administrator
Request parameters:
Name | type | required | description |
---|---|---|---|
uuid | string | required | User uuid to be viewed |
return: User
entities
/api/user/logout
function:Log out
The level of access:tourist
,user
, administrator
Request parameters:None
return: Successful message "exit successful!"
/api/user/page
function:View user list
The level of access:administrator
Request parameters:
Name | type | required | description |
---|---|---|---|
page | int | optional | Current page, 0 base, default 0 |
pageSize | int | optional | Number of entries per page, default 200 |
username | string | optional | Fuzzy filtering of user names |
status | string | optional | User status, enumerated types |
orderSort | DESC orASC | optional | Default sort, DESC descending, ASC ascending |
orderLastTime | DESC orASC | optional | Sort by last login time, DESC descending, ASC ascending |
orderCreateTime | DESC orASC | optional | Sort by creation time, DESC descending, ASC ascending |
orderUpdateTime | DESC orASC | optional | Sort by update time, DESC descending, ASC ascending |
return: User
entity's Pager
/api/user/change/password
function:Eyeblue Cloud Disk user changes user password
the level of access:user
, administrator
Request parameters:
Name | type | required | description |
---|---|---|---|
oldPassword | string | required | old password |
newPassword | string | required | new password |
return: User
entity used to change the password
/api/user/reset/password
function:The administrator resets the user password
the level of access:administrator
Request parameters:
Name | type | required | description |
---|---|---|---|
userUuid | string | required | User uuid to reset password |
password | string | required | new password |
return: The User
entity used to change the password
/api/user/toggle/status
function:The administrator modifies user status
the level of access:administrator
Request parameters:
Name | type | required | description |
---|---|---|---|
uuid | string | required | User to be operated on |
return: The User
entity used to modify the state
/api/user/transfiguration
function:Administrator turned
the level of access:administrator
Request parameters:
Name | type | required | description |
---|---|---|---|
uuid | string | required | user id |
return: turned user's uuid
DashboardController
The Controller is the blue eye cloud disk control panel, which helps to understand cloud disk statistics: PV/UV, 'active' file, active IP
/api/dashboard/page
function:Get statistics for a recent period of time
access level:administrator
Request parameters:
Name | type | required | description |
---|---|---|---|
page | int | optional | Current page, 0 base, default 0 |
pageSize | int | optional | Number of entries per page, default 200 |
orderSort | DESC orASC | optional | Default sort, DESC descending, ASC ascending |
orderDt | DESC orASC | optional | Sort by date, DESC descending, ASC ascending |
orderCreateTime | DESC orASC | optional | Sort by creation time, DESC descending, ASC ascending |
orderUpdateTime | DESC orASC | optional | Sort by update time, DESC descending, ASC ascending |
return: Pager
of Dashboard
entity
/api/dashboard/active/ip/top10
function:Get the Top10 active IP
access level:administrator
Request parameters:None
return: List composed of IP
and times
ShareController
This Controller provides sharing for Eyeblue Cloud Disk, which can be used to share anything you want (files/folders).
/api/share/create
function:Create file share
access level:user
, administrator
Request parameters:
Name | type | required | description |
---|---|---|---|
matterUuids | string | required | File uuid,To share the file uuid , share multiple file uuids separated by commas |
expireInfinity | bool | required | If the share expires, the default is false |
expireTime | string | required | The expiration date, if expireInfinity is true, defaults to that date |
return: The Share
entity that is Shared
/api/share/delete
function:Delete file sharing in my share
access level:user
, administrator
Request parameters:
Name | type | required | description |
---|---|---|---|
uuid | string | required | File uuid,To delete the Shared file uuid |
return: Success message "operation successful"
/api/share/delete/batch
function:Batch delete file share in my share
access level:user
, administrator
Request parameters:
Name | type | required | description |
---|---|---|---|
uuids | string | required | File uuid,To delete the Shared file 'uuid', remove multiple file sharing uuids separated by commas |
return: Success message "operation successful"
/api/share/page
function:Get my file sharing list
access level:user
, administrator
Request parameters:
Name | type | required | description |
---|---|---|---|
page | int | optional | Current page, 0 base, default 0 |
pageSize | int | optional | Number of entries per page, default 200 |
orderCreateTime | DESC orASC | optional | Sort by creation time, DESC descending, ASC ascending |
return: Share
entity's Pager
/api/share/browse
function:The Shared open file sharing
access level : tourist
,user
, administrator
Request parameters:
Name | type | required | description |
---|---|---|---|
shareUuid | string | required | The uuid of the currently Shared entity |
code | string | optional | ExtrExtraction code, if not Shared by itself, is required |
puuid | string | optional | File uuid |
rootUuid | string | optional | Currently share the root directory uuid that you are viewing, the front-end secondary field |
return: The Share
entity that is Shared
/api/share/zip
function:The Shared person downloads the Shared file
access level : tourist
,user
, administrator
Request parameters:
Name | type | required | description |
---|---|---|---|
shareUuid | string | required | The uuid of the currently Shared entity |
code | string
| optional | Extract code, if not ownself share is required
puuid | string
| optional | File uuid
rootUuid | string
| optional | Currently share the root directory uuid that you are viewing, the front-end secondary field
return: None