cloudpods/docs/schemas/bucket.yaml

BucketListResponse:
  type: object
  properties:
    limit:
      type: integer
      example: 20
    offset:
      type: integer
      example: 0
    total:
      type: integer
      description: 总量
    buckets:
      type: array
      items:
        $ref: "#/Bucket"

BucketObjectListResponse:
  type: object
  properties:
    bucket:
      type: object
      properties:
        objects:
          type: array
          items:
            $ref: '#/BucketObject'

BucketObject:
  type: object
  properties:
    key:
      type: string
      description: 对象的key, 如果key以"/"结尾，则该key一般是目录占位对象
    size_bytes:
      type: integer
      description: 对象大小
    last_modified:
      type: string
      description: 该对象的最近修改时间
    etag:
      type: string
      description: 该对象的md5 checksum
    storage_class:
      type: string
      description: 该对象的存储等级字符串

BucketGetResponse:
  type: object
  properties:
    bucket:
      type: object
      $ref: "#/Bucket"

BucketPutRequestInput:
  type: object
  properties:
    name:
      type: string
      description: 存储桶的名称
    description:
      type: string
      description: 存储桶的描述

BucketCreateInput:
  type: object
  properties:
    name:
      type: string
      required: true
      description:  存储桶的名称
    cloudregion:
      type: string
      required: true
      description: 存储桶所在cloudregion的名称或ID，对于on premise的通用s3存储，cloudregion为default
    manager:
      type: string
      required: true
      description: 存储桶归属的账号订阅(cloudprovider)的名称或ID
    storage_class:
      type: string
      description: 存储桶的存储类型，可能值为：standard, ia和archive
    description:
      type: string
      description: 存储桶的描述

Bucket:
  type: object
  description: 存储桶的描述信息
  properties:
    id:
      type: string
      description: 存储桶的ID
      readOnly: true
    name:
      type: string
      description: 对象存储桶的名称，全局唯一。并且名字唯一性受到所在云供应商的桶名字空间唯一性的约束。
    can_delete:
      type: boolean
      description: 是否可以删除
    acl:
      type: string
      description: 存储桶的默认访问权限，可能值为：private, public-read和public-read-write
    storage_class:
      type: string
      description: 存储桶的默认存储类型
    access_urls:
      type: object
      description: 存储桶的访问URL信息
    object_cnt:
      type: integer
      description: 对象总数量
    object_cnt_limit:
      type: integer
      description: 该bucket允许的最大对象数，为0则无对象数限制
    size_bytes:
      type: integer
      description: 对象的总大小(bytes)
    size_bytes_limit:
      type: integer
      description: 该bucket允许的最大容量，为0则无容量限制
    tenant_id:
      type: string
      description: 存储桶归属的项目ID
    domain_id:
      type: string
      description: 存储桶归属的项目的域ID
    location:
      type: string
      description: 存储桶的所在区域信息
    account_id:
      type: string
      description: 存储桶的云账号的ID

BucketObjectDeleteInput:
  type: object
  properties:
    keys:
      type: array
      items:
        type: string
        description: 待删除的对象Key

BucketObjectDeleteResponse:
  type: object
  properties:
    bucket:
      type: array
      items:
        $ref: ""

BucketObjectDeleteInfo:
  type: object
  properties:
    id:
      type: string
      description: 对象key
    status:
      type: integer
      description: 删除结果，200为成功，400为失败
    data:
      type: string
      description: 如果status为400，则data为错误原因

BucketObjectTempUrlInput:
  type: object
  properties:
    key:
      type: string
      description: 对象key
    method:
      type: string
      description: 请求对象的HTTP方法，例如：GET|PUT|DELETE
    expire_seconds:
      type: integer
      description: 该临时URL的超时时间，单位为秒

BucketObjectTempUrlResponse:
  type: object
  properties:
    bucket:
      type: object
      properties:
        url:
          type: string
          description: 生成的临时URL

BucketGetACLResponse:
  type: object
  properties:
    bucket:
      type: object
      properties:
        acl:
          type: string
          description: bucket或者对象的ACL字串，可能为private, public-read, public-read-write, authenticated-read

BucketMakedirInput:
  type: object
  properties:
    key:
      type: string
      description: 目录的名称，必需以"/"结尾

BucketSetACLInput:
    type: object
    properties:
      acl:
        type: string
        required: true
        description: bucket或者对象的ACL字串，可能为private, public-read, public-read-write
      key:
        type: string
        description: 如果设置对象的ACL，则此字段指定对象的key

BucketSetLimitInput:
  type: object
  properties:
    limit:
      type: object
      description: 桶的存储限制
      properties:
        size_bytes:
          type: integer
          description: 容量上限，为0则无限制
        object_count:
          type: integer
          description: 对象数量限制，为0则无限制

BucketAccessInfoResponse:
  type: object
  properties:
    bucket:
      type: object
      description: 桶的后端访问信息，例如ceph RADOS的endpoint/access_key/secret信息等。具体形式由存储后端决定。