ufile

type CreateBucketRequest struct {
	request.CommonBase

	// 待创建Bucket的名称，具有全局唯一性
	BucketName *string `required:"true"`

	// Bucket访问类型，public或private; 默认为private
	Type *string `required:"false"`
}

type CreateBucketResponse struct {
	response.CommonBase

	// 已创建Bucket的ID
	BucketId string

	// 已创建Bucket的名称
	BucketName string
}

type CreateUFileLifeCycleRequest struct {
	request.CommonBase

	// 指定一个过期天数N，文件会在其最近更新时间点的N天后，自动变为归档存储类型；参数范围：[7,36500]，0代表不启用
	ArchivalDays *int `required:"false"`

	// 存储空间名称
	BucketName *string `required:"true"`

	// 指定一个过期天数N，文件会在其最近更新时间点的N天后过期，自动删除；参数范围：[7,36500]，0代表不启用
	Days *int `required:"false"`

	// 指定一个过期天数N，文件会在其最近更新时间点的N天后，自动变为低频存储类型；参数范围：[7,36500]，0代表不启用
	IADays *int `required:"false"`

	// 生命周期名称
	LifeCycleName *string `required:"true"`

	// 生命周期所适用的前缀；*为整个存储空间文件；一条规则只支持一个文件前缀；
	Prefix *string `required:"true"`

	// Enabled -- 启用，Disabled -- 不启用
	Status *string `required:"true"`

	// Tag，参数格式"k1=v1&k2=v2"，key的最大长度为128， value最大长度为256byte，单个object的tag的最大数量为10
	Tags *string `required:"false"`
}

type CreateUFileLifeCycleResponse struct {
	response.CommonBase

	// 生命周期Id
	LifeCycleId string
}

type CreateUFileTokenRequest struct {
	request.CommonBase

	// 令牌允许操作的bucket，默认*表示全部
	AllowedBuckets []string `required:"false"`

	// 令牌允许执行的操作[ TOKEN_ALLOW_NONE 没有权限, TOKEN_ALLOW_READ 下载权限 , TOKEN_ALLOW_WRITE 上传权限 , TOKEN_ALLOW_DELETE 删除权限 , TOKEN_ALLOW_LIST 列表权限, TOKEN_ALLOW_IOP 图片处理权限, TOKEN_DENY_UPDATE 禁止覆盖权限]。默认TOKEN_ALLOW_NONE
	AllowedOps []string `required:"false"`

	// 令牌允许操作的key前缀，默认*表示全部
	AllowedPrefixes []string `required:"false"`

	// 令牌黑名单，支持ipv4，ipv6格式。
	BlackIPList []string `required:"false"`

	// Unix 时间戳，精确到秒，为令牌过期时间点。默认过期时间为一天（即当前Unix时间戳+86400）；注意：过期时间不能超过 4102416000
	ExpireTime *int `required:"false"`

	// 令牌名称
	TokenName *string `required:"true"`

	// 令牌白名单，支持ipv4，ipv6格式。
	WhiteIPList []string `required:"false"`
}

type CreateUFileTokenResponse struct {
	response.CommonBase

	// 令牌唯一ID
	TokenId string

	// 创建令牌的详细信息
	UFileTokenSet UFileTokenSet
}

type DeleteBucketRequest struct {
	request.CommonBase

	// 待删除Bucket的名称
	BucketName *string `required:"true"`
}

type DeleteBucketResponse struct {
	response.CommonBase

	// Bucket的ID
	BucketId string

	// Bucket的名称
	BucketName string
}

type DeleteUFileLifeCycleRequest struct {
	request.CommonBase

	// 存储空间名称
	BucketName *string `required:"true"`

	// 生命周期Id
	LifeCycleId *string `required:"true"`
}

type DeleteUFileLifeCycleResponse struct {
	response.CommonBase
}

type DeleteUFileTokenRequest struct {
	request.CommonBase

	// 令牌ID
	TokenId *string `required:"true"`
}

type DeleteUFileTokenResponse struct {
	response.CommonBase
}

type DescribeBucketRequest struct {
	request.CommonBase

	// 待获取Bucket的名称，若不提供，则获取所有Bucket
	BucketName *string `required:"false"`

	// 获取所有Bucket列表的限制数目，默认为20
	Limit *int `required:"false"`

	// 获取所有Bucket列表的偏移数目，默认为0
	Offset *int `required:"false"`
}

