Drive and Photo Service:ListShareLink - Drive and Photo Service - Alibaba Cloud - Drive and Photo Service

Operation description

Deprecated. Use SearchShareLink instead.

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
domain_id	string	Yes
body	object	No	The request body.
creator	string	No	The user ID of the creator.	c9b7a5aa04d14ae3867fdc886fa01da4
limit	integer	No	The maximum number of shares to return. The value must be in the range of [0, 100]. The number of results returned can be less than the specified value.	50
marker	string	No	A token for paginating results. To retrieve the next page, provide the `next_marker` value from the previous response. Omit this parameter to query from the beginning. Default: none	NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg
order_by	string	No	The field to sort results by. By default, results are sorted by creation time in descending order. Valid values: `share_name`: share name `updated_at`: modification time `description`: share description `created_at`: creation time Valid values: share_name : share name updated_at : modification time description : share description created_at : creation time	share_name
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 is ascending. Valid values: `ASC`: ascending order `DESC`: descending order Valid values: ASC : ascending order DESC : descending order	ASC
include_cancelled	boolean	No	Specifies whether to include canceled shares in the response.	true

Response elements

Element	Type	Description	Example
	object	The response schema.
items	array	The list of shares.
	ShareLink	A share.
next_marker	string	A token for the next page of results. This field is omitted if there are no more results to return.	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,
      "share_all_files": true,
      "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.