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 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_ALLOW_DP  ]。默认TOKEN_ALLOW_NONE
	AllowedOps []string `required:"false"`

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

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

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

type CreateUFileTokenResponse struct {
	response.CommonBase

	// 创建令牌的token_id
	TokenId string
}

type DeleteBucketRequest struct {
	request.CommonBase

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

type DeleteBucketResponse struct {
	response.CommonBase

	// Bucket的ID
	BucketId string

	// Bucket的名称
	BucketName string
}

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 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 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 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 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 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 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 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
}