type DescribeBucketResponse struct {
	response.CommonBase

	// Bucket的描述信息 参数见 UFileBucketSet
	DataSet []UFileBucketSet
}

type DescribeUFileLifeCycleRequest struct {
	request.CommonBase

	// 存储空间名称
	BucketName *string `required:"true"`

	// 生命周期Id；不传递此参数拉取存储空间下面的所有生命周期信息
	LifeCycleId *string `required:"false"`
}

type DescribeUFileLifeCycleResponse struct {
	response.CommonBase

	// 生命周期信息
	DateSet []LifeCycleItem
}

type DescribeUFileTokenRequest struct {
	request.CommonBase

	// 0表示显示部分token信息；不传递和其他情况表示显示全部token信息
	Display *int `required:"false"`

	// 令牌ID，只返回指定ID信息，否则拉取所有令牌
	TokenId *string `required:"false"`

	// 令牌名称，只返回指定令牌名称信息，否则拉取所有令牌
	TokenName *string `required:"false"`
}

type DescribeUFileTokenResponse struct {
	response.CommonBase

	// 【该字段已废弃，请谨慎使用】
	Action string `deprecated:"true"`

	// 令牌描述信息
	DataSet []UFileTokenSet

	// 【该字段已废弃，请谨慎使用】
	RetCode int `deprecated:"true"`
}

type GetUFileDailyReportRequest struct {
	request.CommonBase

	// 空间名称。此字段不为空，返回此Bucket日使用量；否则，返回这个项目的日使用量
	BucketName *string `required:"false"`

	// 查询结束时间;unix时间戳,单位s
	EndTime *int `required:"true"`

	// 查询开始时间;unix时间戳，单位s
	StartTime *int `required:"true"`
}

type GetUFileDailyReportResponse struct {
	response.CommonBase

	// 消费情况
	DataSet []UFileReportItem
}

type GetUFileQuotaInfoRequest struct {
	request.CommonBase

	// 配额类型，取值为storage-volume, download-traffic或request-count
	QuotaType []string `required:"true"`
}

type GetUFileQuotaInfoResponse struct {
	response.CommonBase

	// 配额信息数据集
	DataSet []UFileQuotaDataSetItem
}

type GetUFileQuotaPriceRequest struct {
	request.CommonBase

	// 下载流量，单位: GB，范围: [0, 60 000]，步长：1GB
	DownloadTraffic *int `required:"false"`

	// 请求次数，单位：万次，范围：[0, 1 000 000]，步长：1万次
	RequestCount *int `required:"false"`

	// 存储容量，单位: GB*天，范围: [0, 30 000 000]，步长：100GB*天
	StorageVolume *int `required:"false"`
}

type GetUFileQuotaPriceResponse struct {
	response.CommonBase

	// 待支付价格，单位：分
	Price float64
}

type GetUFileQuotaRequest struct {
	request.CommonBase

	// 配额类型，取值为storage-volume, download-traffic或request-count
	QuotaType *string `required:"true"`
}

type GetUFileQuotaResponse struct {
	response.CommonBase

	// 剩余的配额数值
	LeftQuota float64
}

type GetUFileReportRequest struct {
	request.CommonBase

	// 查询结束时间
	EndTime *int `required:"true"`

	// 查询开始时间
	StartTime *int `required:"true"`
}

type GetUFileReportResponse struct {
	response.CommonBase

	// 报表内容 参数见 UFileReportSet
	DataSet []UFileReportSet
}

type LifeCycleItem struct {

	// 指定一个过期天数N，文件会在其最近更新时间点的N天后过期，自动转换为归档存储类型，0代表不启用；
	ArchivalDays int

	// 存储空间名称
	BucketName string

	// 指定一个过期天数N，文件会在其最近更新时间点的N天后过期，自动删除，0代表不启用；
	Days int

	// 指定一个过期天数N，文件会在其最近更新时间点的N天后过期，自动转换为低频存储类型，0代表不启用；
	IADays int

	// 生命周期Id
	LifeCycleId string

	// 生命周期名称
	LifeCycleName string

	// 生命周期所适用的前缀；*为整个存储空间文件；
	Prefix string

	// Enabled -- 启用，Disabled -- 不启用
	Status string
}

