雲端硬碟 - Drive and Photo Service

提供雲端硬碟的 CURD 操作和其它一些方法。

說明

請求參數中的 options: IPDSRequestConfig 基於 axios 的 request config 封裝，詳情請看：AxiosRequestConfig。

getQuota 方法

（企業版，空間有限時）可以通過此介面擷取剩餘空間。

const result = await client.getQuota(options)

舉例

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

參數說明

欄位	類型	必選	說明
options	IPDSRequestConfig		其它配置項。

欄位	類型	必選	說明
result	IQuotaRes		返回結果。

IQuotaRes

欄位	類型	說明
size_quota	number	購買的總空間。
size_used	number	已使用的空間。
user_count_quota	number	購買的總使用者數。
user_count_used	number	已有使用者數。

createDrive 方法

建立雲端硬碟。

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

舉例

const { drive_id } = await client.createDrive({
  drive_name: 'my_drive', // 雲端硬碟名稱
  owner: 'xxxxx',         // 使用者ID
})

參數說明

欄位	類型	必選	說明
params	ICreateDriveReq	是	建立 drive 的參數。
options	IPDSRequestConfig		其它配置項。

ICreateDriveReq

欄位	類型	必選	說明
default	boolean		（僅標準模式有效）是否設定為預設drive。一個使用者只允許設定一個預設drive。預設：`false`。
drive_name	string	是	雲端硬碟名稱。
owner	string	是	雲端硬碟所屬的 `user_id` 或 `group_id`。
owner_type	string		可選值為：`group`, `user`。預設：`user`。
description	string		描述資訊。
total_size	number	是	雲端硬碟大小, 單位 `Byte`。如果設定 -1 代表不限制大小。

傳回值

欄位	類型	必選	說明
result	ICreateDriveRes	是	建立成功的返回資訊。

ICreateDriveRes

欄位	類型	必選	說明
drive_id	string	是	雲端硬碟ID。
domain_id	string	是	Domain ID。

updateDrive 方法

更新雲端硬碟資訊。

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

參數說明

欄位	類型	必選	說明
params	IUpdateDriveReq	是	更新 drive 傳遞的參數。
options	IPDSRequestConfig		其它配置項。

IUpdateDriveReq

欄位	類型	必選	說明
drive_id	string	是	要更新的 drive 的 ID。
description	string		描述。
total_size	string		更新雲端硬碟大小, 單位 `Byte`。如果設定 -1 代表不限制大小。
drive_name	string		雲端硬碟名稱。
status	string		雲端硬碟狀態，取值：`enabled, disabled` 預設：`enabled`。

傳回值

欄位	類型	必選	說明
result	IDriveItem	是	更新之後的 drive 資訊。

IDriveItem

欄位	類型	必選	說明
drive_id	string	是	雲端硬碟 ID。
domain_id	string	是	所屬domain ID。
creator	string	是	建立人user_id。
drive_name	string	是	雲端硬碟名稱。
owner_type	string	是	值為 `group` , `user`。
drive_type	string	是	雲端硬碟類型，取值為 `normal`, `large`。
owner	string	是	所屬 `user_id` 或者`group_id`。
status	string	是	雲端硬碟狀態。取值：`enabled, disabled`。
total_size	number	是	總大小，單位：`Byte`。
used_size	number	是	已使用大小，單位：`Byte`。
description	string	是	描述。
created_at	Date	是	建立時間。
subdomain_id	string		Subdomain 的 ID。開通Subdomain的 Domain才有。

deleteDrive 方法

刪除雲端硬碟。

await client.deleteDrive(params, options)

參數說明

欄位	類型	必選	說明
params	object	是	要刪除的雲端硬碟的 ID，例如 `{ drive_id: '123' }`。
options	IPDSRequestConfig	否	其它配置項。

params

欄位	類型	必選	說明
drive_id	string	是	要刪除的雲端硬碟的 ID。

傳回值

刪除成功沒有傳回值，如果刪除失敗會拋出異常，可根據異常資訊具體分析原因。

