Layanan Foto dan Drive (PDS) menyediakan dua mode penyimpanan data untuk domain: mode standar dan mode hosting. Pencarian file hanya didukung untuk mode standar. Anda dapat memanggil operasi /file/search untuk menanyakan file dalam drive yang memiliki izin kueri file. Anda tidak dapat memanggil operasi /file/search untuk menanyakan file di tempat sampah.
Sintaksis Permintaan
POST /v2/file/search
Parameter Permintaan
Parameter | Posisi | Tipe | Diperlukan | Deskripsi |
Authorization | Header | STRING | Ya | Token akses. |
drive_id | Body | STRING | Tidak | ID dari drive tempat file akan diperiksa. |
drive_id_list | Body | STRING ARRAY | Tidak | ID dari drive tempat file akan diperiksa. Contoh: ["1","2"]. |
query | Body | STRING | Ya | String kueri. Untuk informasi lebih lanjut, lihat konten berikutnya dari topik ini. Nilai parameter ini bisa mencapai 4.096 karakter. |
order_by | Body | STRING | Ya | Aturan untuk mengurutkan hasil kueri. Untuk informasi lebih lanjut, lihat konten berikutnya dari topik ini. Nilai parameter ini bisa mencapai 128 karakter. |
limit | Body | INTEGER (INT32) | Tidak | Jumlah maksimum entri yang akan dikembalikan. Nilai valid: 1 hingga 100. Nilai default: 50. |
marker | Body | STRING | Tidak | Pengenal awal dari kueri. Jika Anda menentukan parameter marker, nilai parameter query diabaikan. |
url_expire_sec | Body | INTEGER (INT64) | Tidak | Masa berlaku URL yang akan dikembalikan. Unit: detik. Nilai valid: 10 hingga 14.400. |
Anda harus menentukan salah satu parameter drive_id atau drive_id_list. Jika parameter drive_id ditentukan, nilai parameter drive_id_list diabaikan.
Aturan untuk menentukan parameter query:
Tipe data yang didukung:
a. Tipe data dasar: LONG, STRING, BOOLEAN, dan DOUBLE.
b. Tipe data komposit: ARRAY dan DATE. Nilai tipe DATE harus dalam format yyyy-MM-ddTHH:mm:ss dalam zona waktu UTC+0 dan harus diapit dengan tanda kutip ganda (") atau tanda kutip tunggal ('). Contoh: "2006-01-02T00:00:00".
Operator untuk menanyakan data tipe dasar:
a. LONG: =, <, >, <=, dan >=.
b. STRING: =, prefix, dan match. Operator = digunakan untuk kecocokan tepat. prefix digunakan untuk kecocokan berdasarkan awalan dan tidak dapat digunakan untuk menanyakan file berdasarkan parameter nama. match digunakan untuk kecocokan kabur dan dapat digunakan untuk menanyakan file hanya berdasarkan parameter nama.
c. BOOLEAN: =.
d. DOUBLE: =, <, >, <=, dan >=.
Operator untuk menanyakan data tipe komposit:
a. ARRAY: IN untuk kueri berdasarkan beberapa kondisi.
b. DATE: =, <, >, <=, dan >=.
Operator logis yang didukung: NOT, AND, dan OR.
Kurung didukung. Prioritas kueri adalah Kurung > NOT > AND > OR.
Contoh:
Menanyakan file berdasarkan kecocokan tepat
// Menanyakan file bernama Report.ppt. name = "Report.ppt"Menanyakan file dengan menentukan rentang
// Menanyakan file yang dibuat sebelum 14 Januari 2019. Waktu harus dalam UTC+0. created_at < "2019-01-14T00:00:00"Menanyakan file berdasarkan kecocokan kabur
// Menanyakan file yang namanya mengandung Report. name match "Report"Menanyakan file menggunakan operator logis
// Menanyakan file yang dibuat pada 14 Januari 2019. Waktu harus dalam UTC+0. created_at > "2019-01-14T00:00:00" and created_at < "2019-01-15T00:00:00"Menanyakan file berdasarkan beberapa kondisi
// Menanyakan file yang ukurannya lebih besar dari 1.024 byte, nilai parameter hidden adalah false, dan nilai parameter file_extension bukan mp4. size > 1024 and hidden = false and not file_extension = 'mp4'Menanyakan array
// Menanyakan file yang namanya diakhiri dengan .jpg, .png, atau .gif. file_extension in ["jpg", "png", "gif"]
Aturan untuk menentukan parameter order_by:
Nilai valid: ASC dan DESC. ASC menunjukkan urutan naik, dan DESC menunjukkan urutan turun.
Sintaksis: Parameter ASC atau Parameter DESC.
Pisahkan beberapa aturan pengurutan dengan koma (,).
Beberapa aturan pengurutan diterapkan berdasarkan urutan spesifikasi.
Contoh:
Mengurutkan hasil berdasarkan satu aturan dalam urutan naik
// Mengurutkan hasil berdasarkan parameter nama dalam urutan naik. name ASCMengurutkan hasil berdasarkan satu aturan dalam urutan turun
// Mengurutkan hasil berdasarkan parameter created_at dalam urutan turun. created_at DESCMengurutkan hasil berdasarkan beberapa aturan
// Mengurutkan hasil berdasarkan parameter created_at dalam urutan turun. Jika nilai parameter created_at sama di antara hasil, urutkan hasil berdasarkan parameter nama dalam urutan naik. created_at DESC,name ASC
Parameter berdasarkan mana file dapat diperiksa atau hasil kueri dapat diurutkan
Parameter | Tipe | Kueri | Urutkan | Deskripsi |
parent_file_id | STRING | ✔️ | N/A | ID folder induk. Subfolder tidak dicari saat Anda menggunakan parameter ini untuk menanyakan file. |
name | STRING | ✔️ | ✔️ | Nama file, yang dapat digunakan untuk kecocokan kabur. |
type | STRING | ✔️ | ✔️ | Tipe file. Nilai valid: file dan folder. |
file_extension | STRING | ✔️ | N/A | Ekstensi nama file. |
description | STRING | ✔️ | N/A | Deskripsi file. Nilai parameter ini dapat dipecah menjadi istilah untuk kecocokan istilah. |
mime_type | STRING | ✔️ | N/A | Tipe Multipurpose Internet Mail Extensions (MIME) dari file. |
starred | BOOLEAN | ✔️ | N/A | Menunjukkan apakah file ditambahkan ke favorit. |
created_at | DATE | ✔️ | ✔️ | Waktu ketika file dibuat. |
updated_at | DATE | ✔️ | ✔️ | Waktu ketika file terakhir dimodifikasi. |
status | STRING | ✔️ | N/A | Status file. |
hidden | BOOLEAN | ✔️ | N/A | Menunjukkan apakah file tersembunyi. |
size | LONG | ✔️ | ✔️ | Ukuran file. |
image_time | DATE | ✔️ | ✔️ | Waktu ketika foto diambil. |
last_access_at | DATE | ✔️ | ✔️ | Waktu ketika file terakhir diakses. |
category | STRING | ✔️ | N/A | Kategori file. Nilai valid: image, video, doc, audio, app, dan others. |
label | STRING | ✔️ | N/A | Nama tag sistem. |
face_group_id | STRING | ✔️ | N/A | ID grup wajah, yang dapat digunakan untuk menanyakan gambar dalam grup wajah. Anda dapat memperoleh ID dengan memanggil operasi ListFacegroups. |
address | STRING | ✔️ | N/A | Informasi alamat file, termasuk negara, provinsi, kota, distrik, dan sub-distrik. |
LONG: menyimpan bilangan bulat bertanda 64-bit.
BOOLEAN: menyimpan nilai true atau false.
DATE: menyimpan kombinasi tanggal dan waktu. Nilai tipe DATE harus dalam format yyyy-MM-ddTHH:mm:ss dalam zona waktu UTC+0 dan harus diapit dengan tanda kutip ganda (") atau tanda kutip tunggal ('). Contoh: "2006-01-02T00:00:00".
STRING: menyimpan string.
Parameter Respons
Parameter respons sama dengan operasi ListFile.