type SetUFileRefererRequest struct {
	request.CommonBase

	// 存储空间名称
	BucketName *string `required:"true"`

	// RefererType为白名单时，RefererAllowNull为false代表不允许空referer访问，为true代表允许空referer访问;此参数默认为 true;
	RefererAllowNull *bool `required:"false"`

	// 开启关闭referer防盗链;关闭防盗链会清空防盗链参数设置，开启防盗链必须指定 RefererType、Referers；开启：on， 关闭：off;
	RefererStatus *string `required:"true"`

	// 防盗链Referer类型，支持两种类型，黑名单和白名单; 1黑名单，2白名单；RefererStatus为"on"时此参数必填；
	RefererType *int `required:"false"`

	// 防盗链Referer规则，支持正则表达式（不支持符号';')
	Referers []string `required:"false"`
}

type SetUFileRefererResponse struct {
	response.CommonBase
}

type UFileBucketSet struct {

	// Bucket所属业务, general或vod或udb general: 普通业务； vod: 视频云业务; udb: 云数据库业务
	Biz string

	// Bucket的ID
	BucketId string

	// Bucket名称
	BucketName string

	// 与Bucket关联的CND加速域名的ID列表
	CdnDomainId []string

	// Bucket的创建时间
	CreateTime int

	// Bucket的域名集合 参数见 UFileDomainSet
	Domain UFileDomainSet

	// 是否存在自定义域名。0不存在，1存在，2错误
	HasUserDomain int

	// Bucket的修改时间
	ModifyTime int

	// Bucket所属地域
	Region string

	// 所属业务组
	Tag string

	// Bucket访问类型
	Type string
}

type UFileClient struct {
	*ucloud.Client
}

type UFileDailyReportItem struct {

	// 冷存激活量，即归档数据取回量；单位GB
	AcRestore float64

	// 冷存（归档）存储量；单位GB
	AcStorage float64

	// API请求次数（万次）
	ApiTimes float64

	// 忙时流量；单位GB；海外无此字段
	BusyFlow float64

	// cdn回源流量;单位GB
	CdnFlow float64

	// 配额消费时间，unix时间戳（单位s），精确到日期
	Date int

	// 下载流量：单位GB；国内无此字段
	Flow float64

	// 低频数据取回量；单位GB
	IaGetSize float64

	// 低频存储量；单位GB
	IaStorage float64

	// 闲时流量；单位GB；海外无此字段
	IdleFlow float64

	// 标准存储量；单位GB
	Storage float64
}

type UFileDomainSet struct {

	// UCDN加速域名
	Cdn []string

	// 用户自定义CDN加速域名
	CustomCdn []string

	// 用户自定义源站域名
	CustomSrc []string

	// 源站域名
	Src []string
}

type UFileQuotaDataSetItem struct {

	// 剩余下载流量
	DownloadFlow UFileQuotaLeft

	// 是否欠费：1表示欠费；0表示未欠费
	Owe int

	// 可用地域
	Region string

	// 剩余请求次数
	RequestCnt UFileQuotaLeft

	// 剩余存储容量
	Storage UFileQuotaLeft
}

type UFileQuotaLeft struct {

	// 配额剩余量
	Left float64
}

type UFileReportItem struct {

	// 日消费情况
	Daily []UFileDailyReportItem

	// 总消费情况
	Total []UFileTotalReportItem
}

type UFileReportSet struct {

	// 配额消费当日使用的下载流量，单位：GB
	DownloadTraffic float64

	// 配额消费当日使用的请求次数，单位：万次
	RequestCount float64

	// 配额消费当日使用的存储容量，单位：GB*天
	StorageVolume float64

	// 配额消费时间，unix时间戳，精确到日期
	Time int
}

type UFileTokenSet struct {

	// 令牌允许操作的bucket
	AllowedBuckets []string

	// 令牌允许执行的操作，[ TOKEN_ALLOW_NONE , TOKEN_ALLOW_READ , TOKEN_ALLOW_WRITE , TOKEN_ALLOW_DELETE , TOKEN_ALLOW_LIST, TOKEN_ALLOW_IOP , TOKEN_ALLOW_DP ]
	AllowedOps []string

	// 令牌允许操作的key前缀
	AllowedPrefixes []string

	// 创建时间
	CreateTime int

	// 令牌的超时时间点
	ExpireTime int

	// 修改时间
	ModifyTime int

	// 令牌私钥
	PrivateKey string

	// 令牌公钥
	PublicKey string

	// 所属地区
	Region string

	// 令牌ID
	TokenId string

	// 令牌名称
	TokenName string
}

