共有を作成します。
操作説明
ファイル共有とも呼ばれる共有は、ユーザースペースから匿名ユーザーに1つ以上のファイルを公開するファイルビューコンテナです。匿名ユーザーは、共有権限の制約内でファイルにアクセスできます。
今すぐお試しください
テスト
RAM 認証
リクエスト構文
POST /v2/share_link/create HTTP/1.1リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| body |
object |
任意 |
リクエストパラメーターです。 |
|
| drive_id |
string |
必須 |
ドライブ ID。 |
1 |
| share_all_files |
boolean |
任意 |
ドライブ内のすべてのファイルを共有するかどうかを指定します。 |
true |
| file_id_list |
array |
任意 |
親パスで共有するファイルの ID。親パス内のファイルの数は1から100までです。share_all_files が true に設定されている場合、このパラメーターは無効になります。それ以外の場合は、このパラメーターを指定する必要があります。 |
["520b217f13adf4fc24f2191991b1664ce045b393"] |
|
string |
任意 |
親パスで共有するファイルの ID。 |
9520943DC264 |
|
| user_id |
string |
任意 |
ユーザー ID。 |
u123 |
| share_pwd |
string |
任意 |
アクセスコード。アクセスコードは0～64バイトの長さである必要があります。このパラメーターを指定しないか、空のままにした場合、ファイルはアクセスコードなしでアクセスできます。この場合、共有 URL をクエリする操作を呼び出すときに、share_pwd パラメーターを指定する必要はありません。アクセスコードには、表示可能な ASCII 文字のみを含めることができます。 |
abcF123x |
| expiration |
string |
任意 |
共有 URL の有効期限。このパラメーターの値は RFC 3339 標準に従います。例: "2020-06-28T11:33:00.000+08:00"。expiration が "" に設定されている場合、共有 URL は期限切れになりません。 |
2020-06-28T11:33:00.000+08:00 |
| description |
string |
任意 |
共有の説明。説明は0～1,024文字の長さである必要があります。 |
百家讲坛合集 |
| share_name |
string |
任意 |
共有名。このパラメーターを空のままにした場合、ファイル ID リストの最初の ID に対応するファイル名が使用されます。名前は0～128文字の長さである必要があります。 |
百家讲坛-1.MP4 |
| disable_preview |
boolean |
任意 |
プレビュー機能を無効にするかどうかを指定します。 |
false |
| disable_save |
boolean |
任意 |
ダンプ機能を無効にするかどうかを指定します。 |
false |
| disable_download |
boolean |
任意 |
ダウンロード機能を無効にするかどうかを指定します。 |
false |
| preview_limit |
integer |
任意 |
共有ファイルのプレビュー回数の制限。このパラメーターの値は0以上である必要があります。値が0の場合、制限はありません。 |
100 |
| save_limit |
integer |
任意 |
共有ファイルのダンプ回数の制限。このパラメーターの値は0以上である必要があります。値が0の場合、制限はありません。 |
100 |
| download_limit |
integer |
任意 |
共有ファイルのダウンロード回数の制限。このパラメーターの値は0以上である必要があります。値が0の場合、制限はありません。 |
100 |
| require_login |
boolean |
任意 |
共有へのアクセスを許可する前にログインを要求します。 |
true |
| office_editable |
boolean |
任意 |
共有ドキュメントのオンライン編集を許可します。 |
true |
| creatable |
boolean |
任意 |
共有内のフォルダーにファイルの作成を許可します。creatable が 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,
"require_login": false,
"share_all_files": true,
"share_msg": "pwd: 123",
"save_download_limit": 100,
"office_editable": true
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。