ルールと統計

ルール

ルールは、プレフィックス配下のすべてのオブジェクトに対するデフォルト値と制限を設定します: 公開範囲、有効期限、最大サイズ、許可する拡張子、キャッシュ、自動削除。SDK、アップロードトークン、ダッシュボードのいずれからのアップロードであっても、プレフィックス配下のすべてのアップロードに適用されます。プランの制限とマッチングについては、Blob 設定の更新を参照してください。

`rules.get()`

const rules = await blob.rules.get();

保存されているルールを配列で返します。各ルールには以下のフィールドに加えて created_at があり、delete_after_days を持つ場合は active_from もあります。

active_from はオプションです。API は delete_after_days を持つルールに対してのみ送信します。TypeScript では undefined の場合を処理してください。

`rules.set(rules)`

await blob.rules.set([
    { prefix: "tmp/", delete_after_days: 7 },
    { prefix: "avatars/", max_size: 5 * 1024 * 1024, extensions: ["png", "jpg"] },
]);

rules.set() はリスト全体を置き換えます。残したいルールはすべて送信してください。rules.set([]) はすべてのルールを削除します。ルールを 1 つ追加するには、まずリストを取得します:

const current = await blob.rules.get();
await blob.rules.set([
    ...current.map(({ created_at, active_from, ...rule }) => rule),
    { prefix: "exports/", expire: "30d" },
]);

rules.get() と同様に、保存されたリストを返します。

フィールド	型	説明
`prefix`	`string`	必須。ルールを適用するプレフィックス (例: `"a/b/"`)。
`private`	`boolean`	デフォルトの公開範囲。
`expire`	`string`	デフォルトの有効期限 (`"30d"`、`"168h"` など)。
`max_size`	`number`	最大ファイルサイズ (バイト)。512 B〜10 GiB。
`extensions`	`string[]`	許可する拡張子 1〜50 個。`^[a-z0-9]{1,16}(\.[a-z0-9]{1,16})?$` に一致する必要があります。
`cache_control`	`string`	デフォルトの `Cache-Control`。
`delete_after_days`	`number`	オブジェクトが書き込まれてからこの日数が経過すると削除します。7〜3650 (Enterprise は 1 から)。

delete_after_days が有効になるのは、ルールが保存されてから 24 時間後です (active_from を参照)。一度有効になると、削除されたオブジェクトは復元できません。

ルールが拒否された場合、エラーの extra に問題のある prefix が含まれます:

import { SquareCloudBlobError } from "@squarecloud/blob";

try {
    await blob.rules.set(rules);
} catch (error) {
    if (error instanceof SquareCloudBlobError) {
        console.error(error.code, error.extra.prefix);
    }
}

rules.get() は読み取りなのでリトライされます。rules.set() は 1 回のみ試行されます。

統計

const stats = await blob.stats();

console.log(stats.usage.objects); // total objects
console.log(stats.usage.storage); // storage used, in bytes

フィールド	説明
`usage.objects`	オブジェクト数。
`usage.storage`	使用中のストレージ (バイト)。
`plan.included`	プランに含まれるストレージ (バイト)。
`billing`	`extraStorage`、`storagePrice`、`objectsPrice`、`totalEstimate`。
`month`	当月の `days` と `average_storage`。

統計は推定値で、サーバーによって 60 秒間キャッシュされます。billing はプランを超えるストレージの推定値にすぎず、請求書ではありません。

Blob アカウント統計を参照してください。

サービス

Runtimes

プラットフォーム

トラブルシューティング

CLI

SDKs

Changelog

ルール

`rules.get()`

`rules.set(rules)`

統計

​ルール

​rules.get()

​rules.set(rules)

​統計

ルール

`rules.get()`

`rules.set(rules)`

統計