All Products
Search

This Product

    Drive and Photo Service:Drive

    Document Center

    Drive and Photo Service:Drive

    Last Updated:Dec 22, 2025

    Topik ini menjelaskan operasi yang dapat dilakukan pada drive dari Drive and Photo Service (PDS), seperti membuat, memperbarui, membaca, dan menghapus drive. Topik ini juga menyediakan contoh cara memanggil metode SDK dari PDS.

    Catatan

    Parameter options dengan tipe IPDSRequestConfig dienkapsulasi berdasarkan opsi konfigurasi permintaan axios. Untuk informasi lebih lanjut, lihat AxiosRequestConfig.

    Metode getQuota

    Memeriksa ruang tersisa.

    const result = await client.getQuota(options)

    Contoh

    const {
  size_quota, 
  size_used, 
  user_count_quota, 
  user_count_used 
} = await client.getQuota()

    Parameter permintaan

    Parameter

    Tipe

    Diperlukan

    Deskripsi

    options

    IPDSRequestConfig

    Parameter permintaan lainnya.

    Parameter respons

    Parameter

    Tipe

    Diperlukan

    Deskripsi

    result

    IQuotaRes

    Hasil yang dikembalikan.

    Parameter IQuotaRes

    Parameter

    Tipe

    Deskripsi

    size_quota

    number

    Total ruang yang dibeli.

    size_used

    number

    Ruang yang digunakan.

    user_count_quota

    number

    Total jumlah pengguna yang dapat menggunakan drive ini.

    user_count_used

    number

    Jumlah pengguna saat ini.

    Metode createDrive

    Membuat drive baru.

    const result = await client.createDrive(params, options)

    Contoh

    const { drive_id } = await client.createDrive({
  drive_name: 'my_drive', // Nama drive.
  owner: 'xxxxx', // ID pengguna.
})

    Parameter permintaan

    Parameter

    Tipe

    Diperlukan

    Deskripsi

    params

    ICreateDriveReq

    Ya

    Parameter yang digunakan untuk membuat drive.

    options

    IPDSRequestConfig

    Parameter permintaan lainnya.

    Parameter ICreateDriveReq

    Parameter

    Tipe

    Diperlukan

    Deskripsi

    default

    boolean

    Menentukan apakah akan menyetel drive sebagai drive default. Parameter ini hanya berlaku dalam mode standar. Setiap pengguna hanya dapat menyetel satu drive default. Nilai default: false.

    drive_name

    string

    Ya

    Nama drive.

    owner

    string

    Ya

    ID user atau group yang memiliki drive.

    owner_type

    string

    Tipe pemilik drive. Nilai valid: group dan user. Nilai default: user.

    description

    string

    Deskripsi.

    total_size

    number

    Ya

    Total ukuran penyimpanan drive. Unit: bytes. Nilai -1 menentukan bahwa ukuran penyimpanan drive tidak terbatas.

    Parameter respons

    Parameter

    Tipe

    Diperlukan

    Deskripsi

    result

    ICreateDriveRes

    Ya

    Pesan yang dikembalikan jika drive berhasil dibuat.

    Parameter ICreateDriveRes

    Parameter

    Tipe

    Diperlukan

    Deskripsi

    drive_id

    string

    Ya

    ID drive.

    domain_id

    string

    Ya

    ID domain.

    Metode updateDrive

    Memperbarui informasi tentang drive.

    const result = await client.updateDrive(params, options)

    Parameter permintaan

    Parameter

    Tipe

    Diperlukan

    Deskripsi

    params

    IUpdateDriveReq

    Ya

    Parameter yang digunakan untuk memperbarui informasi tentang drive.

    options

    IPDSRequestConfig

    Parameter permintaan lainnya.

    Parameter IUpdateDriveReq

    Parameter

    Tipe

    Diperlukan

    Deskripsi

    drive_id

    string

    Ya

    ID drive yang akan diperbarui.

    description

    string

    Deskripsi drive.

    total_size

    string

    Total ukuran drive yang akan diperbarui. Unit: bytes. Nilai -1 menentukan bahwa ukuran penyimpanan drive tidak terbatas.

    drive_name

    string

    Nama drive.

    status

    string

    Status drive. Nilai valid: enabled and disabled.

    Nilai default: enabled.

    Parameter respons

    Parameter

    Tipe

    Diperlukan

    Deskripsi

    result

    IDriveItem

    Ya

    Informasi drive yang telah diperbarui.

    Parameter IDriveItem

    Parameter

    Tipe

    Diperlukan

    Deskripsi

    drive_id

    string

    Ya

    Identifikasi drive ID.

    domain_id

    string

    Ya

    ID domain tempat drive tersebut berada.

    creator

    string

    Ya

    ID pengguna yang membuat drive.

    drive_name

    string

    Ya

    Nama drive.

    owner_type

    string

    Ya

    Tipe pemilik drive. Nilai valid: group dan user.

    drive_type

    string

    Ya

    Tipe drive. Nilai valid: normal dan large.

    owner

    string

    Ya

    ID user atau group yang memiliki drive.

    status

    string

    Ya

    Status drive. Nilai valid: enabled and disabled.

    total_size

    number

    Ya

    Total ukuran drive. Unit: bytes.

    used_size

    number

    Ya

    Ukuran yang digunakan. Unit: bytes.

    description

    string

    Ya

    Deskripsi drive.

    created_at

    Date

    Ya

    Waktu pembuatan drive.

    subdomain_id

    string

    ID subdomain. Parameter ini tersedia hanya jika domain memiliki subdomain.

    Metode deleteDrive

    Menghapus drive.

    await client.deleteDrive(params, options)

    Parameter permintaan

    Parameter

    Tipe

    Diperlukan

    Deskripsi

    params

    object

    Ya

    ID dari drive yang akan dihapus. Contoh: { drive_id: '123' }.

    options

    IPDSRequestConfig

    Tidak

    Parameter permintaan lainnya.

    Parameter params

    Parameter

    Tipe

    Diperlukan

    Deskripsi

    drive_id

    string

    Ya

    ID dari drive yang akan dihapus.

    Parameter respons

    Jika drive berhasil dihapus, tidak ada nilai yang dikembalikan. Jika drive gagal dihapus, pengecualian akan dilemparkan. Anda dapat menganalisis penyebabnya berdasarkan informasi pengecualian.

    Metode getDrive

    Memeriksa detail drive menggunakan ID drive.

    const result = await client.getDrive(params, options)

    Contoh

    const drive_id = '123'