type UFileTotalReportItem struct {

	// API请求次数（万次）
	ApiTimes float64

	// 忙时流量；单位GB；海外无此字段
	BusyFlow float64

	// cdn回源流量;单位GB
	CdnFlow float64

	// 下载流量：单位GB；国内无此字段
	Flow float64

	// 闲时流量；单位GB；海外无此字段
	IdleFlow float64
}

type UpdateBucketRequest struct {
	request.CommonBase

	// 待修改Bucket的名称
	BucketName *string `required:"true"`

	// Bucket访问类型;public或private
	Type *string `required:"true"`
}

type UpdateBucketResponse struct {
	response.CommonBase

	// Bucket的ID
	BucketId string

	// Bucket的名称
	BucketName string
}

type UpdateUFileLifeCycleRequest struct {
	request.CommonBase

	// 指定一个过期天数N，文件会在其最近更新时间点的N天后过期，自动转换为归档存储类型；范围： [7,36500]，0代表不启用
	ArchivalDays *int `required:"false"`

	// 存储空间名称
	BucketName *string `required:"true"`

	// 指定一个过期天数N，文件会在其最近更新时间点的N天后过期,自动删除；范围： [7,36500]
	Days *int `required:"false"`

	// 指定一个过期天数N，文件会在其最近更新时间点的N天后过期，自动转换为低频存储类型；范围： [7,36500]，0代表不启用
	IADays *int `required:"false"`

	// 生命周期Id
	LifeCycleId *string `required:"true"`

	// 生命周期名称
	LifeCycleName *string `required:"true"`

	// 生命周期所适用的前缀；*为整个存储空间文件；一条规则只支持一个文件前缀；
	Prefix *string `required:"true"`

	// Enabled -- 启用，Disabled -- 不启用
	Status *string `required:"true"`

	// Tag，参数格式"k1=v1&k2=v2"，key的最大长度为128， value最大长度为256byte，单个object的tag的最大数量为10
	Tags *string `required:"false"`
}

type UpdateUFileLifeCycleResponse struct {
	response.CommonBase
}

type UpdateUFileTokenRequest struct {
	request.CommonBase

	// 令牌允许操作的bucket
	AllowedBuckets []string `required:"false"`

	// 令牌允许执行的操作，[ TOKEN_ALLOW_NONE , TOKEN_ALLOW_READ , TOKEN_ALLOW_WRITE , TOKEN_ALLOW_DELETE , TOKEN_ALLOW_LIST, TOKEN_ALLOW_IOP , TOKEN_ALLOW_DP ]
	AllowedOps []string `required:"false"`

	// 令牌允许操作的key前缀
	AllowedPrefixes []string `required:"false"`

	// 令牌的超时时间点（时间戳）;注意：过期时间不能超过 4102416000
	ExpireTime *int `required:"false"`

	// 令牌ID
	TokenId *string `required:"true"`

	// 令牌名称
	TokenName *string `required:"false"`
}

type UpdateUFileTokenResponse struct {
	response.CommonBase
}

type UpdateUdsRuleRequest struct {
	request.CommonBase

	// 联系的用户组ID
	ContactGroupId *string `required:"false"`

	// 目标Bucket名字，全局唯一
	DstBucket *string `required:"true"`

	// 解压后的目标目录
	DstDirectory *string `required:"true"`

	// 目标bucket的token之一的tokenId
	DstTokenId *string `required:"true"`

	// 通知的事件数组
	Events []string `required:"false"`

	// 是否以压缩文件的前缀为最后一层目录
	KeepUS3Name *bool `required:"true"`

	// 通知的类型数组
	NotificationTypes []string `required:"false"`

	// 操作的ops数组,"Ops.0":"unzip"
	Ops []string `required:"false"`

	// 触发解压缩的前缀
	Prefixes *string `required:"true"`

	// 规则的唯一Id
	RuleId *string `required:"true"`

	// 规则名称
	RuleName *string `required:"true"`

	// 源Bucket名字，全局唯一
	SrcBucket *string `required:"true"`

	// 源bucket的token之一的tokenId
	SrcTokenId *string `required:"true"`
}

type UpdateUdsRuleResponse struct {
	response.CommonBase

	// 该请求的消息成功或者失败的描述
	Mesage string

	// 返回规则的规则ID
	RuleId string
}