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

Searches for shares.

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
domain_id	string	Yes
body	object	No	The request body.
limit	integer	No	The maximum number of shares to return. Valid values: 1-100. Default: 100. The number of shares returned may be less than the specified limit.	50
marker	string	No	Use the `next_marker` value from a previous response to retrieve the next page of results. If this parameter is not specified, the first page of results is returned.	NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg
return_total_count	boolean	No	Specifies whether to return the total count of matched shares.	false
order_by	string	No	The sort field. By default, results are sorted by creation time in descending order. Valid values: `share_name`: The share name. `updated_at`: The update time. `description`: The description. `created_at`: The creation time. Valid values: share_name : updated_at : description : created_at :	created_at
order_direction	string	No	The sort order. If the sort field is `created_at` or `updated_at`, the default order is descending. For other sort fields, the default order is ascending. Valid values: `ASC`: ascending `DESC`: descending Valid values: ASC : DESC :	ASC
creators	array	No	The IDs of the creators. 1) If this parameter is not specified, the search scope depends on the user's role: - A drive administrator or super administrator can search for shares from all members. - A team administrator can search for shares from team members. - A regular user can only search for their own shares. 2) You can only specify user IDs that are within your role's search scope, as described in point 1).
	string	No	The ID of a creator.	c9b7a5aa04d14ae3867fdc886fa01da4
query	string	No	The query conditions. 1) Supported fields: 1.1 `created_at`: The creation time. 1.2 `updated_at`: The update time. 1.3 `share_name_for_fuzzy`: The share name. Fuzzy search (`match`) is supported. 1.4 `status`: The share status. Valid values: `enabled` (active) or `disabled` (canceled). 1.5 `expired_time`: The expiration time. To search for shares that never expire, set `expired_time='1970-01-01T00:00:00'`. For these shares, the `expiration` field in the response is an empty string. The time range `expired_time<'1970-01-02T00:00:00'` is reserved for system use and does not represent a valid expiration time.	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 schema.
items	array	The share list.
	ShareLink	A share.
next_marker	string	The next marker.	NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg
total_count	integer	The total count.	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,
      "share_all_files": true,
      "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.