ファイルのクエリ - Drive and Photo Service - Alibaba Cloud ドキュメントセンター

説明

Photo and Drive Service (PDS) は、ドメインに対して標準モードとホスティングモードの 2 つのデータストレージモードを提供します。ファイルクエリは、標準モードでのみサポートされています。 /file/search 操作を呼び出して、ファイルクエリ権限を持つドライブ内のファイルをクエリできます。 /file/search 操作を呼び出して、ゴミ箱内のファイルをクエリすることはできません。

リクエスト構文

POST /v2/file/search

リクエストパラメーター

パラメーター	位置	型	必須	説明
Authorization	ヘッダー	STRING	はい	アクセストークン。
drive_id	本文	STRING	いいえ	ファイルをクエリするドライブの ID。
drive_id_list	本文	STRING ARRAY	いいえ	ファイルをクエリするドライブの ID。例: ["1","2"]。
query	本文	STRING	はい	クエリ文字列。詳細については、このトピックの以下の内容をご参照ください。このパラメーターの値は、最大 4,096 文字です。
order_by	本文	STRING	はい	クエリ結果をソートするためのルール。詳細については、このトピックの以下の内容をご参照ください。このパラメーターの値は、最大 128 文字です。
limit	本文	INTEGER (INT32)	いいえ	返されるエントリの最大数。有効値: 1 ～ 100。デフォルト値: 50。
marker	本文	STRING	いいえ	クエリの開始識別子。 marker パラメーターを指定した場合、 query パラメーターの値は無視されます。
url_expire_sec	本文	INTEGER (INT64)	いいえ	返される URL の有効期間。単位: 秒。有効値: 10 ～ 14400。

説明

drive_id パラメーターと drive_id_list パラメーターのいずれかを指定する必要があります。 drive_id パラメーターを指定した場合、 drive_id_list パラメーターの値は無視されます。

query パラメーターを指定するためのルール:

サポートされているデータ型:
a. 基本データ型: LONG、STRING、BOOLEAN、および DOUBLE。
b. 複合データ型: ARRAY および DATE。 DATE 型の値は、UTC+0 タイムゾーンの yyyy-MM-ddTHH:mm:ss 形式である必要があり、二重引用符 (") または単一引用符 (') で囲む必要があります。例: "2006-01-02T00:00:00"。
基本データ型のデータをクエリするための演算子:
a. LONG: =、<、>、<=、および >=。
b. STRING: =、prefix、および match。 = 演算子は、完全一致に使用されます。 prefix はプレフィックスベースの一致に使用され、 name パラメーターに基づいてファイルをクエリするために使用することはできません。 match はあいまい一致に使用され、 name パラメーターに基づいてのみファイルをクエリするために使用できます。
c. BOOLEAN: =。
d. DOUBLE: =、<、>、<=、および >=。
複合データ型のデータをクエリするための演算子:
a. ARRAY: 複数の条件に基づくクエリの場合は IN。
b. DATE: =、<、>、<=、および >=。
サポートされている論理演算子: NOT、AND、および OR。
括弧がサポートされています。クエリの優先順位は、括弧 > NOT > AND > OR です。

例:

完全一致に基づいてファイルをクエリする

// Report.ppt という名前のファイルをクエリします。
name = "Report.ppt"

範囲を指定してファイルをクエリする

// 2019 年 1 月 14 日より前に作成されたファイルをクエリします。時間は UTC+0 である必要があります。
created_at < "2019-01-14T00:00:00"

あいまい一致に基づいてファイルをクエリする

// 名前に Report が含まれるファイルをクエリします。
name match "Report"

論理演算子を使用してファイルをクエリする

// 2019 年 1 月 14 日に作成されたファイルをクエリします。時間は UTC+0 である必要があります。
created_at > "2019-01-14T00:00:00" and created_at < "2019-01-15T00:00:00"

複数の条件に基づいてファイルをクエリする

// サイズが 1,024 バイトより大きく、 hidden パラメーターの値が false で、 file_extension パラメーターの値が mp4 でないファイルをクエリします。
size > 1024 and hidden = false and not file_extension = 'mp4'

配列をクエリする

// 名前の末尾が .jpg、.png、または .gif であるファイルをクエリします。
file_extension in ["jpg", "png", "gif"]

order_by パラメーターを指定するためのルール:

有効値: ASC および DESC。 ASC は昇順を、DESC は降順を示します。
構文: パラメーター ASC またはパラメーター DESC。
複数のソートルールはコンマ (,) で区切ります。
複数のソートルールは、指定された順序に基づいて適用されます。

例:

単一のルールに基づいて結果を昇順でソートする

// name パラメーターに基づいて結果を昇順でソートします。
name ASC

単一のルールに基づいて結果を降順でソートする

// created_at パラメーターに基づいて結果を降順でソートします。
created_at DESC

複数のルールに基づいて結果をソートする

// created_at パラメーターに基づいて結果を降順でソートします。 created_at パラメーターの値が結果間で同じである場合、 name パラメーターに基づいて結果を昇順でソートします。
created_at DESC,name ASC

ファイルをクエリしたり、クエリ結果をソートしたりできるパラメーター

パラメーター	型	クエリ	ソート	説明
parent_file_id	STRING	✔️	N/A	親フォルダの ID。このパラメーターを使用してファイルをクエリする場合、サブフォルダは検索されません。
name	STRING	✔️	✔️	ファイルの名前。あいまい一致に使用できます。
type	STRING	✔️	✔️	ファイルの型。有効値: file および folder。
file_extension	STRING	✔️	N/A	ファイル名拡張子。
description	STRING	✔️	N/A	ファイルの説明。このパラメーターの値は、用語一致のために用語に分割できます。
mime_type	STRING	✔️	N/A	ファイルの MIME (Multipurpose Internet Mail Extensions) タイプ。
starred	BOOLEAN	✔️	N/A	ファイルがお気に入りに追加されているかどうかを示します。
created_at	DATE	✔️	✔️	ファイルが作成された日時。
updated_at	DATE	✔️	✔️	ファイルが最後に変更された日時。
status	STRING	✔️	N/A	ファイルの状態。
hidden	BOOLEAN	✔️	N/A	ファイルが非表示かどうかを示します。
size	LONG	✔️	✔️	ファイルのサイズ。
image_time	DATE	✔️	✔️	写真が撮影された日時。
last_access_at	DATE	✔️	✔️	ファイルに最後にアクセスされた日時。
category	STRING	✔️	N/A	ファイルのカテゴリ。有効値: image、video、doc、audio、app、および others。
label	STRING	✔️	N/A	システムタグの名前。
face_group_id	STRING	✔️	N/A	顔グループの ID。顔グループ内の画像をクエリするために使用できます。 ListFacegroups 操作を呼び出すことで ID を取得できます。
address	STRING	✔️	N/A	ファイルの住所情報。国、都道府県、市、区、および町名を含みます。

LONG: 符号付き 64 ビット整数を格納します。
BOOLEAN: true または false 値を格納します。
DATE: 日付と時刻の組み合わせを格納します。 DATE 型の値は、UTC+0 タイムゾーンの yyyy-MM-ddTHH:mm:ss 形式である必要があり、二重引用符 (") または単一引用符 (') で囲む必要があります。例: "2006-01-02T00:00:00"。
STRING: 文字列を格納します。

レスポンスパラメーター

レスポンスパラメーターは、ListFile 操作のパラメーターと同じです。