List Buckets
const url = 'https://example.com/storage/v1/workspaces/example/engines/example/buckets';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/storage/v1/workspaces/example/engines/example/bucketsReturns a paginated list of buckets within a workspace. A specific provider filters to that
provider; - lists buckets across all providers.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”The workspace to list buckets for
The cloud provider: qibdo, aws, gcp, or azure, or ’-’ to list across all providers
Query Parameters
Section titled “Query Parameters ”The maximum number of buckets to return. The service may return fewer than this value. If unspecified, at most 20 buckets will be returned. The maximum value is 100; values above 100 will be coerced to 100.
A page token, received from a previous ListBuckets call. Provide this to retrieve the
subsequent page. When paginating, all other parameters must match the call that provided
the page token.
AIP-160 filter expression.
Partial matches (:, a quoted wildcard, contains/startsWith/endsWith) ignore capitalisation; = and the relational operators are exact.
Filterable fields: cost.month_projection, cost.month_to_date, cost.month_to_date.currency_code, create_time, default_storage_class.id, default_storage_class.name, description, display_name, engine, id, location.id, location.name, name, object_count, reconcile_state, reconcile_time, size_bytes, update_time, versioning, workspace_id.
AIP-132 order_by expression. Sortable fields: cost.month_to_date, create_time, default_storage_class.name, display_name, engine, location.name, name, object_count, reconcile_state, size_bytes, update_time, versioning.
AIP-158 offset mode: number of resources to skip from the start of the filtered, sorted set. Use EITHER skip (offset paging) OR page_token (cursor paging) — never both in the same request. Supplying both is an invalid request. Default 0 (no skip).
Responses
Section titled “ Responses ”OK
ListBucketsResponse
Response message for ListBuckets.
object
The list of buckets
A bucket is a workspace-scoped container that holds a set of stored objects.
Buckets can be provisioned across different cloud providers; the provider a bucket
lives on is reported by the read-only engine field.
object
The unique identifier of the bucket
The workspace this bucket belongs to
The bucket name (3–63 characters). It uses lowercase letters, digits, and hyphens within dot-separated labels, and must not be an IPv4 address.
A human-readable label for the bucket, e.g. “Production build artifacts”. Free text in any script. Never used to address the bucket. Optional; defaults to the handle (name) when omitted.
An optional human-readable description of the bucket
The region where the bucket’s data resides.
object
The referenced resource’s server-assigned identifier.
The referenced resource’s handle: the name a person reads and types.
The default storage tier for objects written to this bucket. Leave the reference empty and the bucket inherits the provider’s default tier.
object
The referenced resource’s server-assigned identifier.
The referenced resource’s handle: the name a person reads and types.
The cloud provider this bucket is provisioned on.
Timestamp when the bucket was created
Timestamp when the bucket was last updated
Attributes specific to a Qibdo-managed bucket.
object
Total size of the objects stored in this bucket, in bytes. Reported by the
storage backend and refreshed periodically, not on every read. Zero until
first measured; see reconcile_state.
Number of objects stored in this bucket. Zero until first measured; see
reconcile_state.
Cost attributed to this bucket. Zero where the bucket incurs no metered charge.
object
Cost accrued from the start of the current billing month until now.
object
The exact amount in major units, as a decimal string, for example 12.34, 100 or -0.05.
Up to 19 digits before the decimal point and up to 8 after it. Trailing zeros are removed, so
12.3400 is sent as 12.34. Some amounts are stored with fewer decimals than 8 and are
rounded when they are saved, so a value read back may be shorter than the one sent in.
The ISO-4217 currency code in uppercase, for example USD.
Forecast cost for the whole billing month. Left unset when there is no forecast yet, so that “we do not know” is never reported as a cost of zero.
object
The exact amount in major units, as a decimal string, for example 12.34, 100 or -0.05.
Up to 19 digits before the decimal point and up to 8 after it. Trailing zeros are removed, so
12.3400 is sent as 12.34. Some amounts are stored with fewer decimals than 8 and are
rounded when they are saved, so a value read back may be shorter than the one sent in.
The ISO-4217 currency code in uppercase, for example USD.
Whether the usage and cost figures reported on this bucket have been measured, and whether the most recent measurement succeeded.
Timestamp of the most recent successful measurement of the usage and cost figures. Absent until the bucket has been measured at least once.
Whether this bucket keeps earlier copies of an overwritten object, in the three states every provider distinguishes. Shared across providers, so it lives at the top level.
SUSPENDED is not “off”: it stops new versions being created while keeping every version already written, and those keep costing storage. Collapsing it into a boolean is what makes a bill inexplicable.
A token, which can be sent as page_token to retrieve the next page. If this field is
empty, there are no subsequent pages.
Exact count of resources matching the request’s filter and scope (both pagination modes).
Example
{ "buckets": [ { "engine": "ENGINE_UNSPECIFIED", "reconcile_state": "BUCKET_RECONCILE_STATE_UNSPECIFIED", "versioning": "BUCKET_VERSIONING_UNSPECIFIED" } ]}default
Section titled “default ”Default error response
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.
object
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
A list of messages that carry the error details. There is a common set of message types for APIs to use.
Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
object
The type of the serialized message.
Example generated
{ "code": 1, "message": "example", "details": [ { "@type": "example" } ]}