跳转至

helper

models.helper

辅助功能相关数据模型.

InitUploadFileDict

Bases: TypedDict

InitUpload 的单文件参数字典.

ATTRIBUTE DESCRIPTION
FileSha1

待上传文件的 SHA1 哈希值.

TYPE: str

FileName

待上传文件的名称.

TYPE: str

FileSize

待上传文件的大小(字节).

TYPE: int

FinishUploadBucketDict

Bases: TypedDict

FinishUpload 的 Bucket 字典.

ATTRIBUTE DESCRIPTION
Name

实际上传使用的存储桶名称.

TYPE: str

Region

实际上传使用的存储桶地域.

TYPE: str

FinishUploadStorageDict

Bases: TypedDict

FinishUpload 的 Storage 字典.

ATTRIBUTE DESCRIPTION
Bucket

存储桶信息字典.

TYPE: FinishUploadBucketDict

ObjectKey

COS 对象存储路径.

TYPE: str

FinishUploadResultDict

Bases: TypedDict

FinishUpload 的单文件结果字典.

ATTRIBUTE DESCRIPTION
Storage

存储信息字典.

TYPE: FinishUploadStorageDict

UploadResult

上传状态码, 通常为 0 表示成功.

TYPE: int

UploadBucketInfo pydantic-model

Bases: BaseModel

COS 存储桶基本信息.

ATTRIBUTE DESCRIPTION
name

存储桶名称.

TYPE: str

region

存储桶地域.

TYPE: str

Fields:

UploadBucketStatus pydantic-model

Bases: BaseModel

COS 存储桶上传状态.

ATTRIBUTE DESCRIPTION
bucket

存储桶基本信息.

TYPE: UploadBucketInfo

upload_status

上传状态码, 0 表示正常.

TYPE: int

Fields:

UploadFileInfo pydantic-model

Bases: BaseModel

COS 上传文件元信息.

ATTRIBUTE DESCRIPTION
file_sha1

文件 SHA1 哈希值.

TYPE: str

object_key

COS 对象存储路径 (即文件路径).

TYPE: str

buckets

目标存储桶列表.

TYPE: list[UploadBucketStatus]

Fields:

UploadAuthInfo pydantic-model

Bases: BaseModel

COS 上传鉴权信息.

ATTRIBUTE DESCRIPTION
secret_id

COS 临时密钥 ID.

TYPE: str

secret_key

COS 临时密钥 Key.

TYPE: str

token

COS 临时 Token.

TYPE: str

start_time

临时密钥生效时间戳.

TYPE: int

expired_time

临时密钥过期时间戳.

TYPE: int

Fields:

  • secret_id (str)
  • secret_key (str)
  • token (str)
  • start_time (int)
  • expired_time (int)

InitUploadResponse pydantic-model

Bases: BaseModel

InitUpload 接口返回数据.

ATTRIBUTE DESCRIPTION
auth_info

COS 上传鉴权凭证.

TYPE: UploadAuthInfo

files

文件存储路径与存储桶信息列表.

TYPE: list[UploadFileInfo]

Fields:

UploadStorage pydantic-model

Bases: BaseModel

存储信息.

ATTRIBUTE DESCRIPTION
bucket

存储桶信息.

TYPE: UploadBucketInfo

object_key

文件在存储桶中的对象路径.

TYPE: str

Fields:

UploadUrlInfo pydantic-model

Bases: BaseModel

COS 上传完成后的 URL 详情.

ATTRIBUTE DESCRIPTION
file_id

文件唯一 ID (部分场景返回).

TYPE: str

url

基础访问 URL.

TYPE: str

cdn_url

CDN 加速访问 URL.

TYPE: str

presigned_url

预签名带鉴权访问 URL.

TYPE: str

internal_url

内部网络访问 URL.

TYPE: str

Fields:

  • file_id (str)
  • url (str)
  • cdn_url (str)
  • presigned_url (str)
  • internal_url (str)

UploadObjectInfo pydantic-model

Bases: BaseModel

COS 上传完成后的文件对象.

ATTRIBUTE DESCRIPTION
storage

文件所在的存储系统信息.

TYPE: UploadStorage

url

文件上传成功后分配的各路访问 URL.

TYPE: UploadUrlInfo

Fields:

FinishUploadResponse pydantic-model

Bases: BaseModel

FinishUpload 接口返回数据.

ATTRIBUTE DESCRIPTION
objects

上传成功的文件对象列表.

TYPE: list[UploadObjectInfo] | None

Fields: