Topik ini menjelaskan operasi terkait tautan berbagi.
Parameter options dari tipe IPDSRequestConfig dienkapsulasi berdasarkan opsi konfigurasi permintaan axios. Untuk informasi lebih lanjut, lihat AxiosRequestConfig.
Metode createShareLink
Anda dapat memanggil metode ini untuk membuat tautan berbagi.
const result = await client.createShareLink(params, options)Contoh
await client.createShareLink({
description: 'tes',
drive_id: '1060',
expiration: '2021-12-08T15:59:59.999Z',
file_id_list: ['61a49e39d687d40967164cf98ef65ab5bb554f53'],
share_pwd: '831956',
})Parameter permintaan
Parameter | Tipe | Diperlukan | Deskripsi |
params | ICreateShareLinReq | Ya | Parameter yang digunakan untuk membuat tautan berbagi. |
options | IPDSRequestConfig | Parameter permintaan lainnya. |
ICreateShareLinReq
Parameter | Tipe | Diperlukan | Deskripsi |
description | string | Deskripsi. | |
drive_id | string | Ya | ID drive. |
share_pwd | string | Kode akses. Panjang maksimumnya adalah 64 karakter. Jika parameter ini dibiarkan kosong, tidak diperlukan kode akses. | |
file_id_list | string[] | Ya | Parameter ini hanya berlaku dalam mode standar. Sekumpulan file atau daftar folder. Jumlah file atau folder bisa mencapai 100. |
file_path_list | string[] | Ya | Parameter ini berlaku dalam mode hosting. Anda dapat menentukan parameter file_id_list atau parameter file_path_list. |
expiration | string | Ya | Waktu kedaluwarsa tautan berbagi. Tentukan waktu dalam format RFC 3339. Contoh: 2020-06-28T11:33:00.000+08:00. Jika parameter ini dibiarkan kosong, tautan berbagi valid secara permanen. |
Parameter respons
Parameter | Tipe | Diperlukan | Deskripsi |
result | IShareLinkItem | Ya | Detail tautan berbagi. |
Metode cancelShareLink
Anda dapat memanggil metode ini untuk membatalkan berbagi.
await client.cancelShareLink(params, options)Contoh
await client.cancelShareLink({
share_id: 'YgHgBeXGZWr'
})Parameter permintaan
Parameter | Tipe | Diperlukan | Deskripsi |
params | Object | Ya | Parameter yang digunakan untuk membatalkan berbagi. |
options | IPDSRequestConfig | Parameter permintaan lainnya |
params
Parameter | Tipe | Diperlukan | Deskripsi |
share_id | string | Ya | ID berbagi. |
Parameter respons
Tidak ada parameter respons yang dikembalikan.
Metode listShareLinks
Anda dapat memanggil metode ini untuk menanyakan daftar berbagi.
const result = await client.listShareLinks(params, options)Contoh
const {items=[], next_marker} = await client.listShareLinks({
creator: 'user_id',
marker: '',
limit: 100,
})Parameter permintaan
Parameter | Tipe | Diperlukan | Deskripsi |
params | Object | Ya | Parameter yang digunakan untuk menanyakan daftar berbagi. |
options | IPDSRequestConfig | Parameter permintaan lainnya. |
params
Parameter | Tipe | Diperlukan | Deskripsi |
limit | number | Jumlah maksimum entri yang akan dikembalikan. Nilai valid: 1 hingga 100. Nilai default: 100. | |
marker | string | Pengenal awal dari kueri. | |
creator | string | ID pembuat berbagi. Jika Anda memanggil metode ini sebagai administrator, berbagi ditanyakan berdasarkan kasus-kasus berikut: Jika Anda tidak menentukan parameter ini, berbagi yang dibuat oleh semua pengguna ditanyakan. Jika Anda menetapkan nilai parameter ini ke ID pengguna tertentu, berbagi yang dibuat oleh pengguna yang ditentukan ditanyakan. Jika Anda memanggil metode ini sebagai pengguna biasa, berbagi ditanyakan berdasarkan kasus-kasus berikut: Jika Anda tidak menentukan parameter ini, berbagi yang Anda buat ditanyakan. Jika Anda menetapkan nilai parameter ini ke ID pengguna tertentu selain milik Anda, kode kesalahan 403 dikembalikan. |
Parameter respons
Parameter | Tipe | Diperlukan | Deskripsi |
result | IListRes<IShareLinkItem> | Ya | Hasil yang dikembalikan. |
IListRes
Parameter | Tipe | Diperlukan | Deskripsi |
items | IShareLinkItem[] | Ya | Parameter IShareLinkItem. |
next_marker | string | Token paginasi yang digunakan dalam permintaan berikutnya untuk mengambil halaman hasil baru. |
IShareLinkItem
Parameter | Tipe | Deskripsi |
share_id | string | ID berbagi. |
share_pwd | string | Kode akses. Jika parameter ini dibiarkan kosong, string kosong dikembalikan, yang menunjukkan bahwa tidak diperlukan kode akses. |
share_msg | string | Kata sandi berbagi. |
share_url | string | Tautan berbagi. |
share_policy | 'url' | 'msg' | Kebijakan berbagi. Nilai valid: url: menggunakan URL. msg: menggunakan kata sandi. |
description | string | Deskripsi. |
share_name | string | Nama berbagi. |
download_count | number | Jumlah kali file bersama diunduh. |
preview_count | number | Jumlah kali file bersama dipratinjau. |
save_count | number | Jumlah kali file bersama disimpan. |
drive_id | string | ID drive. |
share_pwd | string | Kode akses. Panjang maksimumnya adalah 64 karakter. Jika parameter empty dibiarkan kosong, tidak diperlukan kode akses. |
file_id_list | string[] | Parameter ini dikembalikan dalam mode standar. |
file_path_list | string[] | Parameter ini dikembalikan dalam mode hosting. |
expiration | Date | Waktu kedaluwarsa tautan berbagi. Waktu dalam format RFC 3339. Contoh: 2020-06-28T11:33:00.000+08:00. Jika parameter ini dibiarkan kosong, tautan berbagi valid secara permanen. |
expired | boolean | Menunjukkan apakah tautan berbagi telah kedaluwarsa. |
status | 'enabled' | 'disabled' | Status berbagi. |
creator | string | ID pembuat tautan berbagi. |
created_at | string | Waktu pembuatan berbagi. |
updated_at | string | Waktu terakhir pembaruan berbagi. |
Metode getShareLinkByAnonymous
Anda dapat memanggil metode ini untuk menanyakan informasi tentang berbagi secara anonim tanpa menggunakan token.
const result = await client.getShareLinkByAnonymous(params, options)Contoh
const domain_id = 'ID domain Anda'
const client = new PDSClient({
api_endpoint: `https://${domain_id}.api.aliyunpds.com`
})
let info = client.getShareLinkByAnonymous({
share_id: 'xxxxxx'
})Parameter permintaan
Parameter | Tipe | Diperlukan | Deskripsi |
params | Object | Ya | Parameter yang digunakan untuk menanyakan informasi tentang berbagi. |
options | IPDSRequestConfig | Parameter permintaan lainnya. |
params
Parameter | Tipe | Diperlukan | Deskripsi |
share_id | string | Ya | ID berbagi. |
Parameter respons
Parameter | Tipe | Diperlukan | Deskripsi |
result | IAnonymousShareLinkItem | Ya | Hasil yang dikembalikan. |
IAnonymousShareLinkItem
Parameter | Tipe | Diperlukan | Deskripsi |
avatar | string | Ya | Foto profil pengguna yang membagikan file. |
creator_id | string | Ya | ID pembuat berbagi. |
creator_name | string | Ya | Nama panggilan pembuat berbagi. |
creator_phone | string | Nomor ponsel pembuat berbagi. | |
disable_download | boolean | Menunjukkan apakah file bersama dilarang untuk diunduh. | |
disable_preview | boolean | Menunjukkan apakah file bersama dilarang untuk dipratinjau. | |
disable_save | boolean | Menunjukkan apakah file bersama dilarang untuk disimpan. | |
enable_upload | boolean | Menunjukkan apakah file bersama diizinkan untuk diunggah. | |
expiration | Date | Waktu kedaluwarsa tautan berbagi. | |
preview_limit | number | Jumlah maksimum kali file bersama dapat dipratinjau. | |
require_login | boolean | Menunjukkan apakah login diperlukan untuk melihat file bersama. | |
save_download_limit | number | Jumlah maksimum kali file bersama dapat disimpan atau diunduh. | |
share_name | string | Nama tautan berbagi. | |
updated_at | string | Waktu terakhir pembaruan tautan berbagi. |
Metode getShareToken
Anda dapat memanggil metode ini untuk menanyakan token berbagi secara anonim tanpa menggunakan token.
Apa itu token berbagi?
Token berbagi adalah token sementara yang dapat digunakan untuk memanggil operasi API tertentu seperti listFiles sebagai pengganti token akses. Ini memungkinkan pengguna untuk melihat pratinjau file bersama tanpa perlu masuk ke klien.
const result = await client.getShareToken(params, options)Contoh
const domain_id = 'ID domain Anda'
const client = new PDSClient({
api_endpoint: `https://${domain_id}.api.aliyunpds.com`
})
try {
let info = client.getShareToken({
share_id: 'xxxxxx',
// share_pwd: 'Kode akses' // Jika kode akses ditentukan, masukkan kode akses.
})
}catch(e){
// Jika kode akses diperlukan tetapi tidak ada kode akses yang ditentukan, kesalahan dilaporkan.
if (e.code == 'InvalidResource.SharePwd'){
// Kode akses diperlukan.
}
}Parameter permintaan
Parameter | Tipe | Diperlukan | Deskripsi |
params | Object | Ya | Parameter yang digunakan untuk menanyakan token berbagi. |
options | IPDSRequestConfig | Parameter permintaan lainnya. |
params
Parameter | Tipe | Diperlukan | Deskripsi |
share_id | string | Ya | ID berbagi. |
share_pwd | string | Kode akses. |
Parameter respons
Parameter | Tipe | Diperlukan | Deskripsi |
result | IShareToken | Ya | Hasil yang dikembalikan. |
IShareToken
Parameter | Tipe | Diperlukan | Deskripsi |
share_token | string | Ya | Token berbagi. |
expire_time | string | Ya | Waktu kedaluwarsa token berbagi. |
expires_in | string | Ya | Periode validitas token berbagi. Unit: detik. |
Menggunakan token berbagi
Kode contoh berikut menggunakan token berbagi untuk menanyakan daftar file bersama.
const share_token = 'Token berbagi yang Anda tanyakan'
const share_id = 'ID berbagi Anda'
const domain_id = 'ID domain Anda'
const client = new PDSClient({
api_endpoint: `https://${domain_id}.api.aliyunpds.com`,
share_token,
})
let {items=[], next_marker} = client.listFiles({
share_id,
parent_file_id: 'root'
},
/*
{
headers: {
'x-share-token': share_token
}
} */
)