Get Storage Class

GET

/storage/v1/engines/{engine}/storage-classes/{id}

curl --request GET \
  --url https://example.com/storage/v1/engines/example/storage-classes/example

Returns a storage class by unique ID. Use - to look it up regardless of provider.

Parameters

Path Parameters

engine

required

string

The cloud provider: qibdo, aws, gcp, or azure, or ’-’ to look up across all providers

id

required

string

The unique identifier of the storage class to retrieve

Responses

200

OK

Media type application/json

object

id

The unique identifier of the storage class

stringOutput only

name

required

The handle of the storage class, e.g. “standard”. Lowercase letters, digits and hyphens; letter-initial; no adjacent hyphens. Unique per engine. Used to address the tier by name or id.

string

display_name

A human-readable label for the storage class, e.g. “Standard”. Free text in any script. Never used to address the tier. Optional; defaults to the handle (name) when omitted.

string

description

An optional human-readable description of the storage class

string

is_default

Whether this is the global default tier for its provider. Buckets that omit a storage class inherit the default. At most one default exists per provider.

boolean

engine

The cloud provider this storage class is provisioned on.

string format: enum Output only

Allowed values: ENGINE_UNSPECIFIED ENGINE_QIBDO ENGINE_AWS ENGINE_GCP ENGINE_AZURE

create_time

Timestamp when the storage class was created

string format: date-time Output only

update_time

Timestamp when the storage class was last updated

string format: date-time Output only

qibdo

Attributes specific to a Qibdo-managed storage class.

object

redundancy

required

The redundancy scheme the tier guarantees (replication factor or erasure-coding profile).

string format: enum

Allowed values: REDUNDANCY_UNSPECIFIED REDUNDANCY_REPLICATED_2 REDUNDANCY_REPLICATED_3 REDUNDANCY_REPLICATED_4 REDUNDANCY_ERASURE_CODED_2_1 REDUNDANCY_ERASURE_CODED_4_2 REDUNDANCY_ERASURE_CODED_6_3 REDUNDANCY_ERASURE_CODED_8_3

performance_class

required

The performance class the tier targets (media tier).

string format: enum

Allowed values: PERFORMANCE_CLASS_UNSPECIFIED PERFORMANCE_CLASS_STANDARD PERFORMANCE_CLASS_FAST_SSD PERFORMANCE_CLASS_FAST_NVME PERFORMANCE_CLASS_ARCHIVE

compression_type

The compression type for data in this storage class (NONE, SNAPPY, ZLIB, ZSTD, LZ4)

string format: enum

Allowed values: COMPRESSION_TYPE_UNSPECIFIED COMPRESSION_TYPE_NONE COMPRESSION_TYPE_SNAPPY COMPRESSION_TYPE_ZLIB COMPRESSION_TYPE_ZSTD COMPRESSION_TYPE_LZ4

availability

The per-region readiness of this tier, computed from its materialization records — one entry per region the tier has been declared in. Lets a client show where the tier is usable and, when it is not, why. Empty for providers with no per-region materialization (only Qibdo has it).

Array<object>Output only

The readiness of a storage class tier in one region, summarised from its materialization record.

object

region_id

The region this entry describes. Weak reference to a topology Location of kind REGION (UUID).

stringOutput only

status

The tier’s provisioning status in this region.

string format: enum Output only

Allowed values: STORAGE_CLASS_INSTANCE_STATUS_UNSPECIFIED STORAGE_CLASS_INSTANCE_STATUS_PENDING STORAGE_CLASS_INSTANCE_STATUS_AVAILABLE STORAGE_CLASS_INSTANCE_STATUS_UNSUPPORTED STORAGE_CLASS_INSTANCE_STATUS_FAILED STORAGE_CLASS_INSTANCE_STATUS_ABANDONED

reason

A short, human-readable explanation of a non-ready status (unsupported / failed / abandoned); empty when the tier is available or still pending.

stringOutput only

Example

{
  "engine": "ENGINE_UNSPECIFIED",
  "qibdo": {
    "redundancy": "REDUNDANCY_UNSPECIFIED",
    "performance_class": "PERFORMANCE_CLASS_UNSPECIFIED",
    "compression_type": "COMPRESSION_TYPE_UNSPECIFIED"
  },
  "availability": [
    {
      "status": "STORAGE_CLASS_INSTANCE_STATUS_UNSPECIFIED"
    }
  ]
}

default

Default error response

Media type application/json

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

code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32

message

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.

string

details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object

@type

The type of the serialized message.

string

key

additional properties

any

Example ^generated

{
  "code": 1,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}