Documentation
¶
Overview ¶
Package ufile include resources of ucloud ufile product
See also
- API: https://docs.ucloud.cn/api/ufile-api/index
- Product: https://www.ucloud.cn/site/product/ufile.html
for detail.
Index ¶
- type BindBucketDomainRequest
- type BindBucketDomainResponse
- type BucketDomainSet
- type DescribeBucketDomainRequest
- type DescribeBucketDomainResponse
- type DescribeMirrorRulesRequest
- type DescribeMirrorRulesResponse
- type FuctionAvailableRegion
- type GetAvailableRegionRequest
- type GetAvailableRegionResponse
- type GetFuctionAvailableRegionRequest
- type GetFuctionAvailableRegionResponse
- type GetUFileDailyReportRequest
- type GetUFileDailyReportResponse
- type MirrorCondition
- type MirrorRemote
- type Mirrors
- type RegionInfo
- type UFileClient
- func (c *UFileClient) BindBucketDomain(req *BindBucketDomainRequest) (*BindBucketDomainResponse, error)
- func (c *UFileClient) DescribeBucketDomain(req *DescribeBucketDomainRequest) (*DescribeBucketDomainResponse, error)
- func (c *UFileClient) DescribeMirrorRules(req *DescribeMirrorRulesRequest) (*DescribeMirrorRulesResponse, error)
- func (c *UFileClient) GetAvailableRegion(req *GetAvailableRegionRequest) (*GetAvailableRegionResponse, error)
- func (c *UFileClient) GetFuctionAvailableRegion(req *GetFuctionAvailableRegionRequest) (*GetFuctionAvailableRegionResponse, error)
- func (c *UFileClient) GetUFileDailyReport(req *GetUFileDailyReportRequest) (*GetUFileDailyReportResponse, error)
- func (c *UFileClient) NewBindBucketDomainRequest() *BindBucketDomainRequest
- func (c *UFileClient) NewDescribeBucketDomainRequest() *DescribeBucketDomainRequest
- func (c *UFileClient) NewDescribeMirrorRulesRequest() *DescribeMirrorRulesRequest
- func (c *UFileClient) NewGetAvailableRegionRequest() *GetAvailableRegionRequest
- func (c *UFileClient) NewGetFuctionAvailableRegionRequest() *GetFuctionAvailableRegionRequest
- func (c *UFileClient) NewGetUFileDailyReportRequest() *GetUFileDailyReportRequest
- func (c *UFileClient) NewUnbindBucketDomainRequest() *UnbindBucketDomainRequest
- func (c *UFileClient) UnbindBucketDomain(req *UnbindBucketDomainRequest) (*UnbindBucketDomainResponse, error)
- type UFileDailyReportItem
- type UFileReportItem
- type UFileTotalReportItem
- type UnbindBucketDomainRequest
- type UnbindBucketDomainResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BindBucketDomainRequest ¶
type BindBucketDomainRequest struct {
request.CommonBase
// 自定义域名对应的bucket名称
BucketName *string `required:"true"`
// 自定义域名
Domain *string `required:"true"`
}
BindBucketDomainRequest is request schema for BindBucketDomain action
type BindBucketDomainResponse ¶
type BindBucketDomainResponse struct {
response.CommonBase
// 自定义域名对应的Bucket的Id
BucketId string
// 自定义域名对应的bucket名称
BucketName string
}
BindBucketDomainResponse is response schema for BindBucketDomain action
type BucketDomainSet ¶
type BucketDomainSet struct {
// 区域代码
AreaCode string
// bucket名称
BucketName string
// cdn类型
CdnType string
// 自定义域名
Domain string
// cdn domain id(为cdn domain时返回此字段信息)
DomainId string
// 是不是cdn域名
IsUcdn int
}
BucketDomainSet - bucket自定义域名信息
this model is auto created by ucloud code generater for open api, you can also see https://docs.ucloud.cn/api for detail.
type DescribeBucketDomainRequest ¶
type DescribeBucketDomainRequest struct {
request.CommonBase
// 待获取Bucket的名称
BucketName *string `required:"true"`
}
DescribeBucketDomainRequest is request schema for DescribeBucketDomain action
type DescribeBucketDomainResponse ¶
type DescribeBucketDomainResponse struct {
response.CommonBase
// bucket自定义域名信息
DataSet []BucketDomainSet
}
DescribeBucketDomainResponse is response schema for DescribeBucketDomain action
type DescribeMirrorRulesRequest ¶
type DescribeMirrorRulesRequest struct {
request.CommonBase
// 获取回源规则的bucket的名称
BucketName *string `required:"true"`
}
DescribeMirrorRulesRequest is request schema for DescribeMirrorRules action
type DescribeMirrorRulesResponse ¶
type DescribeMirrorRulesResponse struct {
response.CommonBase
// 回源规则信息
Mirrors []Mirrors
}
DescribeMirrorRulesResponse is response schema for DescribeMirrorRules action
type FuctionAvailableRegion ¶
FuctionAvailableRegion - 功能可用地域
this model is auto created by ucloud code generater for open api, you can also see https://docs.ucloud.cn/api for detail.
type GetAvailableRegionRequest ¶
type GetAvailableRegionRequest struct {
request.CommonBase
// GetAvailableRegion
Action *string `required:"true"`
}
GetAvailableRegionRequest is request schema for GetAvailableRegion action
type GetAvailableRegionResponse ¶
type GetAvailableRegionResponse struct {
response.CommonBase
// 一组String类型表示的可用地域
AvailableRegion []string
// 一组RegionInfo Item类型表示的可用地域信息
RegionInfo []RegionInfo
}
GetAvailableRegionResponse is response schema for GetAvailableRegion action
type GetFuctionAvailableRegionRequest ¶
type GetFuctionAvailableRegionRequest struct {
request.CommonBase
}
GetFuctionAvailableRegionRequest is request schema for GetFuctionAvailableRegion action
type GetFuctionAvailableRegionResponse ¶
type GetFuctionAvailableRegionResponse struct {
response.CommonBase
// 功能可用地域
FuctionAvailableRegion []FuctionAvailableRegion
}
GetFuctionAvailableRegionResponse is response schema for GetFuctionAvailableRegion action
type GetUFileDailyReportRequest ¶
type GetUFileDailyReportRequest struct {
request.CommonBase
// 空间名称。此字段不为空,返回此Bucket日使用量;否则,返回这个项目的日使用量
BucketName *string `required:"false"`
// 查询结束时间;unix时间戳,单位s
EndTime *int `required:"true"`
// 查询开始时间;unix时间戳,单位s
StartTime *int `required:"true"`
}
GetUFileDailyReportRequest is request schema for GetUFileDailyReport action
type GetUFileDailyReportResponse ¶
type GetUFileDailyReportResponse struct {
response.CommonBase
// 消费情况
DataSet []UFileReportItem
}
GetUFileDailyReportResponse is response schema for GetUFileDailyReport action
type MirrorCondition ¶
type MirrorCondition struct {
// 回源条件,path以某个prefix为前缀
Prefix string
// 状态码 404 表示回源
StatusCode int
}
MirrorCondition - 回源条件
this model is auto created by ucloud code generater for open api, you can also see https://docs.ucloud.cn/api for detail.
type MirrorRemote ¶
type MirrorRemote struct {
// 回源的域名
Domain string
// 重定向固定地址的path
FixedPath string
// 回源Path添加的前缀或者回源Path替换的前缀
Prefix string
// 回源Path添加的后缀
Suffix string
// 回源方式,添加前后缀addition、固定地址fixed、替换前缀replace
Type string
}
MirrorRemote - 回源源站信息
this model is auto created by ucloud code generater for open api, you can also see https://docs.ucloud.cn/api for detail.
type Mirrors ¶
type Mirrors struct {
// 回源条件
Condition MirrorCondition
// 回源规则
Remote MirrorRemote
// 回源类型,mirror or redirect
Type string
}
Mirrors - 回源规则信息
this model is auto created by ucloud code generater for open api, you can also see https://docs.ucloud.cn/api for detail.
type RegionInfo ¶
type RegionInfo struct {
// 可用地域的加速域名后缀,与Bucket名称拼接成加速域名
CdnDomainSuffix string
// 可用地域名称
Region string
// 可用地域的源站域名后缀,与Bucket名称拼接成源站域名
SrcDomainSuffix string
}
RegionInfo - 一组RegionInfo Item类型表示的可用地域信息
this model is auto created by ucloud code generater for open api, you can also see https://docs.ucloud.cn/api for detail.
type UFileClient ¶
UFileClient is the client of UFile
func NewClient ¶
func NewClient(config *ucloud.Config, credential *auth.Credential) *UFileClient
NewClient will return a instance of UFileClient
func (*UFileClient) BindBucketDomain ¶
func (c *UFileClient) BindBucketDomain(req *BindBucketDomainRequest) (*BindBucketDomainResponse, error)
BindBucketDomain - 绑定自定义域名
func (*UFileClient) DescribeBucketDomain ¶
func (c *UFileClient) DescribeBucketDomain(req *DescribeBucketDomainRequest) (*DescribeBucketDomainResponse, error)
DescribeBucketDomain - 获取bcuket自定义域名描述信息
func (*UFileClient) DescribeMirrorRules ¶
func (c *UFileClient) DescribeMirrorRules(req *DescribeMirrorRulesRequest) (*DescribeMirrorRulesResponse, error)
DescribeMirrorRules - 获取回源规则描述信息
func (*UFileClient) GetAvailableRegion ¶
func (c *UFileClient) GetAvailableRegion(req *GetAvailableRegionRequest) (*GetAvailableRegionResponse, error)
GetAvailableRegion - 获取地域信息
func (*UFileClient) GetFuctionAvailableRegion ¶
func (c *UFileClient) GetFuctionAvailableRegion(req *GetFuctionAvailableRegionRequest) (*GetFuctionAvailableRegionResponse, error)
GetFuctionAvailableRegion - 获取功能可用地域
func (*UFileClient) GetUFileDailyReport ¶
func (c *UFileClient) GetUFileDailyReport(req *GetUFileDailyReportRequest) (*GetUFileDailyReportResponse, error)
GetUFileDailyReport - 查看日消费报表
func (*UFileClient) NewBindBucketDomainRequest ¶
func (c *UFileClient) NewBindBucketDomainRequest() *BindBucketDomainRequest
NewBindBucketDomainRequest will create request of BindBucketDomain action.
func (*UFileClient) NewDescribeBucketDomainRequest ¶
func (c *UFileClient) NewDescribeBucketDomainRequest() *DescribeBucketDomainRequest
NewDescribeBucketDomainRequest will create request of DescribeBucketDomain action.
func (*UFileClient) NewDescribeMirrorRulesRequest ¶
func (c *UFileClient) NewDescribeMirrorRulesRequest() *DescribeMirrorRulesRequest
NewDescribeMirrorRulesRequest will create request of DescribeMirrorRules action.
func (*UFileClient) NewGetAvailableRegionRequest ¶
func (c *UFileClient) NewGetAvailableRegionRequest() *GetAvailableRegionRequest
NewGetAvailableRegionRequest will create request of GetAvailableRegion action.
func (*UFileClient) NewGetFuctionAvailableRegionRequest ¶
func (c *UFileClient) NewGetFuctionAvailableRegionRequest() *GetFuctionAvailableRegionRequest
NewGetFuctionAvailableRegionRequest will create request of GetFuctionAvailableRegion action.
func (*UFileClient) NewGetUFileDailyReportRequest ¶
func (c *UFileClient) NewGetUFileDailyReportRequest() *GetUFileDailyReportRequest
NewGetUFileDailyReportRequest will create request of GetUFileDailyReport action.
func (*UFileClient) NewUnbindBucketDomainRequest ¶
func (c *UFileClient) NewUnbindBucketDomainRequest() *UnbindBucketDomainRequest
NewUnbindBucketDomainRequest will create request of UnbindBucketDomain action.
func (*UFileClient) UnbindBucketDomain ¶
func (c *UFileClient) UnbindBucketDomain(req *UnbindBucketDomainRequest) (*UnbindBucketDomainResponse, error)
UnbindBucketDomain - 解绑自定义域名
type UFileDailyReportItem ¶
type UFileDailyReportItem struct {
// API请求次数(万次)
ApiTimes float64
// 忙时流量;单位GB;海外无此字段
BusyFlow float64
// cdn回源流量;单位GB
CdnFlow float64
// 配额消费时间,unix时间戳(单位s),精确到日期
Date int
// 下载流量:单位GB;国内无此字段
Flow float64
// 闲时流量;单位GB;海外无此字段
IdleFlow float64
// 存储量;单位GB
Storage float64
}
UFileDailyReportItem -
this model is auto created by ucloud code generater for open api, you can also see https://docs.ucloud.cn/api for detail.
type UFileReportItem ¶
type UFileReportItem struct {
// 日消费情况
Daily []UFileDailyReportItem
// 总消费情况
Total []UFileTotalReportItem
}
UFileReportItem -
this model is auto created by ucloud code generater for open api, you can also see https://docs.ucloud.cn/api for detail.
type UFileTotalReportItem ¶
type UFileTotalReportItem struct {
// API请求次数(万次)
ApiTimes float64
// 忙时流量;单位GB;海外无此字段
BusyFlow float64
// cdn回源流量;单位GB
CdnFlow float64
// 下载流量:单位GB;国内无此字段
Flow float64
// 闲时流量;单位GB;海外无此字段
IdleFlow float64
}
UFileTotalReportItem - 总消费信息
this model is auto created by ucloud code generater for open api, you can also see https://docs.ucloud.cn/api for detail.
type UnbindBucketDomainRequest ¶
type UnbindBucketDomainRequest struct {
request.CommonBase
// bucket名称
BucketName *string `required:"true"`
// 需要解绑的自定义域名
Domain *string `required:"true"`
}
UnbindBucketDomainRequest is request schema for UnbindBucketDomain action
type UnbindBucketDomainResponse ¶
type UnbindBucketDomainResponse struct {
response.CommonBase
// Bucket的Id
BucketId string
// Buecket名称
BucketName string
}
UnbindBucketDomainResponse is response schema for UnbindBucketDomain action
Source Files
¶
- bind_bucket_domain.go
- client.go
- describe_bucket_domain.go
- describe_mirror_rules.go
- doc.go
- get_available_region.go
- get_fuction_available_region.go
- get_ufile_daily_report.go
- types_bucket_domain_set.go
- types_fuction_available_region.go
- types_mirror_condition.go
- types_mirror_remote.go
- types_mirrors.go
- types_region_info.go
- types_ufile_daily_report_item.go
- types_ufile_report_item.go
- types_ufile_total_report_item.go
- unbind_bucket_domain.go