getDrive 方法

根據云盤ID 查詢該雲端硬碟的詳細資料。

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

舉例

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

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

參數說明

欄位	類型	必選	說明
params	object	是	要查詢的雲端硬碟的 ID，例如 `{ drive_id: '123' }`。
options	IPDSRequestConfig		其它配置項。

欄位	類型	必選	說明
result	IDriveItem	是	返回雲端硬碟資訊。

searchDrives 方法

根據特定欄位來查詢雲端硬碟資訊（模糊搜尋）。

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

參數說明

欄位	類型	必選	說明
params	ISearchDrivesReq		查詢參數，預設為 {}。
options	IPDSRequestConfig		其它配置項。

ISearchDriveReq

欄位	類型	必選	說明
drive_name	string		根據云盤名稱查詢。
limit	number		返回資料最大條數,範圍：[1-100]，預設：100。
marker	string		查詢開始標記。
owner_type	string		取值範圍：`group`, `user`。

傳回值

欄位	類型	必選	說明
result	IListRes	是	結果。

IListRes

欄位	類型	必選	說明
items	IDriveItemRes[]	是	查詢到的雲端硬碟資訊列表。
next_marker	string		下一頁查詢標記。

listDrives 方法

擷取使用者雲端硬碟列表。

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

參數說明

欄位	類型	必選	說明
params	IListDrivesReq		查詢參數，不傳預設為 {}。
options	IPDSRequestConfig		其它配置項。

IListDrivesReq

欄位	類型	必選	說明
limit	string		返回資料最大條數,範圍：[1-100]，預設：100。
marker	string		查詢開始標記。
owner_type	string		取值範圍 `group`, `user`。
owner	string		`group_id` 或者 `user_id`。

傳回值

欄位	類型	必選	說明
result	IListRes	是	結果

IListRes

欄位	類型	必選	說明
items	IDriveItemRes[]	是	查詢到的雲端硬碟資訊列表，`items` 中每一項的具體欄位可參考 `IDriveItemRes`。
next_marker	string		下一頁查詢標記。

listMyDrives 方法

擷取目前使用者的雲端硬碟列表。

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

參數說明

欄位	類型	必選	說明
params	object		查詢參數，不傳預設為 {}。
options	IPDSRequestConfig		其它配置項。

params

欄位	類型	必選	說明
limit	string		返回資料最大條數,範圍：[1-100]，預設：100。
marker	string		查詢開始標記。

傳回值

欄位	類型	必選	說明
result	IListRes	是	結果。

IListRes

欄位	類型	必選	說明
items	IDriveItemRes[]	是	查詢到的雲端硬碟資訊列表。
next_marker	string		下一頁查詢標記。

listMyGroupDrives 方法

擷取目前使用者所在的組織雲端硬碟資訊。

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

參數說明

欄位	類型	必選	說明
params	IListReq		查詢參數，不傳預設為 {}。
options	IPDSRequestConfig		其它配置項。

IListReq

欄位	類型	必選	說明
limit	string		返回資料最大條數,範圍：[1-100]，預設：100。
marker	string		查詢開始標記。

傳回值

欄位	類型	必選	說明
result	IListRes	是	結果。

IListRes

欄位	類型	必選	說明
items	IDriveItemRes[]	是	查詢到的雲端硬碟資訊列表。
next_marker	string		下一頁查詢標記。

getQuota 方法

舉例

參數說明

返回

IQuotaRes

createDrive 方法

舉例

參數說明

ICreateDriveReq

傳回值

ICreateDriveRes

updateDrive 方法

參數說明

IUpdateDriveReq

傳回值

IDriveItem

deleteDrive 方法

參數說明

params

傳回值

getDrive 方法

舉例

參數說明

返回

searchDrives 方法

參數說明

ISearchDriveReq

傳回值

IListRes

listDrives 方法

參數說明

IListDrivesReq

傳回值

IListRes

listMyDrives 方法

參數說明

params

傳回值

IListRes

listMyGroupDrives 方法

參數說明

IListReq

傳回值