SearchShareLink API を介した共有リンクのクエリとページネーション - PDS - Alibaba Cloud -

共有を検索します。

今すぐお試しください

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

テスト

RAM 認証

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

リクエスト構文

POST /v2/share_link/search HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
domain_id	string	必須
body	object	任意	リクエストボディ。
limit	integer	任意	返す共有の最大数。有効値： 1～100。デフォルト： 100。返される共有の数は、指定された上限よりも少なくなる場合があります。	50
marker	string	任意	前の応答の `next_marker` 値を使用して、結果の次のページを取得します。このパラメーターが指定されていない場合、結果の最初のページが返されます。	NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg
return_total_count	boolean	任意	一致した共有の合計数を返すかどうかを指定します。	false
order_by	string	任意	ソートフィールド。デフォルトでは、結果は作成日時の降順でソートされます。有効値： `share_name`：共有名。 `updated_at`：更新日時。 `description`：説明。 `created_at`：作成日時。列挙値: share_name : updated_at : description : created_at :	created_at
order_direction	string	任意	ソート順。 `created_at` または `updated_at` でソートする場合、デフォルトの順序は降順です。他のフィールドでソートする場合、デフォルトの順序は昇順です。有効値： `ASC`：昇順 `DESC`：降順列挙値: ASC : DESC :	ASC
creators	array	任意	作成者の ID リスト。 1) このパラメーターが指定されていない場合、検索範囲はユーザーのロールによって異なります： - ドライブ管理者またはスーパー管理者は、すべてのメンバーから共有を検索できます。 - チーム管理者は、チームメンバーから共有を検索できます。 - 一般ユーザーは、自分の共有のみを検索できます。 2) 項目 1 で説明されているように、自分のロールの検索範囲内にあるユーザー ID のみを指定できます。
	string	任意	作成者の ID。	c9b7a5aa04d14ae3867fdc886fa01da4
query	string	任意	クエリ条件。 1) サポートされているフィールド： 1.1 `created_at`：作成日時。 1.2 `updated_at`：更新日時。 1.3 `share_name_for_fuzzy`：共有名。ファジー検索 (`match`) がサポートされています。 1.4 `status`：共有ステータス。有効値：`enabled` (有効) または `disabled` (無効)。 1.5 `expired_time`：有効期限。有効期限が切れない共有を検索するには、`expired_time='1970-01-01T00:00:00'` を設定します。これらの共有の場合、応答の `expiration` フィールドは空の文字列になります。時間範囲 `expired_time<'1970-01-02T00:00:00'` はシステム用に予約されており、有効な有効期限を表しません。	created_at>='2022-01-18T02:50:00' and created_at<'2022-01-19T09:45:28' and share_name_for_fuzzy match 'HD.mp4' and status in ['enabled', 'disabled'] and expired_time='1970-01-01T00:00:00'

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンススキーマ。
items	array	共有リスト。
	ShareLink	共有。
next_marker	string	次のマーカー。	NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg
total_count	integer	合計数。	101

例

成功レスポンス

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",
  "total_count": 101
}

エラーコード

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

変更履歴

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