Update Share Links with UpdateShareLink API - Drive and Photo Service - Alibaba Cloud - Drive and Photo Service

Updates a share link.

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

Request parameters

Parameter	Type	Required	Description	Example
domain_id	string	Yes	The domain ID.
body	object	No	The request body.
share_id	string	Yes	The share ID.	7JQX1FswpQ8
share_pwd	string	No	The share password. The password must be 0 to 64 characters long. An empty string ("") indicates no password is required.	abcF123x
expiration	string	No	The expiration time. The value must be in RFC 3339 format, for example, `2020-06-28T11:33:00.000+08:00`. An empty string ("") indicates that the share link never expires.	2020-06-28T11:33:00.000+08:00
description	string	No	The description of the share link, which can be up to 1,024 characters long.	百家讲坛全集
share_name	string	No	The share name. If not specified, the name of the first file is used by default. The name must be 0 to 128 characters long.	百家讲坛-1.mp4
status	string	No	The status of the share link. Valid values: `disabled`: The share is canceled. `enabled`: The share is active. Valid values: disabled : enabled :	enabled
preview_count	integer	No	The preview count. The value must be greater than or equal to 0.	3
save_count	integer	No	The save count. The value must be greater than or equal to 0.	5
download_count	integer	No	The download count. The value must be greater than or equal to 0.	30
report_count	integer	No	The report count. The value must be greater than or equal to 0.	1
video_preview_count	integer	No	The video preview count. The value must be greater than or equal to 0.	100
disable_preview	boolean	No	Whether to disable previews for the share.	false
disable_save	boolean	No	Whether to prevent users from saving files from the share.	false
disable_download	boolean	No	Whether to prevent users from downloading files from the share.	false
preview_limit	integer	No	The maximum number of times the shared content can be previewed. The value must be greater than or equal to 0. A value of 0 indicates no limit.	100
save_limit	integer	No	The maximum number of times the shared content can be saved. The value must be greater than or equal to 0. A value of 0 indicates no limit.	100
download_limit	integer	No	The maximum number of times the shared content can be downloaded. The value must be greater than or equal to 0. A value of 0 indicates no limit.	100
office_editable	boolean	No	Whether to allow online editing of the shared documents.	true

Response elements

Element	Type	Description	Example
	ShareLink	Details of the updated share.

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.