SDK と API でドライブを作成・照会・削除 - Drive and Photo Service

このトピックでは、ドライブとフォトサービスのドライブで実行できる操作（ドライブの作成、更新、読み取り、削除など）について説明します。また、ドライブとフォトサービスのSDKメソッドを呼び出す方法についても一連の例を挙げて説明します。

説明

IPDSRequestConfig型のoptionsパラメーターは、axiosの要求設定オプションに基づいてカプセル化されています。詳細については、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	はい	ドライブの作成に使用するパラメーター。
options	IPDSRequestConfig		その他のリクエストパラメーター。

ICreateDriveReqパラメーター

パラメーター	タイプ	必須	説明
default	boolean		ドライブをデフォルトドライブとして設定するかどうかを指定します。このパラメーターは、標準モードでのみ有効です。各ユーザーは1つのデフォルトドライブのみ設定できます。デフォルト値：`false`。
drive_name	string	はい	ドライブ名。
owner	string	はい	ドライブを所有する`user`または`group`のID。
owner_type	string		ドライブ所有者のタイプ。有効な値：`group`と`user`。デフォルト値：`user`。
description	string		説明。
total_size	number	はい	ドライブの合計ストレージサイズ。単位：`bytes`。値-1は、ドライブのストレージサイズに制限がないことを指定します。

レスポンスパラメーター

パラメーター	タイプ	必須	説明
result	ICreateDriveRes	はい	ドライブが作成された場合に返されるメッセージ。

ICreateDriveResパラメーター

パラメーター	タイプ	必須	説明
drive_id	string	はい	ドライブID。
domain_id	string	はい	ドメインID。

updateDriveメソッド

ドライブに関する情報を更新します。

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

リクエストパラメーター

パラメーター	タイプ	必須	説明
params	IUpdateDriveReq	はい	ドライブに関する情報の更新に使用するパラメーター。
options	IPDSRequestConfig		その他のリクエストパラメーター。

IUpdateDriveReqパラメーター

パラメーター	タイプ	必須	説明
drive_id	string	はい	更新するドライブのID。
description	string		ドライブの説明。
total_size	string		更新するドライブの合計サイズ。単位：`bytes`。値-1は、ドライブのストレージサイズに制限がないことを指定します。
drive_name	string		ドライブ名。
status	string		ドライブの状態。有効な値：enabledと`disabled`。デフォルト値：`enabled`。

レスポンスパラメーター

パラメーター	タイプ	必須	説明
result	IDriveItem	はい	ドライブの更新された情報。

IDriveItemパラメーター

パラメーター	タイプ	必須	説明
drive_id	string	はい	ドライブID。
domain_id	string	はい	ドライブが属するドメインのID。
creator	string	はい	ドライブを作成したユーザーのID。
drive_name	string	はい	ドライブ名。
owner_type	string	はい	ドライブ所有者のタイプ。有効な値：`group`と`user`。
drive_type	string	はい	ドライブのタイプ。有効な値：`normal`と`large`。
owner	string	はい	ドライブを所有する`user`または`group`のID。
status	string	はい	ドライブの状態。有効な値：enabledと`disabled`。
total_size	number	はい	ドライブの合計サイズ。単位：`bytes`。
used_size	number	はい	使用されているサイズ。単位：`bytes`。
description	string	はい	ドライブの説明。
created_at	Date	はい	ドライブが作成された日時。
subdomain_id	string		サブドメインID。このパラメーターは、ドメインにサブドメインがある場合にのみ使用できます。

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`または`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		次のページを取得するために使用されるマーカー。