List Storage Class Instances

GET

/storage/v1/engines/qibdo/storage-classes/{storage_class}/instances

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

Returns a paginated list of instances for a storage class (or all classes with -), filterable by location and status.

Parameters

Path Parameters

storage_class

required

string

The parent storage class id, or - for the cross-class matrix (AIP-159).

Query Parameters

page_size

integer format: int32

The maximum number of instances to return. If unspecified, at most 20 instances will be returned. The maximum value is 100; values above 100 will be coerced to 100.

page_token

string

A page token from a previous ListQibdoStorageClassInstances call.

filter

string

AIP-160 filter expression (location_id, status).

order_by

string

AIP-132 order_by expression, e.g. ‘created asc’.

Responses

200

OK

Media type application/json

ListQibdoStorageClassInstancesResponse

Response message for ListQibdoStorageClassInstances.

object

storage_class_instances

The list of storage class instances.

Array<object>

The per-region materialization of a global storage class tier — the reconciler-managed record of whether that tier is actually provisioned in one region’s backing store. A tier is declared once, globally; an instance answers “is the tier ready in region R, and where”. qibdo-only: AWS, GCP, and Azure storage classes are globally available with no per-region instance.

object

id

The unique identifier of this instance (UUID)

stringOutput only

storage_class_id

The storage class tier this instance materializes (UUID)

stringOutput only

location_id

The region this instance materializes the tier into — weak reference to a topology Location of kind REGION (UUID).

stringOutput only

status

Current provisioning status of this instance.

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

data_pool

The backing data pool placement reference, empty until the instance is AVAILABLE.

stringOutput only

created

Timestamp when this instance was created (server-managed).

string format: date-time Output only

updated

Timestamp when this instance was last updated (server-managed).

string format: date-time Output only

next_page_token

A token to retrieve the next page, empty when there are no more pages.

string

Example

{
  "storage_class_instances": [
    {
      "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"
    }
  ]
}