Sign in

v1

latestOpenAPI 3.0.42026-08-068161,1253.1 MB
Data and memory stores

List Data Stores

Returns a list of data stores.

Data stores scheduled for permanent deletion are omitted from the results by default (or when showDeleted is set to false). When this is the case, the operation will check up to 512 data stores. If all checked data stores are deleted, it will return an empty list with a page token to continue iteration.

get/cloud/v2/universes/{universe_id}/data-stores

Path parameters

universe_idstring required

The universe ID.

Query parameters

maxPageSizeinteger

The maximum number of data stores to return. The service might return fewer than this value. If unspecified, at most 10 data stores are returned. The maximum value is 100 and higher values are set to 100.

pageTokenstring

A page token, received from a previous call, to retrieve a subsequent page.

When paginating, all other parameters provided to the subsequent call must match the call that provided the page token.

filterstring

This field may be set in order to filter the resources returned.

The filter field supports a very small subset of CEL:

  • Only the id field is supported.
  • Only the startsWith function is available; no other operators nor built-ins are supported.

Example filter: id.startsWith("foo")

showDeletedboolean
Example:true

If true, resources marked for pending deletion will be included in the results.

Response

OK

nextPageTokenstring

A token that you can send as a pageToken parameter to retrieve the next page. If this field is omitted, there are no subsequent pages.

Example response

{
  "dataStores": [
    {
      "path": "universes/123/data-stores/some-data-store",
      "createTime": "2023-07-05T12:34:56Z",
      "expireTime": "2023-07-05T12:34:56Z",
      "state": "STATE_UNSPECIFIED"
    }
  ]
}