Règles et statistiques

Règles

Les règles définissent des valeurs par défaut et des limites pour tous les objets sous un préfixe : visibilité, expiration, taille maximale, extensions autorisées, cache et suppression automatique. Elles s’appliquent à chaque envoi sous le préfixe, qu’il provienne du SDK, d’un jeton d’envoi ou du tableau de bord. Voir Modifier les paramètres pour les limites des plans et la correspondance des préfixes.

`rules.get()`

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

Renvoie les règles enregistrées sous forme de tableau. Chaque règle contient les champs ci-dessous, plus created_at, et active_from lorsqu’elle a delete_after_days.

active_from est optionnel : l’API ne l’envoie que pour les règles avec delete_after_days. En TypeScript, gérez le cas où il vaut 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() remplace la liste entière. Envoyez toutes les règles que vous souhaitez conserver ; rules.set([]) les supprime toutes. Pour ajouter une règle, lisez d’abord la liste :

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

Elle renvoie la liste enregistrée, comme rules.get().

Champ	Type	Description
`prefix`	`string`	Requis. Le préfixe auquel la règle s’applique, par ex. `"a/b/"`.
`private`	`boolean`	Visibilité par défaut.
`expire`	`string`	Expiration par défaut (`"30d"`, `"168h"`, …).
`max_size`	`number`	Taille maximale de fichier en octets, de 512 B à 10 GiB.
`extensions`	`string[]`	De 1 à 50 extensions autorisées, correspondant à `^[a-z0-9]{1,16}(\.[a-z0-9]{1,16})?$`.
`cache_control`	`string`	`Cache-Control` par défaut.
`delete_after_days`	`number`	Supprime les objets ce nombre de jours après leur écriture, de 7 à 3650 (Enterprise à partir de 1).

delete_after_days ne prend effet que 24 heures après l’enregistrement de la règle (voir active_from). Une fois active, les objets supprimés ne peuvent pas être récupérés.

Lorsqu’une règle est rejetée, l’extra de l’erreur contient le prefix fautif :

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() est une lecture et fait l’objet de nouvelles tentatives. rules.set() a droit à une seule tentative.

Statistiques

const stats = await blob.stats();

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

Champ	Description
`usage.objects`	Nombre d’objets.
`usage.storage`	Stockage utilisé, en octets.
`plan.included`	Stockage inclus dans votre plan, en octets.
`billing`	`extraStorage`, `storagePrice`, `objectsPrice`, `totalEstimate`.
`month`	`days` et `average_storage` pour le mois en cours.

Les statistiques sont une estimation, mise en cache par le serveur pendant 60 secondes. billing n’est qu’une estimation du stockage au-delà de votre plan, pas une facture.

Voir Statistiques du compte.

Services

Runtimes

Plateforme

Dépannage

CLI

SDKs

Changelog

Règles et statistiques

Règles

`rules.get()`

`rules.set(rules)`

Statistiques

​Règles

​rules.get()

​rules.set(rules)

​Statistiques

Règles

`rules.get()`

`rules.set(rules)`

Statistiques