PDS の CreateShareLink で共有 URL を作成 - PDS - Alibaba Cloud -

共有リンクを作成します。

操作説明

共有リンクを使用すると、匿名ユーザーはユーザーのドライブ内にある 1 つ以上のファイルにアクセスできます。共有リンクの権限によって、アクセスレベルが決まります。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエスト構文

POST /v2/share_link/create HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
domain_id	string	必須	ドメイン ID。
body	object	任意	リクエストボディ。
drive_id	string	必須	ドライブの ID。	1
share_all_files	boolean	任意	`true` に設定すると、ドライブ内のすべてのファイルが共有されます。	true
file_id_list	array	任意	共有するファイルの ID リスト。1～100 個の ID を指定できます。このパラメーターは、`share_all_files` が `false` の場合に必須となり、`true` の場合は無視されます。	["520b217f13adf4fc24f2191991b1664ce045b393"]
	string	任意	共有するファイルの ID。	9520943DC264
user_id	string	任意	ユーザー ID。AccessKey (AK) を使用してリクエストを認証する場合、このパラメーターは必須です。	u123
share_pwd	string	任意	共有リンクのパスワード。長さは 0～64 文字の印刷可能な ASCII 文字である必要があります。このパラメーターが設定されていないか、空の文字列である場合、共有リンクにパスワードは不要です。	abcF123x
expiration	string	任意	共有リンクの有効期限。RFC 3339 形式 (例："2020-06-28T11:33:00.000+08:00") で指定します。有効期限のない共有リンクを作成するには、このパラメーターを空の文字列 ("") に設定します。	2020-06-28T11:33:00.000+08:00
description	string	任意	共有リンクの説明。長さは 0～1,024 文字です。	百家讲坛合集
share_name	string	任意	共有名。長さは 0～128 文字である必要があります。指定しない場合、`file_id_list` の最初の ID に対応するファイル名が使用されます。	百家讲坛-1.MP4
disable_preview	boolean	任意	`true` に設定すると、ユーザーは共有ファイルをプレビューできなくなります。	false
disable_save	boolean	任意	`true` に設定すると、ユーザーは共有ファイルを自身のドライブに保存できなくなります。	false
disable_download	boolean	任意	`true` に設定すると、ユーザーは共有ファイルをダウンロードできなくなります。	false
preview_limit	integer	任意	ユーザーが共有ファイルをプレビューできる最大回数。値は 0 以上である必要があります。値 0 は制限がないことを意味します。	100
save_limit	integer	任意	ユーザーが共有ファイルを保存できる最大回数。値は 0 以上である必要があります。値 0 は制限がないことを意味します。	100
download_limit	integer	任意	ユーザーが共有ファイルをダウンロードできる最大回数。値は 0 以上である必要があります。値 0 は制限がないことを意味します。	100
require_login	boolean	任意	`true` の場合、ユーザーは共有リンクにアクセスするためにログインする必要があります。	true
office_editable	boolean	任意	`true` に設定すると、共有ドキュメントのオンライン編集が可能になります。	true
creatable	boolean	任意	`true` に設定すると、ユーザーは共有フォルダーにファイルを作成できます。これを `true` に設定する場合は、`creatable_file_id_list` も指定する必要があります。	true
creatable_file_id_list	array	任意	ユーザーがファイルをアップロードできるフォルダー ID のリスト。
	string	任意	フォルダーの ID。	9520943DC264

レスポンスフィールド

フィールド	型	説明	例
	ShareLink	作成された共有リンクのオブジェクト。

例

成功レスポンス

JSONJSON

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

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。