Documentation ¶
Index ¶
- Constants
- type Client
- func (cli *Client) CreateDomain(domain string, originInit *api.OriginInit) (*api.DomainCreatedInfo, error)
- func (cli *Client) DeleteDomain(domain string) error
- func (cli *Client) DisableDomain(domain string) error
- func (cli *Client) DisableDsa() error
- func (cli *Client) EnableDomain(domain string) error
- func (cli *Client) EnableDsa() error
- func (cli *Client) GetAccessLimit(domain string) (*api.AccessLimit, error)
- func (cli *Client) GetAvgSpeed(queryCondition *api.QueryCondition) ([]api.AvgSpeedDetail, error)
- func (cli *Client) GetAvgSpeedByRegion(queryCondition *api.QueryCondition, prov string, isp string) ([]api.AvgSpeedRegionDetail, error)
- func (cli *Client) GetCacheOpRecords(queryData *api.CRecordQueryData) (*api.RecordDetails, error)
- func (cli *Client) GetCacheTTL(domain string) ([]api.CacheTTL, error)
- func (cli *Client) GetCacheUrlArgs(domain string) (*api.CacheUrlArgs, error)
- func (cli *Client) GetClientIp(domain string) (*api.ClientIp, error)
- func (cli *Client) GetContentEncoding(domain string) (string, error)
- func (cli *Client) GetCors(domain string) (*api.CorsCfg, error)
- func (cli *Client) GetDomainConfig(domain string) (*api.DomainConfig, error)
- func (cli *Client) GetDomainHttps(domain string) (*api.HTTPSConfig, error)
- func (cli *Client) GetDomainLog(domain string, timeInterval api.TimeInterval) ([]api.LogEntry, error)
- func (cli *Client) GetDomainSeo(domain string) (*api.SeoSwitch, error)
- func (cli *Client) GetDomainStatus(status string, rule string) ([]api.DomainStatus, error)
- func (cli *Client) GetError(queryCondition *api.QueryCondition) ([]api.ErrorDetail, error)
- func (cli *Client) GetErrorPage(domain string) ([]api.ErrorPage, error)
- func (cli *Client) GetFileTrim(domain string) (bool, error)
- func (cli *Client) GetFlow(queryCondition *api.QueryCondition, level string) ([]api.FlowDetail, error)
- func (cli *Client) GetFlowByProtocol(queryCondition *api.QueryCondition, protocol string) ([]api.FlowDetail, error)
- func (cli *Client) GetFlowByRegion(queryCondition *api.QueryCondition, prov string, isp string) ([]api.FlowRegionDetail, error)
- func (cli *Client) GetHttpCode(queryCondition *api.QueryCondition) ([]api.HttpCodeDetail, error)
- func (cli *Client) GetHttpCodeByRegion(queryCondition *api.QueryCondition, prov string, isp string) ([]api.HttpCodeRegionDetail, error)
- func (cli *Client) GetHttpHeader(domain string) ([]api.HttpHeader, error)
- func (cli *Client) GetIpACL(domain string) (*api.IpACL, error)
- func (cli *Client) GetIpInfo(ip string, action string) (*api.IpInfo, error)
- func (cli *Client) GetMediaDrag(domain string) (*api.MediaDragConf, error)
- func (cli *Client) GetMobileAccess(domain string) (bool, error)
- func (cli *Client) GetMultiDomainLog(queryData *api.LogQueryData) ([]api.LogEntry, error)
- func (cli *Client) GetPrefetchStatus(queryData *api.CStatusQueryData) (*api.PrefetchStatus, error)
- func (cli *Client) GetPurgedStatus(queryData *api.CStatusQueryData) (*api.PurgedStatus, error)
- func (cli *Client) GetPv(queryCondition *api.QueryCondition, level string) ([]api.PvDetail, error)
- func (cli *Client) GetPvByRegion(queryCondition *api.QueryCondition, prov string, isp string) ([]api.PvRegionDetail, error)
- func (cli *Client) GetPvHit(queryCondition *api.QueryCondition) ([]api.HitDetail, error)
- func (cli *Client) GetQuota() (*api.QuotaDetail, error)
- func (cli *Client) GetRangeSwitch(domain string) (bool, error)
- func (cli *Client) GetRealHit(queryCondition *api.QueryCondition) ([]api.HitDetail, error)
- func (cli *Client) GetRefererACL(domain string) (*api.RefererACL, error)
- func (cli *Client) GetSrcFlow(queryCondition *api.QueryCondition) ([]api.FlowDetail, error)
- func (cli *Client) GetSrcHttpCode(queryCondition *api.QueryCondition) ([]api.HttpCodeDetail, error)
- func (cli *Client) GetSrcPv(queryCondition *api.QueryCondition) ([]api.PvDetail, error)
- func (cli *Client) GetTopNDomains(queryCondition *api.QueryCondition, httpCode string) ([]api.TopNDetail, error)
- func (cli *Client) GetTopNReferers(queryCondition *api.QueryCondition, httpCode string) ([]api.TopNDetail, error)
- func (cli *Client) GetTopNUrls(queryCondition *api.QueryCondition, httpCode string) ([]api.TopNDetail, error)
- func (cli *Client) GetUv(queryCondition *api.QueryCondition) ([]api.UvDetail, error)
- func (cli *Client) IsValidDomain(domain string) (*api.DomainValidInfo, error)
- func (cli *Client) ListDomains(marker string) ([]string, string, error)
- func (cli *Client) ListDsaDomains() ([]api.DSADomain, error)
- func (cli *Client) Prefetch(tasks []api.PrefetchTask) (api.PrefetchId, error)
- func (cli *Client) Purge(tasks []api.PurgeTask) (api.PurgedId, error)
- func (cli *Client) SetAccessLimit(domain string, accessLimit *api.AccessLimit) error
- func (cli *Client) SetCacheTTL(domain string, cacheTTLs []api.CacheTTL) error
- func (cli *Client) SetCacheUrlArgs(domain string, cacheFullUrl *api.CacheUrlArgs) error
- func (cli *Client) SetClientIp(domain string, clientIp *api.ClientIp) error
- func (cli *Client) SetContentEncoding(domain string, enabled bool, encodingType string) error
- func (cli *Client) SetCors(domain string, isAllow bool, originList []string) error
- func (cli *Client) SetDomainHttps(domain string, httpsConfig *api.HTTPSConfig) error
- func (cli *Client) SetDomainOrigin(domain string, origins []api.OriginPeer, defaultHost string) error
- func (cli *Client) SetDomainRequestAuth(domain string, requestAuth *api.RequestAuth) error
- func (cli *Client) SetDomainSeo(domain string, seoSwitch *api.SeoSwitch) error
- func (cli *Client) SetDsaConfig(domain string, dsaConfig *api.DSAConfig) error
- func (cli *Client) SetErrorPage(domain string, errorPages []api.ErrorPage) error
- func (cli *Client) SetFileTrim(domain string, fileTrim bool) error
- func (cli *Client) SetFollowProtocol(domain string, isFollowProtocol bool) error
- func (cli *Client) SetHttpHeader(domain string, httpHeaders []api.HttpHeader) error
- func (cli *Client) SetIpACL(domain string, blackList []string, whiteList []string) error
- func (cli *Client) SetLimitRate(domain string, limitRate int) error
- func (cli *Client) SetMediaDrag(domain string, mediaDragConf *api.MediaDragConf) error
- func (cli *Client) SetMobileAccess(domain string, distinguishClient bool) error
- func (cli *Client) SetRangeSwitch(domain string, enabled bool) error
- func (cli *Client) SetRefererACL(domain string, blackList []string, whiteList []string, isAllowEmpty bool) error
Constants ¶
const (
DEFAULT_SERVICE_DOMAIN = "cdn.baidubce.com"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
Client of CDN service is a kind of BceClient, so derived from BceClient
func NewClient ¶
NewClient make the CDN service client with default configuration Use `cli.Config.xxx` to access the config or change it to non-default value
func (*Client) CreateDomain ¶
func (cli *Client) CreateDomain(domain string, originInit *api.OriginInit) (*api.DomainCreatedInfo, error)
CreateDomain - add a specified domain into CDN service For details, please refer https://cloud.baidu.com/doc/CDN/s/gjwvyex4o
PARAMS:
- domain: the specified domain
- originInit: initialized data for a CDN domain
RETURNS:
- *DomainCreatedInfo: the details about created a CDN domain
- error: nil if success otherwise the specific error
func (*Client) DeleteDomain ¶
DeleteDomain - delete a specified domain from BCE CDN system. For details, please refer https://cloud.baidu.com/doc/CDN/s/Njwvyey7f
PARAMS:
- domain: the specified domain
RETURNS:
- error: nil if success otherwise the specific error
func (*Client) DisableDomain ¶
DisableDomain - disable a specified domain For details, please refer https://cloud.baidu.com/doc/CDN/s/9jwvyew3e
PARAMS:
- domain: the specified domain
RETURNS:
- error: nil if success otherwise the specific error
func (*Client) DisableDsa ¶
DisableDsa - disable DSA For details, please refer https://cloud.baidu.com/doc/CDN/s/7jwvyf1h5
RETURNS:
- error: nil if success otherwise the specific error
func (*Client) EnableDomain ¶
EnableDomain - enable a specified domain For details, please refer https://cloud.baidu.com/doc/CDN/s/Jjwvyexv8
PARAMS:
- domain: the specified domain
RETURNS:
- error: nil if success otherwise the specific error
func (*Client) EnableDsa ¶
EnableDsa - enable DSA For details, please refer https://cloud.baidu.com/doc/CDN/s/7jwvyf1h5
RETURNS:
- error: nil if success otherwise the specific error
func (*Client) GetAccessLimit ¶
func (cli *Client) GetAccessLimit(domain string) (*api.AccessLimit, error)
GetAccessLimit - get the qps setting For details, please refer https://cloud.baidu.com/doc/CDN/s/rjy6v3tnr
PARAMS:
- domain: the specified domain
RETURNS:
- *AccessLimit: the access setting
- error: nil if success otherwise the specific error
func (*Client) GetAvgSpeed ¶
func (cli *Client) GetAvgSpeed(queryCondition *api.QueryCondition) ([]api.AvgSpeedDetail, error)
GetAvgSpeed - get the average speed For details, please refer https://cloud.baidu.com/doc/CDN/s/5jwvyf8zn#%E6%9F%A5%E8%AF%A2%E5%B9%B3%E5%9D%87%E9%80%9F%E7%8E%87
PARAMS:
- queryCondition: the querying conditions
RETURNS:
- []AvgSpeedDetail: the detail list about the average speed
- error: nil if success otherwise the specific error
func (*Client) GetAvgSpeedByRegion ¶
func (cli *Client) GetAvgSpeedByRegion(queryCondition *api.QueryCondition, prov string, isp string) ([]api.AvgSpeedRegionDetail, error)
GetAvgSpeed - get the average speed filter by location For details, please refer https://cloud.baidu.com/doc/CDN/s/5jwvyf8zn#%E5%AE%A2%E6%88%B7%E7%AB%AF%E8%AE%BF%E9%97%AE%E5%88%86%E5%B8%83%E6%9F%A5%E8%AF%A2%E5%B9%B3%E5%9D%87%E9%80%9F%E7%8E%87
PARAMS:
- queryCondition: the querying conditions
- prov: the specified area, like "beijing"
- isp: the specified ISP, like "ct"
RETURNS:
- []AvgSpeedRegionDetail: the detail list about the average speed
- error: nil if success otherwise the specific error
func (*Client) GetCacheOpRecords ¶
func (cli *Client) GetCacheOpRecords(queryData *api.CRecordQueryData) (*api.RecordDetails, error)
GetCacheOpRecords get the history operating records For details, please refer https://cloud.baidu.com/doc/CDN/s/5jypnzjqt
PARAMS:
- queryData: querying conditions, it contains the time interval, the task type and the specified url
RETURNS:
- *RecordDetails: the details about the records
- error: nil if success otherwise the specific error
func (*Client) GetCacheTTL ¶
GetCacheTTL - get the current cached setting For details, please refer https://cloud.baidu.com/doc/CDN/s/ljxzhl9bu
PARAMS:
- domain: the specified domain
RETURNS:
- []CacheTTL: the cache setting list
- error: nil if success otherwise the specific error
func (*Client) GetCacheUrlArgs ¶
func (cli *Client) GetCacheUrlArgs(domain string) (*api.CacheUrlArgs, error)
GetCacheUrlArgs - get the cached rules For details, please refer https://cloud.baidu.com/doc/CDN/s/sjxzhsb6h
PARAMS:
- domain: the specified domain
RETURNS:
- *CacheUrlArgs: the details about cached rules
- error: nil if success otherwise the specific error
func (*Client) GetClientIp ¶
GetClientIp - get the setting about getting client IP For details, please refer https://cloud.baidu.com/doc/CDN/s/8jy6urcq5
PARAMS:
- domain: the specified domain
RETURNS:
- *ClientIp: the HTTP header setting for origin server to get client IP
- error: nil if success otherwise the specific error
func (*Client) GetContentEncoding ¶
GetContentEncoding - get the setting about Content-Encoding For details, please refer https://cloud.baidu.com/doc/CDN/s/bjyqycw8g
PARAMS:
- domain: the specified domain
RETURNS:
- string: the encoding algorithm for transferring, empty means disable encoding in transferring
- error: nil if success otherwise the specific error
func (*Client) GetCors ¶
GetCors - get the Cors setting For details, please refer https://cloud.baidu.com/doc/CDN/s/tjxzi2d7t
PARAMS:
- domain: the specified domain
RETURNS:
- *CorsCfg: the Cors setting
- error: nil if success otherwise the specific error
func (*Client) GetDomainConfig ¶
func (cli *Client) GetDomainConfig(domain string) (*api.DomainConfig, error)
GetDomainConfig - get the configuration for the specified domain. For details, please refer https://cloud.baidu.com/doc/CDN/s/2jwvyf39o
PARAMS:
- domain: the specified domain
RETURNS:
- *DomainConfig: the configuration about the specified domain
- error: nil if success otherwise the specific error
func (*Client) GetDomainHttps ¶
func (cli *Client) GetDomainHttps(domain string) (*api.HTTPSConfig, error)
GetDomainHttps - get the setting about HTTPS
PARAMS:
- domain: the specified domain
RETURNS:
- *HTTPSConfig: the rules about the HTTP configure
- error: nil if success otherwise the specific error
func (*Client) GetDomainLog ¶
func (cli *Client) GetDomainLog(domain string, timeInterval api.TimeInterval) ([]api.LogEntry, error)
GetDomainLog -get one domain's log urls For details, please refer https://cloud.baidu.com/doc/CDN/s/cjwvyf0r9
PARAMS:
- domain: the specified domain
- timeInterval: the specified time interval
RETURNS:
- []LogEntry: the log detail list
- error: nil if success otherwise the specific error
func (*Client) GetDomainSeo ¶
GetDomainSeo - retrieve the setting about SEO There are two types of data that the server responds to 1. `{"seoSwitch":[]}` indicates no setting about SEO 2. `{"seoSwitch":{"diretlyOrigin":"ON","pushRecord":"OFF"}}` indicates it had normal setting about SEO. So the code need to handle the complex affairs
For details, please refer https://cloud.baidu.com/doc/CDN/s/Djxzjfz8f
PARAMS:
- domain: the specified domain
RETURNS:
- *SeoSwitch: the setting about SEO
- error: nil if success otherwise the specific error
func (*Client) GetDomainStatus ¶
GetDomainStatus - get domains' details For details, please refer https://cloud.baidu.com/doc/CDN/s/8jwvyewf1
PARAMS:
- status: the specified running status, the available values are "RUNNING", "STOPPED", OPERATING or "ALL"
- rule: the regex matching rule
RETURNS:
- []DomainStatus: domain details list
- error: nil if success otherwise the specific error
func (*Client) GetError ¶
func (cli *Client) GetError(queryCondition *api.QueryCondition) ([]api.ErrorDetail, error)
GetError - get the error code's data For details, please refer https://cloud.baidu.com/doc/CDN/s/5jwvyf8zn#cdn%E9%94%99%E8%AF%AF%E7%A0%81%E5%88%86%E7%B1%BB%E7%BB%9F%E8%AE%A1%E6%9F%A5%E8%AF%A2
PARAMS:
- queryCondition: the querying conditions
RETURNS:
- []ErrorDetail: the top N error details
- error: nil if success otherwise the specific error
func (*Client) GetErrorPage ¶
GetErrorPage - get the custom pages' setting For details, please refer https://cloud.baidu.com/doc/CDN/s/qjy6vfk2u
PARAMS:
- domain: the specified domain
RETURNS:
- []ErrorPage: the pages' setting
- error: nil if success otherwise the specific error
func (*Client) GetFileTrim ¶
GetFileTrim - get the trim setting about text file For details, please refer https://cloud.baidu.com/doc/CDN/s/Ujy6vjxnl
PARAMS:
- domain: the specified domain
RETURNS:
- bool: true means trimming the text file, false means do nothing
- error: nil if success otherwise the specific error
func (*Client) GetFlow ¶
func (cli *Client) GetFlow(queryCondition *api.QueryCondition, level string) ([]api.FlowDetail, error)
GetFlow - get the flow data For details, please refer https://cloud.baidu.com/doc/CDN/s/5jwvyf8zn#%E6%9F%A5%E8%AF%A2%E6%B5%81%E9%87%8F%E3%80%81%E5%B8%A6%E5%AE%BD
PARAMS:
- queryCondition: the querying conditions
RETURNS:
- []FlowDetail: the detail list about flow
- error: nil if success otherwise the specific error
func (*Client) GetFlowByProtocol ¶
func (cli *Client) GetFlowByProtocol(queryCondition *api.QueryCondition, protocol string) ([]api.FlowDetail, error)
GetFlowByProtocol - get the flow data filter by protocol For details, please refer https://cloud.baidu.com/doc/CDN/s/5jwvyf8zn#%E6%9F%A5%E8%AF%A2%E6%B5%81%E9%87%8F%E3%80%81%E5%B8%A6%E5%AE%BD%E5%88%86%E5%8D%8F%E8%AE%AE
PARAMS:
- queryCondition: the querying conditions
- protocol: the specified HTTP protocol, like "http" or "https", "all" means both "http" and "https"
RETURNS:
- []FlowDetail: the detail list about flow
- error: nil if success otherwise the specific error
func (*Client) GetFlowByRegion ¶
func (cli *Client) GetFlowByRegion(queryCondition *api.QueryCondition, prov string, isp string) ([]api.FlowRegionDetail, error)
GetFlowByRegion - get the flow data filter by location. For details, please refer https://cloud.baidu.com/doc/CDN/s/5jwvyf8zn#%E6%9F%A5%E8%AF%A2%E6%B5%81%E9%87%8F%E3%80%81%E5%B8%A6%E5%AE%BD%EF%BC%88%E5%88%86%E5%AE%A2%E6%88%B7%E7%AB%AF%E8%AE%BF%E9%97%AE%E5%88%86%E5%B8%83%EF%BC%89
PARAMS:
- queryCondition: the querying conditions
- prov: the specified area, like "beijing"
- isp: the specified ISP, like "ct"
RETURNS:
- []FlowRegionDetail: the detail list about flow
- error: nil if success otherwise the specific error
func (*Client) GetHttpCode ¶
func (cli *Client) GetHttpCode(queryCondition *api.QueryCondition) ([]api.HttpCodeDetail, error)
GetHttpCode - get the http code's statistics For details, please refer https://cloud.baidu.com/doc/CDN/s/5jwvyf8zn#%E7%8A%B6%E6%80%81%E7%A0%81%E7%BB%9F%E8%AE%A1%E6%9F%A5%E8%AF%A2
PARAMS:
- queryCondition: the querying conditions
RETURNS:
- []HttpCodeDetail: the detail list about http code
- error: nil if success otherwise the specific error
func (*Client) GetHttpCodeByRegion ¶
func (cli *Client) GetHttpCodeByRegion(queryCondition *api.QueryCondition, prov string, isp string) ([]api.HttpCodeRegionDetail, error)
GetHttpCodeByRegion - get the http code's statistics filter by location For details, please refer https://cloud.baidu.com/doc/CDN/s/5jwvyf8zn#%E7%8A%B6%E6%80%81%E7%A0%81%E7%BB%9F%E8%AE%A1%E6%9F%A5%E8%AF%A2%EF%BC%88%E5%88%86%E5%AE%A2%E6%88%B7%E7%AB%AF%E8%AE%BF%E9%97%AE%E5%88%86%E5%B8%83%EF%BC%89
PARAMS:
- queryCondition: the querying conditions
- prov: the specified area, like "beijing"
- isp: the specified ISP, like "ct"
RETURNS:
- []HttpCodeRegionDetail: the detail list about http code
- error: nil if success otherwise the specific error
func (*Client) GetHttpHeader ¶
func (cli *Client) GetHttpHeader(domain string) ([]api.HttpHeader, error)
GetHttpHeader - get the HTTP headers' setting For details, please refer https://cloud.baidu.com/doc/CDN/s/6jxzip3wn
PARAMS:
- domain: the specified domain
RETURNS:
- error: nil if success otherwise the specific error
- []HttpHeader: the HTTP headers in setting
func (*Client) GetIpACL ¶
GetIpACL - get black IP or white IP For details, please refer https://cloud.baidu.com/doc/CDN/s/jjzkp5ku7
PARAMS:
- domain: the specified domain
RETURNS:
- *api.IpACL: ip setting
- error: nil if success otherwise the specific error
func (*Client) GetIpInfo ¶
GetIpInfo - retrieves information about the specified IP For details, please refer https://cloud.baidu.com/doc/CDN/s/8jwvyeunq
PARAMS:
- ip: the specified ip addr
- action: the action for operating the ip addr
RETURNS:
- *IpInfo: the information about the specified ip addr
- error: nil if success otherwise the specific error
func (*Client) GetMediaDrag ¶
func (cli *Client) GetMediaDrag(domain string) (*api.MediaDragConf, error)
GetMediaDrag - get the media setting For details, please refer https://cloud.baidu.com/doc/CDN/s/Ojy6v9q8f
PARAMS:
- domain: the specified domain
RETURNS:
- *MediaDragConf: the media setting about mp4 and flv
- error: nil if success otherwise the specific error
func (*Client) GetMobileAccess ¶
GetMobileAccess - get the setting about distinguishing the client or not For details, please refer https://cloud.baidu.com/doc/CDN/s/Mjy6vo9z2
PARAMS:
- domain: the specified domain
RETURNS:
- bool: true means distinguishing the client, false means not
- error: nil if success otherwise the specific error
func (*Client) GetMultiDomainLog ¶
GetMultiDomainLog - get many domains' log urls For details, please refer https://cloud.baidu.com/doc/CDN/s/cjwvyf0r9
PARAMS:
- queryData: the querying conditions
- error: nil if success otherwise the specific error
func (*Client) GetPrefetchStatus ¶
func (cli *Client) GetPrefetchStatus(queryData *api.CStatusQueryData) (*api.PrefetchStatus, error)
GetPrefetchStatus - get the prefetch progress For details, please refer https://cloud.baidu.com/doc/CDN/s/4jwvyf01w
PARAMS:
- queryData: querying conditions, it contains the time interval, the task ID and the specified url.
RETURNS:
- *PrefetchStatus: the details about the prefetch
- error: nil if success otherwise the specific error
func (*Client) GetPurgedStatus ¶
func (cli *Client) GetPurgedStatus(queryData *api.CStatusQueryData) (*api.PurgedStatus, error)
GetPurgedStatus - get the purged progress For details, please refer https://cloud.baidu.com/doc/CDN/s/ujwvyezqm
PARAMS:
- queryData: querying conditions, it contains the time interval, the task ID and the specified url
RETURNS:
- *PurgedStatus: the details about the purged
- error: nil if success otherwise the specific error
func (*Client) GetPv ¶
GetPv - get the PV data For details, please refer https://cloud.baidu.com/doc/CDN/s/5jwvyf8zn#pvqps%E6%9F%A5%E8%AF%A2
PARAMS:
- queryCondition: the querying conditions
- level: the node level, the available values are "edge", "internal" and "all"
RETURNS:
- []PvDetail: the detail list about page view
- error: nil if success otherwise the specific error
func (*Client) GetPvByRegion ¶
func (cli *Client) GetPvByRegion(queryCondition *api.QueryCondition, prov string, isp string) ([]api.PvRegionDetail, error)
GetAvgPvByRegion - get the PV data filter by location For details, please refer https://cloud.baidu.com/doc/CDN/s/5jwvyf8zn#%E6%9F%A5%E8%AF%A2pvqps%E5%88%86%E5%AE%A2%E6%88%B7%E7%AB%AF%E8%AE%BF%E9%97%AE%E5%88%86%E5%B8%83
PARAMS:
- queryCondition: the querying conditions
- prov: the specified area, like "beijing"
- isp: the specified ISP, like "ct"
RETURNS:
- []PvRegionDetail: the detail list about page view
- error: nil if success otherwise the specific error
func (*Client) GetPvHit ¶
GetPvHit - get the detail about PV hit rate. For details, please refer https://cloud.baidu.com/doc/CDN/s/5jwvyf8zn#%E8%AF%B7%E6%B1%82%E5%91%BD%E4%B8%AD%E7%8E%87%E6%9F%A5%E8%AF%A2
PARAMS:
- queryCondition: the querying conditions
RETURNS:
- []HitDetail: the detail list about pv rate
- error: nil if success otherwise the specific error
func (*Client) GetQuota ¶
func (cli *Client) GetQuota() (*api.QuotaDetail, error)
GetQuota - get the quota about purge and prefetch For details, please refer https://cloud.baidu.com/doc/CDN/s/zjwvyeze3
RETURNS:
- QuotaDetail: the quota details about a specified user
- error: nil if success otherwise the specific error
func (*Client) GetRangeSwitch ¶
GetRangeSwitch - get the range setting For details, please refer https://cloud.baidu.com/doc/CDN/s/5jxzid6o9
PARAMS:
- domain: the specified domain
RETURNS:
- bool: true means enable range cached, false means disable range cached
- error: nil if success otherwise the specific error
func (*Client) GetRealHit ¶
GetRealHit - get the detail about byte hit rate For details, please refer https://cloud.baidu.com/doc/CDN/s/5jwvyf8zn#%E5%AD%97%E8%8A%82%E5%91%BD%E4%B8%AD%E7%8E%87%E6%9F%A5%E8%AF%A2
PARAMS:
- queryCondition: the querying conditions
RETURNS:
- []HitDetail: the detail list about byte rate
- error: nil if success otherwise the specific error
func (*Client) GetRefererACL ¶
func (cli *Client) GetRefererACL(domain string) (*api.RefererACL, error)
GetRefererACL - get referer ACL setting For details, please refer https://cloud.baidu.com/doc/CDN/s/Ujzkotvtb
PARAMS:
- domain: the specified domain
RETURNS:
- *api.RefererACL: referer ACL setting
- error: nil if success otherwise the specific error
func (*Client) GetSrcFlow ¶
func (cli *Client) GetSrcFlow(queryCondition *api.QueryCondition) ([]api.FlowDetail, error)
GetSrcFlow - get the flow data in backed to sourced server For details, please refer https://cloud.baidu.com/doc/CDN/s/5jwvyf8zn#%E6%9F%A5%E8%AF%A2%E5%9B%9E%E6%BA%90%E6%B5%81%E9%87%8F%E3%80%81%E5%9B%9E%E6%BA%90%E5%B8%A6%E5%AE%BD
PARAMS:
- queryCondition: the querying conditions
RETURNS:
- []FlowDetail: the detail list about flow
- error: nil if success otherwise the specific error
func (*Client) GetSrcHttpCode ¶
func (cli *Client) GetSrcHttpCode(queryCondition *api.QueryCondition) ([]api.HttpCodeDetail, error)
GetSrcHttpCode - get the http code's statistics in backed to sourced server For details, please refer https://cloud.baidu.com/doc/CDN/s/5jwvyf8zn#%E5%9B%9E%E6%BA%90%E7%8A%B6%E6%80%81%E7%A0%81%E6%9F%A5%E8%AF%A2
PARAMS:
- queryCondition: the querying conditions
RETURNS:
- []HttpCodeDetail: the detail list about http code
- error: nil if success otherwise the specific error
func (*Client) GetSrcPv ¶
GetSrcPv - get the PV data in back to the sourced server For details, please refer https://cloud.baidu.com/doc/CDN/s/5jwvyf8zn#%E5%9B%9E%E6%BA%90pvqps%E6%9F%A5%E8%AF%A2
PARAMS:
- queryCondition: the querying conditions
RETURNS:
- []PvDetail: the detail list about page view
- error: nil if success otherwise the specific error
func (*Client) GetTopNDomains ¶
func (cli *Client) GetTopNDomains(queryCondition *api.QueryCondition, httpCode string) ([]api.TopNDetail, error)
GetTopNDomains - get the top N domains that equested For details, please refer https://cloud.baidu.com/doc/CDN/s/5jwvyf8zn#topn-domains
PARAMS:
- queryCondition: the querying conditions
- httpCode: the specified HTTP code, like "200"
RETURNS:
- []TopNDetail: the top N domains' detail
- error: nil if success otherwise the specific error
func (*Client) GetTopNReferers ¶
func (cli *Client) GetTopNReferers(queryCondition *api.QueryCondition, httpCode string) ([]api.TopNDetail, error)
GetTopNReferers - get the top N urls that brought by requested For details, please refer https://cloud.baidu.com/doc/CDN/s/5jwvyf8zn#topn-referers
PARAMS:
- queryCondition: the querying conditions
- httpCode: the specified HTTP code, like "200"
RETURNS:
- []TopNDetail: the top N referer urls' detail
- error: nil if success otherwise the specific error
func (*Client) GetTopNUrls ¶
func (cli *Client) GetTopNUrls(queryCondition *api.QueryCondition, httpCode string) ([]api.TopNDetail, error)
GetTopNUrls - get the top N urls that requested For details, please refer https://cloud.baidu.com/doc/CDN/s/5jwvyf8zn#topn-urls
PARAMS:
- queryCondition: the querying conditions
- httpCode: the specified HTTP code, like "200"
RETURNS:
- []TopNDetail: the top N urls' detail
- error: nil if success otherwise the specific error
func (*Client) GetUv ¶
GetUv - get the UV data For details, please refer https://cloud.baidu.com/doc/CDN/s/5jwvyf8zn#uv%E6%9F%A5%E8%AF%A2
PARAMS:
- queryCondition: the querying conditions
RETURNS:
- []UvDetail: the detail list about unique visitor
- error: nil if success otherwise the specific error
func (*Client) IsValidDomain ¶
func (cli *Client) IsValidDomain(domain string) (*api.DomainValidInfo, error)
IsValidDomain - check the specified domain whether it can be added to CDN service or not. For details, please refer https://cloud.baidu.com/doc/CDN/s/qjwvyexh6
PARAMS:
- domain: the specified domain
RETURNS:
- *DomainValidInfo: available information about the specified domain
- error: nil if success otherwise the specific error
func (*Client) ListDomains ¶
ListDomains - list all domains that in CDN service For details, please refer https://cloud.baidu.com/doc/CDN/s/sjwvyewt1
PARAMS:
- marker: a marker is a start point of searching
RETURNS:
- []string: domains belongs to the user
- string: a marker for next searching, empty if is in the end
- error: nil if success otherwise the specific error
func (*Client) ListDsaDomains ¶
ListDsaDomains - retrieve all the domains in DSA service For details, please refer https://cloud.baidu.com/doc/CDN/s/5jwvyf1sq
RETURNS:
- []DSADomain: the details about DSA domains
- error: nil if success otherwise the specific error
func (*Client) Prefetch ¶
func (cli *Client) Prefetch(tasks []api.PrefetchTask) (api.PrefetchId, error)
Prefetch - tells the CDN system to prefetch the specified files For details, please refer https://cloud.baidu.com/doc/CDN/s/Rjwvyf0ff
PARAMS:
- tasks: the tasks about prefetch the files from the CDN nodes
- error: nil if success otherwise the specific error
func (*Client) Purge ¶
Purge - tells the CDN system to purge the specified files For more details, please refer https://cloud.baidu.com/doc/CDN/s/ijwvyeyyj
PARAMS:
- tasks: the tasks about purging the files from the CDN nodes
RETURNS:
- PurgedId: an ID representing a purged task, using it to search the task progress
- error: nil if success otherwise the specific error.
func (*Client) SetAccessLimit ¶
func (cli *Client) SetAccessLimit(domain string, accessLimit *api.AccessLimit) error
SetAccessLimit - set the qps for on one client For details, please refer https://cloud.baidu.com/doc/CDN/s/Kjy6v02wt
PARAMS:
- domain: the specified domain
- accessLimit: the access setting
RETURNS:
- error: nil if success otherwise the specific error
func (*Client) SetCacheTTL ¶
SetCacheTTL - add some rules for cached setting For details, please refer https://cloud.baidu.com/doc/CDN/s/wjxzhgxnx
PARAMS:
- domain: the specified domain
- cacheTTLs: the cache setting list
RETURNS:
- error: nil if success otherwise the specific error
func (*Client) SetCacheUrlArgs ¶
func (cli *Client) SetCacheUrlArgs(domain string, cacheFullUrl *api.CacheUrlArgs) error
SetCacheUrlArgs - tell the CDN system cache the url's params or not For details, please refer https://cloud.baidu.com/doc/CDN/s/vjxzho0kx
PARAMS:
- domain: the specified domain
- cacheFullUrl: whether cache the full url or not, full url means include params, also some extra params can be avoided
RETURNS:
- error: nil if success otherwise the specific error
func (*Client) SetClientIp ¶
SetClientIp - set the specified HTTP header for the origin server For details, please refer https://cloud.baidu.com/doc/CDN/s/Kjy6umyrm
PARAMS:
- domain: the specified domain
- clientIp: header setting
RETURNS:
- error: nil if success otherwise the specific error
func (*Client) SetContentEncoding ¶
SetContentEncoding - set Content-Encoding For details, please refer https://cloud.baidu.com/doc/CDN/s/0jyqyahsb
PARAMS:
- domain: the specified domain
- enabled: true means using the specified encoding algorithm indicated by "encodingType" in transferring, false means disable encoding
RETURNS:
- error: nil if success otherwise the specific error
func (*Client) SetCors ¶
SetCors - set about Cross-origin resource sharing For details, please refer https://cloud.baidu.com/doc/CDN/s/Rjxzi1cfs PARAMS:
- domain: the specified domain
- isAllow: true means allow Cors, false means not allow
- originList: the origin setting, it's invalid when isAllow is false
RETURNS:
- error: nil if success otherwise the specific error
func (*Client) SetDomainHttps ¶
func (cli *Client) SetDomainHttps(domain string, httpsConfig *api.HTTPSConfig) error
SetDomainHttps - set a rule for speed HTTPS' request For details, please refer https://cloud.baidu.com/doc/CDN/s/rjy6v3tnr
PARAMS:
- domain: the specified domain
- httpsConfig: the rules about the HTTP configure
RETURNS:
- error: nil if success otherwise the specific error
func (*Client) SetDomainOrigin ¶
func (cli *Client) SetDomainOrigin(domain string, origins []api.OriginPeer, defaultHost string) error
SetDomainOrigin - set the origin setting for the new For details, please refer https://cloud.baidu.com/doc/CDN/s/xjxzi7729
PARAMS:
- domain: the specified domain
- origins: the origin servers
- defaultHost: the default host
RETURNS:
- error: nil if success otherwise the specific error
func (*Client) SetDomainRequestAuth ¶
func (cli *Client) SetDomainRequestAuth(domain string, requestAuth *api.RequestAuth) error
SetDomainRequestAuth - set the authorized rules for requesting For details, please refer https://cloud.baidu.com/doc/CDN/s/njxzi59g9
PARAMS:
- domain: the specified domain
- requestAuth: the rules about the auth
RETURNS:
- error: nil if success otherwise the specific error
func (*Client) SetDomainSeo ¶
SetDomainSeo - set SEO setting For details, please refer https://cloud.baidu.com/doc/CDN/s/Jjxziuq4y
PARAMS:
- domain: the specified domain
- seoSwitch: the setting about SEO
RETURNS:
- error: nil if success otherwise the specific error
func (*Client) SetDsaConfig ¶
SetDsaConfig - set the DSA configuration For details, please refer https://cloud.baidu.com/doc/CDN/s/0jwvyf26d
PARAMS:
- domain: the specified domain
- dsaConfig: the specified configuration for the specified domain
RETURNS:
- error: nil if success otherwise the specific error
func (*Client) SetErrorPage ¶
SetErrorPage - set the page that redirected to when error occurred For details, please refer https://cloud.baidu.com/doc/CDN/s/Ejy6vc4yb
PARAMS:
- domain: the specified domain
- errorPages: the custom pages' setting
RETURNS:
- error: nil if success otherwise the specific error
func (*Client) SetFileTrim ¶
SetFileTrim - trim the text file or not For details, please refer https://cloud.baidu.com/doc/CDN/s/Xjy6vimct
PARAMS:
- domain: the specified domain
- fileTrim: true means trimming the text file, false means do nothing
RETURNS:
- error: nil if success otherwise the specific error
func (*Client) SetFollowProtocol ¶
SetFollowProtocol - set whether using the same protocol or not when back to the sourced server For details, please refer https://cloud.baidu.com/doc/CDN/s/9jxzi89k2
PARAMS:
- domain: the specified domain
- isFollowProtocol: true in using the same protocol or not when back to the sourced server, false for other
RETURNS:
- error: nil if success otherwise the specific error
func (*Client) SetHttpHeader ¶
func (cli *Client) SetHttpHeader(domain string, httpHeaders []api.HttpHeader) error
SetHttpHeader -set some HTTP headers which can be added or deleted when response form CDN edge node For details, please refer https://cloud.baidu.com/doc/CDN/s/Jjxzil1sd
PARAMS:
- domain: the specified domain
- httpHeaders: the HTTP headers' setting
RETURNS:
- error: nil if success otherwise the specific error
func (*Client) SetIpACL ¶
SetRefererACL - set a rule for filter some HTTP request, blackList and whiteList only one can be set For details, please refer https://cloud.baidu.com/doc/CDN/s/8jxzhwc4d
PARAMS:
- domain: the specified domain
- blackList: the forbidden ip
- whiteList: the available ip
RETURNS:
- error: nil if success otherwise the specific error
func (*Client) SetLimitRate ¶
SetLimitRate - set limited speed For details, please refer https://cloud.baidu.com/doc/CDN/s/Kjy6v02wt
PARAMS:
- domain: the specified domain
- limitRate: the limited rate, "1024" means the transmittal speed is less than 1024 Byte/s
RETURNS:
- error: nil if success otherwise the specific error
func (*Client) SetMediaDrag ¶
func (cli *Client) SetMediaDrag(domain string, mediaDragConf *api.MediaDragConf) error
SetMediaDrag - set the media setting about mp4 and flv For details, please refer https://cloud.baidu.com/doc/CDN/s/4jy6v6xk3
PARAMS:
- domain: the specified domain
- mediaDragConf: media setting about mp4 and flv
RETURNS:
- error: nil if success otherwise the specific error
func (*Client) SetMobileAccess ¶
SetMobileAccess - distinguish the client or not For details, please refer https://cloud.baidu.com/doc/CDN/s/Mjy6vmv6g
PARAMS:
- domain: the specified domain
- distinguishClient: true means distinguishing the client, false means not
RETURNS:
- error: nil if success otherwise the specific error
func (*Client) SetRangeSwitch ¶
SetRangeSwitch - set the range setting For details, please refer https://cloud.baidu.com/doc/CDN/s/Fjxziabst
PARAMS:
- domain: the specified domain
- enabled: true means enable range cached, false means disable range cached
RETURNS:
- error: nil if success otherwise the specific error
func (*Client) SetRefererACL ¶
func (cli *Client) SetRefererACL(domain string, blackList []string, whiteList []string, isAllowEmpty bool) error
SetRefererACL - set a rule for filter some HTTP request, blackList and whiteList only one can be set For details, please refer https://cloud.baidu.com/doc/CDN/s/yjxzhvf21
PARAMS:
- domain: the specified domain
- blackList: the forbidden host
- whiteList: the available host
RETURNS:
- error: nil if success otherwise the specific error