CDN

  • CDN > API 文档 > 域名管理 >API 接口 >产品功能

    产品功能

    最近更新时间: 2023-12-06 15:56:08

    缓存策略

    结构

        {
    	    “cacheControls”: [
    		    {
    			   “time”: <CCTime>,
    			   "timeunit": <CCTimeUnit>,
    			   "timeunit": <CCType>,
    			   "timeunit": <CCRule>
    		    }
    	    ],
    	    "ignoreParam": <IgnoreParam>
        }
    
    
    参数 类型 必填 含义
    CCTime int 缓存时间,注意不论哪种时间单位,总时间都不能超过1年,type为follow,本字段配为 -1
    CCTimeUnit int 缓存时间单位:0(秒)/1(分钟)/2(小时)/3(天)/4(周)/5(月)/6(年),type为follow,本字段配为0
    CCType string 缓存类型:all(默认全局规则)/path(路径匹配)/suffix(后缀匹配)/follow(遵循源站)
    CCRule string 缓存路径规则:以分号;分割的字符串,每个里面类型一致,比如CCType为path的话,这里每个分号分割的都是以/开头,suffix的话,以点号.开头,如果是all类型,或者follow,统一只要填一个星号*
    IgnoreParam bool 是否开启去问号缓存,默认为false

    注意

    • 缓存配置优先级依从配置数组的前后顺序依次从高到低
    • 全局配置要放到最后,不然自定义规则缓存配置优先级最低
    • 如果是遵循源站配置follow,只能有一条,即全部遵循源站

    例子

    	// .abc, .jpg后缀文件缓存1分钟,/def, /auth 目录下文件不缓存,全局缓存一个月
    	// url参数不缓存
    	{
    	    "cacheControls": [
    		    {
    			    "time": 1,
    			    "timeunit": 1,
    			    "type": "suffix",
    			    "rule": ".abc;.jpg"
    			},
    			{
    			    "time": 0,
    			    "timeunit": 0,
    			    "type": "path",
    			    "rule": "/def;/auth"
    			},
    			{
    			    "time": 1,
    			    "timeunit": 5,
    			    "type": "all",
    			    "rule": "*"
    			}
    	    ],
    	    "ignoreParam": true
    	}
    
    
    	// 遵循源站
    	{
    	    "cacheControls": [
    		    {
    			   "time": 0,
    			    "timeunit": 0,
    			    "type": "follow",
    			    "rule": "*"
    			}
    	    ],
    	    "ignoreParam": false
    	}
    
    

    回源配置

    结构

    	{
    	    "sourceType": <SourceType>,
    	    "sourceHost": <SourceHost>,
    	    "sourceIPs": [<SourceIP>, ...],
    	    "sourceDomain": <SourceDomain>,
    	    "sourceQiniuBucket": <SourceQiniuBucket>,
    	    "sourceURLScheme": <SourceURLScheme>,
    	    "advancedSources": [
    	        {
    	            "addr": <ASAddr>,
    	            "weight": <ASWeight>,
    	            "backup": <ASBackup>
    	        }
    	    ],
    	    "testURLPath": <TestURLPath>
    	}
    
    
    参数 类型 必填 含义
    SourceType string 源站类型: domain(域名)/ip(ip地址)/qiniuBucket(七牛云存储,备注:不支持平台是动态加速)/advanced(高级)
    SourceHost string 回源Host, 普通域名默认SourceHost为域名本身,泛域名默认SourceHost为用户请求时的域名
    SourceIP []string 回源ip, sourceType为ip时sourceIPs必填
    SourceDomain string 回源域名, sourceType为domain时此字段必填
    SourceQiniuBucket string 回源的七牛云存储的bucket名称, sourceType为qiniuBucket时此字段必填
    SourceURLScheme string 回源协议, 仅用于https域名,可选值: http/https, 回源七牛bucket时本值无效,默认不填是follow请求协议
    ASAddr string 高级回源的回源地址, 可以是IP或者域名; 如需指定端口,可直接拼接在地址后面(示例: 1.1.1.1:8080), sourceType为advanced时advancedSources字段必填
    ASWeight int 高级回源的回源addr权重, 0 ~ 100, 按照权重比例回源,sourceType为advanced时advancedSources字段必填
    ASBackup bool 高级回源的回源addr是否为备源地址,sourceType为advanced时advancedSources字段必填
    TestURLPath string 用于测试的URL Path, 检测源站是否可访问, 大小建议小于1KB,采用静态资源,并请不要删除, 后面域名任何配置更改都会测试该资源, 用以保证域名的访问性

    注意

    • 高级回源模式中如配置了主备回源域名时,只有所有的主源都访问不了,才会访问备源
    • 高级回源模式中如设置了源站权重,请求概率=权重/权重总和,eg:有两个主线路A和B,A权重1 和 B权重3,那么四次请求,1次是A,3次是B

    referer 防盗链

    结构

    请求结构

    	{
    	    "refererType": <RefererType>,
    	    "refererValues": [<RefererValue>,...],
    	    "nullReferer": <NullReferer>
    	}
    
    
    参数 类型 必填 含义
    RefererType string Referer防盗链类型: black/white
    RefererValue string Referer防盗链黑白名单
    NullReferer bool Referer防盗链, 是否支持空referer,不填为false

    响应结构

    	{
    	    "refererType": <RefererType>,
    	    "refererValues": [<RefererValue>, ...],
    	    "nullReferer": <NullReferer>
    	}
    
    
    参数 类型 含义
    RefererType string Referer防盗链类型: black/white
    RefererValue string Referer防盗链黑白名单
    NullReferer bool Referer防盗链, 是否支持空referer

    注意

    • 请求结构和响应结构不同, 请求结构是指创建域名修改referer防盗链的请求采用的结构,响应结构是指, 获取域名信息获取域名列表中返回结果中采用的结构

    IP黑白名单

    结构

    请求结构

    	{
    	    "ipACLType": <IpACLType>,
    	    "ipACLValues": [<IpACLValue>,...]
    	}
    
    
    参数 类型 必填 含义
    IpACLType string ip黑白名单控制控制类型, black/white/"";其中空字符串""代表关闭本功能,此时请注意ipACLValues需要为空
    IpACLValue string ip黑白名单,ip格式为:127.0.0.1/24

    响应结构

    	{
    	    "ipACLType": <IpACLType>,
    	    "ipACLValues": [<IpACLValue>, ...]
    	}
    
    
    参数 类型 含义
    ipACLType string ip黑白名单控制类型, black/white
    IpACLValues string ip黑白名单, ip格式为:127.0.0.1/24

    注意

    • 请求结构和响应结构不同, 请求结构是指创建域名修改ip黑白名单的请求采用的结构,响应结构是指, 获取域名信息获取域名列表中返回结果中采用的结构

    时间戳防盗链

    结构

    	{
    	    "enable": <Enable>,
    	    "timeACLKeys": [<TimeACLKey>, ...],
    	    "checkUrl": <CheckUrl>
    	}
    
    
    参数 类型 必填 含义
    Enable bool 开启时间戳防盗链的开关
    TimeACLKey string 时间戳防盗链的加密key,该key字符长区间为[24,40],Enable为true时timeACLKeys必填2个key,Enable为false时 timeACLKeys不填
    CheckUrl string 根据时间戳防盗链加密算法生成的url,timeACL为true时本项必填, 用以验证是否真实了解该时间戳防盗链加密算法

    注意

    • 时间戳防盗链相关文档
    • 时间戳防盗链和回源鉴权是互斥功能,只能开启一个,其他不限

    回源鉴权

    结构

    	{
    	    "isQiniuPrivate": <IsQiniuPrivate>,
    	    "path": [<Path>, ...],
    	    "method": <Method>,
    	    "parameters": [<Parameter>, ...],
    	    "timeLimit": <TimeLimit>,
    	    "userAuthUrl": <UserAuthUrl>,
    	    "strict": <Strict>,
    	    "enable": <Enable>,
    	    "successStatusCode": <SuccessStatusCode>,
    	    "failureStatusCode": <FailureStatusCode>
    	}
    
    
    参数 类型 必填 含义
    IsQiniuPrivate bool 是否为七牛私有bucket鉴权,如果是七牛私有bucket,只需要打开 enable开关,本功能将随着回源鉴权功能使用
    Path string 要匹配这个回源鉴权的path,目前该功能还不支持, 如果使用七牛私有bucket鉴权,不需要填
    Method string 回源鉴权支持的http方法,GET/POST/HEAD, 如果使用七牛私有bucket鉴权,不需要填
    Parameter string 回源鉴权中参与鉴权的url 参数,取值取决于用户鉴权服务器的鉴权规则, 如果使用七牛私有bucket鉴权,不需要填
    TimeLimit int 回源鉴权的鉴权超时时间,单位ms, 最小 100ms(0.1s), 最大10000ms(10s), 如果使用七牛私有bucket鉴权,不需要填
    UserAuthUrl string 回源鉴权: 用户鉴权的鉴权服务地址, 如果使用七牛私有bucket鉴权,不需要填
    Strict bool 回源鉴权: 超时后,是否严格为鉴权失败, 如果使用七牛私有bucket鉴权,不需要填
    Enable bool 回源鉴权开关
    SuccessStatusCode int 回源鉴权: 鉴权通过的http code, 最小100,最大10000, 如果使用七牛私有bucket鉴权,不需要填
    FailureStatusCode int 回源鉴权: 鉴权失败的http code, 最小100,最大10000, 如果使用七牛私有bucket鉴权,不需要填

    注意

    • 时间戳防盗链和回源鉴权是互斥功能,只能开启一个,其他不限
    • 回源鉴权相关文档

    HTTPS

    结构

    	{
    		"certId": <CertID>,
    		"forceHttps": <ForceHttps>,
    		"http2Enable": <Http2Enable>
    	}
    
    
    参数 类型 必填 含义
    CertID string 证书ID, 如果Protocol是https, 则需要填写该证书id
    ForceHttps bool 是否开启强制https访问,即http访问时30x到https
    Http2Enable bool http2功能是否启用,false为关闭,true为开启

    注意

    • 证书id CertID 是通过上传证书获取的,也可以通过query自己的证书列表拿取证书id

    特殊配置

    结构

    	{
    		"enableFop": <EnableFop>,
    		"imageSlim": {
    		    "enableImageSlim": <EnableImageSlim>,
    		    "prefixImageSlims": [<PrefixImageSlim>,...],
    		    "regexpImageSlims": [<RegexpImageSlim>,...]
    		}
    	}
    
    
    参数 类型 必填 含义
    EnableFop bool 是否自动开启七牛fop图片处理(备注:不支持平台是动态加速)
    EnableImageSlim bool 是否自动开启图片瘦身(备注:不支持平台是动态加速)
    PrefixImageSlim string 图片瘦身匹配的指定目录, 例如/abc
    RegexpImageSlim string 图片瘦身匹配的指定的正则表达式, 例如.*png

    证书配置

    结构

    请求结构

    	{
    		"name": <CertName>,
    		"common_name":<CommonName>,
    		"pri": <Pri>,
    		"ca": <Ca>
    	}
    
    
    参数 类型 必填 含义
    CertName string 证书名称
    CommonName string 相关域名
    Pri string 证书私钥
    Ca string 证书内容

    响应结构

    	{
    		"id": <CertID>,
    		"name": <CertName>,
    		"common_name":<CommonName>,
    		"pri": <Pri>,
    		"ca": <Ca>
    	}
    
    
    参数 类型 含义
    CertID string 证书id
    CertName string 证书名称
    CommonName string 相关域名
    Pri string 证书私钥
    Ca string 证书内容

    注意

    • 请求结构和响应结构不同, 请求结构是指上传证书的请求采用的结构,响应结构是指, 获取证书获取证书列表中返回结果中采用的结构
    以上内容是否对您有帮助?
  • Qvm free helper
    Close