共有を一覧表示します。
操作説明
非推奨です。代わりに SearchShareLink を使用してください。
今すぐお試しください
テスト
RAM 認証
リクエスト構文
POST /v2/share_link/list HTTP/1.1リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| domain_id |
string |
必須 |
||
| body |
object |
任意 |
リクエストボディ。 |
|
| creator |
string |
任意 |
作成者のユーザー ID。 |
c9b7a5aa04d14ae3867fdc886fa01da4 |
| limit |
integer |
任意 |
返す共有の最大数。値の範囲は 0～100 です。 返される結果の数は、指定された値より少なくなる場合があります。 |
50 |
| marker |
string |
任意 |
結果をページ分割するためのトークン。次のページを取得するには、前のレスポンスの |
NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg |
| order_by |
string |
任意 |
結果のソートに使用するフィールド。デフォルトでは、結果は作成時刻の降順でソートされます。有効な値：
列挙値:
|
share_name |
| order_direction |
string |
任意 |
ソート順。ソートフィールドが
列挙値:
|
ASC |
| include_cancelled |
boolean |
任意 |
レスポンスにキャンセルされた共有を含めるかどうかを指定します。 |
true |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンススキーマ。 |
||
| items |
array |
共有のリスト。 |
|
| ShareLink |
共有。 |
||
| next_marker |
string |
次のページの結果を取得するためのトークン。返す結果がこれ以上ない場合、このフィールドは省略されます。 |
NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg |
例
成功レスポンス
JSONJSON
{
"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"
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。