ListBuckets

Queries a list of bucket items.

Query Parameters

pagination.key byte

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset uint64

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit uint64

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_total boolean

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse boolean

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

• 200
• default

---

A successful response.

*/*

Schema

Example (from schema)

---

Schema

bucket_infos object[]
Array [
owner string
owner is the account address of bucket creator, it is also the bucket owner.
bucket_name bucket_name is a globally unique name of bucket
visibility string
Possible values: [VISIBILITY_TYPE_UNSPECIFIED, VISIBILITY_TYPE_PUBLIC_READ, VISIBILITY_TYPE_PRIVATE, VISIBILITY_TYPE_INHERIT]
Default value: VISIBILITY_TYPE_UNSPECIFIED
visibility defines the highest permissions for bucket. When a bucket is public, everyone can get storage objects in it.
id string
id is the unique identification for bucket.
source_type source_type defines which chain the user should send the bucket management transactions to
Possible values: [SOURCE_TYPE_ORIGIN, SOURCE_TYPE_MIRROR_PENDING, SOURCE_TYPE_BSC_CROSS_CHAIN, SOURCE_TYPE_OP_CROSS_CHAIN]
Default value: SOURCE_TYPE_ORIGIN
create_at int64
create_at define the block timestamp when the bucket created.
payment_address payment_address is the address of the payment account
global_virtual_group_family_id int64
charged_read_quota uint64
charged_read_quota defines the traffic quota for read in bytes per month. The available read data for each user is the sum of the free read data provided by SP and the ChargeReadQuota specified here.
bucket_status string
Possible values: [BUCKET_STATUS_CREATED, BUCKET_STATUS_DISCONTINUED, BUCKET_STATUS_MIGRATING]
Default value: BUCKET_STATUS_CREATED
bucket_status define the status of the bucket.
tags object
tags object[]
Array [
key string
value string
]
]
pagination object
PageResponse is to be embedded in gRPC response messages where the corresponding request message has used PageRequest.
message SomeResponse { repeated Bar results = 1; PageResponse page = 2; }
next_key byte
next_key is the key to be passed to PageRequest.key to query the next page most efficiently. It will be empty if there are no more results.
total uint64

{
  "bucket_infos": [
    {
      "owner": "string",
      "bucket_name": "string",
      "visibility": "VISIBILITY_TYPE_UNSPECIFIED",
      "id": "string",
      "source_type": "SOURCE_TYPE_ORIGIN",
      "create_at": "string",
      "payment_address": "string",
      "global_virtual_group_family_id": 0,
      "charged_read_quota": "string",
      "bucket_status": "BUCKET_STATUS_CREATED",
      "tags": {
        "tags": [
          {
            "key": "string",
            "value": "string"
          }
        ]
      }
    }
  ],
  "pagination": {
    "next_key": "string",
    "total": "string"
  }
}

An unexpected error response.

*/*

Schema

Example (from schema)

---

Schema

error string
code int32
message string
details object[]
Array [
type_url string
value byte
]

{
  "error": "string",
  "code": 0,
  "message": "string",
  "details": [
    {
      "type_url": "string",
      "value": "string"
    }
  ]
}

Loading...