共有リンクを更新します。
今すぐお試しください
テスト
RAM 認証
リクエスト構文
POST /v2/share_link/update HTTP/1.1
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| domain_id |
string |
必須 |
|
|
| body |
object |
任意 |
リクエストボディです。 |
|
| share_id |
string |
必須 |
共有 ID です。 |
7JQX1FswpQ8 |
| share_pwd |
string |
任意 |
共有パスワード。パスワードの長さは 0~64 文字である必要があります。空の文字列 ("") は、パスワードが不要であることを示します。 |
abcF123x |
| expiration |
string |
任意 |
有効期限。値は RFC 3339 フォーマットである必要があります (例: |
2020-06-28T11:33:00.000+08:00 |
| description |
string |
任意 |
共有リンクの説明。最大 1,024 文字です。 |
百家讲坛全集 |
| share_name |
string |
任意 |
共有名。指定しない場合、デフォルトで最初のファイルの名前が使用されます。名前の長さは 0~128 文字である必要があります。 |
百家讲坛-1.mp4 |
| status |
string |
任意 |
共有リンクのステータス。有効な値:
列挙値:
|
enabled |
| preview_count |
integer |
任意 |
プレビュー回数。値は 0 以上である必要があります。 |
3 |
| save_count |
integer |
任意 |
保存回数。値は 0 以上である必要があります。 |
5 |
| download_count |
integer |
任意 |
ダウンロード回数。値は 0 以上である必要があります。 |
30 |
| report_count |
integer |
任意 |
通報回数。値は 0 以上である必要があります。 |
1 |
| video_preview_count |
integer |
任意 |
動画のプレビュー回数。値は 0 以上である必要があります。 |
100 |
| 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 |
| office_editable |
boolean |
任意 |
共有ドキュメントのオンライン編集を許可するかどうか。 |
true |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
| 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
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。