const result = await client.getDrive({drive_id})

assert(result.drive_id==drive_id) // true

    Parameter permintaan

    Parameter

    Tipe

    Diperlukan

    Deskripsi

    params

    object

    Ya

    ID dari drive yang ingin Anda kueri. Contoh: { drive_id: '123' }.

    options

    IPDSRequestConfig

    Parameter permintaan lainnya.

    Parameter respons

    Parameter

    Tipe

    Diperlukan

    Deskripsi

    result

    IDriveItem

    Ya

    Hasil yang dikembalikan.

    Metode searchDrives

    Memeriksa informasi drive menggunakan bidang tertentu dalam mode fuzzy.

    const result = await client.searchDrives(params, options)

    Parameter permintaan

    Parameter

    Tipe

    Diperlukan

    Deskripsi

    params

    ISearchDrivesReq

    Parameter yang digunakan untuk memeriksa informasi drive. Nilai default: {}.

    options

    IPDSRequestConfig

    Parameter permintaan lainnya.

    Parameter ISearchDriveReq

    Parameter

    Tipe

    Diperlukan

    Deskripsi

    drive_name

    string

    Nama drive.

    limit

    number

    Jumlah maksimum entri yang akan dikembalikan. Nilai valid: 1 hingga 100. Nilai default: 100.

    marker

    string

    Penanda awal dari kueri.

    owner_type

    string

    Tipe pemilik drive. Nilai valid: group dan user.

    Parameter respons

    Parameter

    Tipe

    Diperlukan

    Deskripsi

    result

    IListRes

    Ya

    Hasil yang dikembalikan.

    Parameter IListRes

    Parameter

    Tipe

    Diperlukan

    Deskripsi

    items

    IDriveItemRes[]

    Ya

    Informasi drive yang ditemukan.

    next_marker

    string

    Penanda yang digunakan untuk mengambil halaman berikutnya.

    Metode listDrives

    Memeriksa daftar drive milik pengguna.

    const result = await client.listDrives(params, options)

    Parameter permintaan

    Parameter

    Tipe

    Diperlukan

    Deskripsi

    params

    IListDrivesReq

    Parameter yang digunakan untuk memeriksa drive. Jika Anda tidak menentukan parameter ini, nilai default {} digunakan.

    options

    IPDSRequestConfig

    Parameter permintaan lainnya.

    Parameter IListDrivesReq

    Parameter

    Tipe

    Diperlukan

    Deskripsi

    limit

    string

    Jumlah maksimum entri yang akan dikembalikan. Nilai valid: 1 hingga 100. Nilai default: 100.

    marker

    string

    Penanda awal dari kueri.

    owner_type

    string

    Tipe pemilik drive. Rentang nilai group dan user.

    owner

    string

    ID group atau user yang memiliki drive.

    Parameter respons

    Parameter

    Tipe

    Diperlukan

    Deskripsi

    result

    IListRes

    Ya

    Hasil yang dikembalikan.

    Parameter IListRes

    Parameter

    Tipe

    Diperlukan

    Deskripsi

    items

    IDriveItemRes[]

    Ya

    Informasi drive yang ditemukan. Untuk informasi tentang bidang parameter items, lihat IDriveItemRes.

    next_marker

    string

    Penanda yang digunakan untuk mengambil halaman berikutnya.

    Metode listMyDrives

    Memeriksa daftar drive milik pengguna saat ini.

    const result = await client.listMyDrives(params, options)

    Parameter permintaan

    Parameter

    Tipe

    Diperlukan

    Deskripsi

    params

    object

    Parameter yang digunakan untuk memeriksa drive. Jika Anda tidak menentukan parameter ini, nilai default {} digunakan.

    options

    IPDSRequestConfig

    Parameter permintaan lainnya.

    Parameter params

    Parameter

    Tipe

    Diperlukan

    Deskripsi

    limit

    string

    Jumlah maksimum entri yang akan dikembalikan. Nilai valid: 1 hingga 100. Nilai default: 100.

    marker

    string

    Penanda awal dari kueri.

    Parameter respons

    Parameter

    Tipe

    Diperlukan

    Deskripsi

    result

    IListRes

    Ya

    Hasil yang dikembalikan.

    Parameter IListRes

    Parameter

    Tipe

    Diperlukan

    Deskripsi

    items

    IDriveItemRes[]

    Ya

    Informasi drive yang ditemukan.

    next_marker

    string

    Penanda yang digunakan untuk mengambil halaman berikutnya.

    Metode listMyGroupDrives

    Memeriksa informasi drive dari grup tempat pengguna saat ini berada.

    const result = await client.listMyGroupDrives(params, options)

    Parameter permintaan

    Parameter

    Tipe

    Diperlukan

    Deskripsi

    params

    IListReq

    Parameter yang digunakan untuk memeriksa informasi drive. Jika Anda tidak menentukan parameter ini, nilai default {} digunakan.

    options

    IPDSRequestConfig

    Parameter permintaan lainnya.

    Parameter IListReq

    Parameter

    Tipe

    Diperlukan

    Deskripsi

    limit

    string

    Jumlah maksimum entri yang akan dikembalikan. Nilai valid: 1 hingga 100. Nilai default: 100.

    marker

    string

    Penanda awal dari kueri.

    Parameter respons

    Parameter

    Tipe

    Diperlukan

    Deskripsi

    result

    IListRes

    Ya

    Hasil yang dikembalikan.

    IListRes parameters

    Parameter

    Tipe

    Diperlukan

    Deskripsi

    items

    IDriveItemRes[]

    Ya

    Informasi drive yang ditemukan.

    next_marker

    string

    Penanda yang digunakan untuk mengambil halaman berikutnya.