Get Bucket
const url = 'https://example.com/storage/v1/workspaces/example/engines/example/buckets/example';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/buckets/exampleReturns a bucket by unique ID. Use - to look it up regardless of provider.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”The workspace the bucket belongs to
The cloud provider: qibdo, aws, gcp, or azure, or ’-’ to look up across all providers
The unique identifier of the bucket to retrieve
Responses
Section titled “ Responses ”OK
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–26 chars, lowercase alphanumeric and hyphens only). Must match ^[a-z0-9][a-z0-9-]{1,24}[a-z0-9]$; the 26-char limit derives from the 63-char S3 bucket name limit minus the 37-char {workspaceId}- prefix (UUID = 36 chars + separator).
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
Weak reference to a topology Location: the region where the bucket’s data resides. A shared concept across providers, so it lives at the top level rather than in a provider-specific arm.
The default storage tier for objects written to this bucket, as EITHER the tier’s platform identifier OR its handle — one field, resolved by shape, so a caller never has to know which form the catalogue keeps. Optional; when omitted the bucket inherits the provider’s default tier. A value the catalogue does not hold is refused by name.
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 three-letter currency code defined in ISO 4217.
The whole units of the amount.
For example if currencyCode is "USD", then 1 unit is one US dollar.
Number of nano (10^-9) units of the amount.
The value must be between -999,999,999 and +999,999,999 inclusive.
If units is positive, nanos must be positive or zero.
If units is zero, nanos can be positive, zero, or negative.
If units is negative, nanos must be negative or zero.
For example $-1.75 is represented as units=-1 and nanos=-750,000,000.
Forecast cost for the full billing month. Absent when no projection is available.
object
The three-letter currency code defined in ISO 4217.
The whole units of the amount.
For example if currencyCode is "USD", then 1 unit is one US dollar.
Number of nano (10^-9) units of the amount.
The value must be between -999,999,999 and +999,999,999 inclusive.
If units is positive, nanos must be positive or zero.
If units is zero, nanos can be positive, zero, or negative.
If units is negative, nanos must be negative or zero.
For example $-1.75 is represented as units=-1 and nanos=-750,000,000.
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.
Example
{ "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" } ]}