Skip to main content

ListObjects​

Queries a list of object items under the bucket.

Path Parameters
    bucket_name string required
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

A successful response.

Schema
    object_infos object[]
  • Array [
    • owner owner is the object owner
    creator creator is the address of the uploader, it always be same as owner address
    bucket_name bucket_name is the name of the bucket
    object_name object_name is the name of object
    id id is the unique identifier of object
    local_virtual_group_id int64
    payload_size uint64
    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 object. When an object is public, everyone can access it.

    content_type string

    content_type define the format of the object which should be a standard MIME type.

    create_at int64
    object_status string

    Possible values: [OBJECT_STATUS_CREATED, OBJECT_STATUS_SEALED, OBJECT_STATUS_DISCONTINUED]

    Default value: OBJECT_STATUS_CREATED

    object_status define the upload status of the object.

    redundancy_type string

    Possible values: [REDUNDANCY_EC_TYPE, REDUNDANCY_REPLICA_TYPE]

    Default value: REDUNDANCY_EC_TYPE

    redundancy_type define the type of the redundancy which can be multi-replication or EC.

    source_type SourceType represents the source of resource creation, which can from Greenfield native or from a cross-chain transfer from BSC

    Possible values: [SOURCE_TYPE_ORIGIN, SOURCE_TYPE_MIRROR_PENDING, SOURCE_TYPE_BSC_CROSS_CHAIN, SOURCE_TYPE_OP_CROSS_CHAIN]

    Default value: SOURCE_TYPE_ORIGIN

    source_type define the source of the object.

    checksums byte[]
    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
Loading...