Query & Paginate Share Links via SearchShareLink API - Drive and Photo Service

Queries share URLs.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST /v2/share_link/search HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request parameters.
limit	integer	No	The maximum number of results to return. Valid values: 1 to 100. Default value: 100. The number of returned results must be less than or equal to the specified number.	50
marker	string	No	The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of marker. By default, this parameter is left empty.	NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg
return_total_count	boolean	No	Specifies whether to return the total number of returned results.	false
order_by	string	No	The field by which to sort the returned results. Default value: created_at. Valid values: share_name: sorts the results by the name of the share. updated_at: sorts the results by the time when the share was modified. description: sorts the results by the description of the share. created_at: sorts the results by the time when the share was created. Valid values: share_name : Share name updated_at : Update time description : Description created_at : Creation time	created_at
order_direction	string	No	The order in which you want to sort the returned results. By default, order_direction is set to DESC if order_by is set to created_at or updated_at, and is set to ASC if order_by is set to other values. Valid values: ASC: sorts the results in ascending order. DESC: sorts the results in descending order. Valid values: ASC : Ascending DESC : Descending	ASC
creators	array	No	The creators of shares. Set this parameter to a user ID. If you do not specify this parameter, Drive and Photo Service automatically queries shares based on your permissions. If you are a drive administrator or the super administrator, the shares created by all members are queried. If you are a team administrator, the shares created by all team members are queried. If you are a common user, only the shares created by yourself are queried. If you specify this parameter, this parameter must be set to the ID of the super administrator, a drive administrator, or a team administrator.
	string	No	The creator of the share.	c9b7a5aa04d14ae3867fdc886fa01da4
query	string	No	The query condition that is used to search for share URLs. You can use the following fields to specify query conditions: created_at: queries a share URL based on the time when the share URL was created. updated_at: queries a share URL based on the time when the share URL was modified. share_name_for_fuzzy: queries a share URL based on the name of the share. A fuzzy match is supported. status: queries a share URL based on the status of the share. Valid values: enabled and disabled. A value of enabled indicates that the share is valid. A value of disabled indicates that the share is canceled. expired_time: queries a share URL based on the expiration time of the share. If the share never expires, set this field to 1970-01-01T00:00:00. Otherwise, set this field to 1970-01-02T00:00:00.	created_at>='2022-01-18T02:50:00' and created_at<'2022-01-19T09:45:28' and share_name_for_fuzzy match 'HD.mp4' and status in ['enabled', 'disabled'] and expired_time='1970-01-01T00:00:00'

Response elements

Element	Type	Description	Example
	object	The response parameters.
items	array	The share URLs.
	ShareLink	A share URL.
next_marker	string	A pagination token. It can be used in the next request to retrieve a new page of results. If next_marker is empty, no next page exists.	NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg
total_count	integer	The total number of entries returned.	101

Examples

Success response

JSON format

{
  "items": [
    {
      "share_id": "7JQX1FswpQ8",
      "share_pwd": "abcF123x",
      "drive_id": "1",
      "file_id_list": [
        "[\"xx\"]"
      ],
      "expiration": "2020-06-28T11:33:00.000+08:00",
      "expired": false,
      "created_at": "2019-08-20T06:51:27.292Z",
      "updated_at": "2019-08-20T06:51:27.292Z",
      "description": "videos",
      "share_name": "video-1.MP4",
      "creator": "c9b7a5aa04d14ae3867fdc886fa01da4",
      "status": "enabled",
      "preview_count": 10,
      "save_count": 2,
      "download_count": 5,
      "report_count": 0,
      "video_preview_count": 1,
      "access_count": 4,
      "disable_preview": false,
      "disable_save": false,
      "disable_download": false,
      "preview_limit": 100,
      "save_limit": 100,
      "download_limit": 100,
      "require_login": false,
      "share_all_files": true,
      "share_msg": "pwd: 123",
      "save_download_limit": 100,
      "office_editable": true
    }
  ],
  "next_marker": "NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg",
  "total_count": 101
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.