Drive and Photo Service:ListShareLink - Drive and Photo Service

Operation description

This operation is discontinued. To query shares, you can call the SearchShareLink operation.

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/list HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request parameters.
creator	string	No	The creator of the share.	c9b7a5aa04d14ae3867fdc886fa01da4
limit	integer	No	The maximum number of results to return. Valid values: 0 to 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
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 : Share update time description : Share description created_at : Share creation time	share_name
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
include_cancelled	boolean	No	Specifies whether to return the shares that are canceled.	true

Response elements

Element	Type	Description	Example
	object	The response parameters.
items	array	The information about the shares.
	ShareLink	The information about a share.
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

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"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.