CDN

  • CDN > 产品手册 > CDN域名及证书相关接口文档

    CDN域名及证书相关接口文档

    最近更新时间:2020-01-09 11:55:23

    接入

    对外域名

    Host: api.qiniu.com

    授权

    Authorization: QBox <QBoxToken>

    详细描述见文档

    API 请求格式

    • RESTful api, 具体格式参考每个API定义

    API 响应格式

    • 响应成功的格式
    HTTP/1.1 200 OK
    {
        // 如果API下面包含有body的响应,会列出body的结构,否则说明响应不包含body
    }
    
    
    • 响应错误的格式
    HTTP/1.1 4xx/5xx
    {
        "code":<Code>, // 错误码在每个API下面都有列出, code为6位数字码,前三位与http code一致
        "error":<ErrorMessage>
    }
    
    

    接口

    域名相关

    创建域名

    用户创建普通及泛域名接口
    
    

    请求包

    POST /domain/<Name> HTTP/1.1
    Content-Type: application/json
    Authorization: QBox <QBoxToken>
    
    {
        // 基本配置
        type: <Type>,
        testURLPath: <TestURLPath>,
        platform: <Platform>,
        geoCover: <GeoCover>,
        protocol: <Protocol>,
    
        // 回源配置
        source: <Source>,
    
        // 缓存配置
        cache: <Cache>,
    
        // referer 防盗链
        referer: <Referer>,
    
        // ip 黑白名单
        ipACL: <IPACL>,
    
        // 时间戳防盗链
        timeACL: <TimeACL>,
    
        // 回源鉴权
        bsauth: <Bsauth>,
    
         // htttps 配置
        https: <HTTPS>,
    
        // 其他特殊配置
        external: <External>
    }
    
    
    参数解释

    基本参数

    参数 类型 必填 含义
    Name string 域名, 如果是泛域名,必须以点号 . 开头
    Type string 域名类型: normal(普通域名)/wildcard(泛域名)
    Platform string 平台类型: web(网页)/download(下载)/vod(点播)
    GeoCover string 地域: china/foreign/global
    Protocol string 协议: http/https
    TestURLPath string 用于测试的URL Path, 检测源站是否可访问, 大小建议小于1KB,采用静态资源,并请不要删除, 后面域名任何配置更改都会测试该资源, 用以保证域名的访问性

    回源参数

    Source结构请参考 回源配置

    缓存参数

    Cache结构请参考 缓存策略

    referer 防盗链参数

    Referer结构请参考 referer防盗链

    ip 黑白名单参数

    IPACL结构请参考 ip黑白名单

    时间戳防盗链参数

    TimeACL结构请参考 时间戳防盗链

    回源鉴权参数

    Bsauth结构请参考 回源鉴权

    HTTPS参数

    HTTPS结构请参考 HTTPS

    其他特殊配置参数

    External结构请参考 特殊配置

    返回包

    {}
    
    

    错误码

    错误码 含义
    400001 非法域名
    400005 未知的协议
    400020 域名未备案
    400040 非法的回源域名
    400044 非法的回源host
    400041 未知的回源ip
    400008 无此bucket
    400345 共享bucket不能绑定域名
    400043 未知的高级回源参数
    400022 未知的测试url
    400002 未知的回源类型
    400093 非法的域名类型
    400060 未知的referer防盗链类型
    400061 未知的referer防盗链参数
    400091 缓存参数有误
    400309 缓存规则未设置全局或者为遵循源站
    400204 时间戳防盗链key值数目不够
    400031 非法的url
    400203 已禁用的用户
    400541 获取用户信息失败
    401000 未实名认证的用户
    400801 未知的vendor
    400003 未知的平台类型
    400004 未知覆盖
    404911 非法的路径
    404912 非法的正则表达式
    400520 不能同时设置时间戳防盗链和回源鉴权
    400200 未知的bucket
    400521 非法的回源鉴权地址
    400522 非法的回源鉴权http方法
    400523 非法的回源鉴权http code
    400524 非法的回源鉴权超时时间
    400525 非法的回源鉴权url参数
    400401 无此证书
    400324 https证书解码失败
    400325 https证书解析失败
    400321 https证书还未生效
    400329 https证书过期
    400326 https证书与域名不匹配
    400327 解析https证书密钥失败
    400328 https证书与密钥不匹配
    400323 验证https证书链失败
    400549 只有https域名才能使用强制https跳转
    400621 泛域名及其子域名不能使用私有bucket
    400005 未知的协议
    400332 未知的回源协议
    500219 查询证书内部错误
    500005 数据查询内部出错
    500000 未知内部错误

    创建泛子域名

    用户创建泛子域名接口,泛子域名必须回源七牛云存储的bucket
    
    

    请求包

    POST /pandomain/<Name>
    Content-Type: application/json
    Authorization: QBox <QBoxToken>
    
    {
        bucket: <Bucket>,
        pareDomain: <PareDomain>,
    }
    
    
    参数解释
    参数 类型 必填 含义
    Name string 域名
    Bucket string 要绑定的bucket名称
    PareDomain string 泛子域名所属的泛域名名称

    返回包

    {}
    
    

    错误码

    错误码 含义
    400203 已禁用的用户
    400095 未知的父域名
    400008 无此bucket
    500011 pub域名到bucket失败
    500002 新增数据内部出错

    修改源站

    用户修改普通域名及泛域名源站接口
    
    

    请求包

    PUT /domain/<Name>/source
    
    {
        Source
        testURLPath: <TestURLPath>,
    }
    
    
    参数解释
    参数 类型 必填 含义
    Source object Source结构请参考 回源配置
    TestURLPath string 用于测试的 URL Path

    返回包

    {}
    
    

    错误码

    错误码 含义
    400001 非法域名
    404001 无此域名
    400093 非法的域名类型
    400801 未知的vendor
    400018 非法的cname
    400005 未知的协议
    400046 非法的url重写规则
    400022 非法的测试url
    400024 验证源站访问性失败
    500005 数据查询内部出错
    500019 非标准的回源cname

    修改缓存规则

    用户修改普通域名及泛域名缓存规则接口
    
    

    请求包

    PUT /domain/<Name>/cache
    Content-Type: application/json
    Authorization: QBox <QBoxToken>
    {
        Cache
    }
    
    
    参数解释
    参数 类型 必填 含义
    Cache object Cache结构请参考 缓存策略

    返回包

    {}
    
    

    错误码

    错误码 含义
    400001 未知的域名
    404001 无此域名
    400064 无权处理该域名
    400093 非法的域名类型
    400030 正在处理中
    400066 域名状态为失败
    400998 域名已下线
    400091 缓存参数有误
    400309 缓存规则未设置全局或者为遵循源站
    500005 数据查询内部出错
    500923 域名已冻结
    500930 删除中的域名

    下线域名

    用户下线普通及泛域名接口
    
    

    请求包

    POST /domain/<Name>/offline
    Authorization: QBox <QBoxToken>
    
    

    返回包

    {}
    
    

    错误码

    错误码 含义
    404001 无此域名
    400001 未知的域名
    400064 无权处理该域名
    400093 非法的域名类型
    400013 重复操作
    400030 正在处理中
    400066 域名状态为失败
    400018 非法的cname
    400397 cname和其他域名冲突
    500923 域名已冻结
    500005 数据查询内部出错

    上线域名

    用户上线普通及泛域名接口
    
    

    请求包

    POST /domain/<Name>/online
    Authorization: QBox <QBoxToken>
    
    

    返回包

    {}
    
    

    错误码

    错误码 含义
    404001 无此域名
    400001 未知的域名
    400064 无权处理该域名
    400093 非法的域名类型
    400013 重复操作
    400030 正在处理中
    400066 域名状态为失败
    400018 非法的cname
    400397 cname和其他域名冲突
    500004 更新数据内部出错
    500923 域名已冻结
    500005 数据查询内部出错
    500235 该域名未绑定证书

    删除域名

    用户删除普通及泛域名接口
    
    

    请求包

    DELETE /domain/<Name>
    Authorization: QBox <QBoxToken>
    
    

    返回包

    {}
    
    

    错误码

    错误码 含义
    404001 无此域名
    400001 未知的域名
    400064 无权处理该域名
    400013 重复操作
    400030 正在处理中
    400317 非已下线的域名
    400066 域名状态为失败
    400515 该泛域名还含有活跃的子域名
    500005 数据查询内部出错

    获取域名信息

    用户获取域名信息接口,所有域名适用
    
    

    请求包

    GET /domain/<Name>
    Authorization: QBox <QBoxToken>
    
    

    返回包

    {
        name: <Name>,
        type: <Type>,
        cname: <CName>,
        testURLPath: <TestURLPath>,
        platform: <Platform>,
        geoCover: <GeoCover>,
        protocol: <Protocol>,
        source: <Source>,
        cache: <Cache>,
        referer: <Referer>,
        ipACL: <IPACL>,
        timeACL: <TimeACL>,
        bsauth: <Bsauth>,
        operationType: <OperationType>,
        operatingState: <OperatingState>,
        operatingStateDesc: <OperatingStateDesc>,
        createAt: <CreateAt>,
        modifyAt: <ModifyAt>,
    }
    
    
    参数解释

    基本参数 请参考

    参数 类型 含义
    CName string 创建域名成功后七牛生成的域名,用户需要把 Name cname 到这个域名
    Referer object Referer结构请参考 referer防盗链
    IPACL object IPACL结构请参考 ip黑白名单
    TimeACL object TimeACL结构请参考 时间戳防盗链
    Bsauth object Bsauth结构请参考 回源鉴权
    Source object Source结构请参考 回源配置
    Cache object Cache结构请参考 缓存策略
    OperationType string 域名最近一次操作类型: create_domain/offline_domain/online_domain/ modify_source/modify_referer/modify_cache/ freeze_domain/unfreeze_domain/modify_timeacl(修改时间戳防盗链)/ modify_https_crt/sslize(升级HTTPS)/modify_bsauth(修改回源鉴权) /offline_bsauth(删除回源鉴权)
    OperatingState string 域名最近一次的操作状态: processing/success/failed/frozen/offlined
    OperatingStateDesc string 域名最近一次的操作状态的描述
    CreateAt string 域名创建时间,格式:RFC3339
    ModifyAt string 域名最后一次修改时间,格式:RFC3339

    错误码

    错误码 含义
    404001 无此域名
    400001 未知的域名
    400014 无权获取该域名
    500005 数据查询内部出错

    获取域名列表

    用户获取域名列表接口,所有域名适用
    
    

    请求包

    GET /domain?marker=<Marker>&limit=<Limit>
    Authorization: QBox <QBoxToken>
    
    
    参数解释
    参数 类型 含义
    Marker string 用于标示从哪个位置开始获取域名列表。不填或空表示从头开始
    Limit int 返回的最大域名个数。默认 200

    返回包

    {
        marker: <Marker>,
        domains: [
            {
                name: <Name>,
                type: <Type>,
                cname: <CName>,
                testURLPath: <TestURLPath>,
                platform: <Platform>,
                geoCover: <GeoCover>,
                protocol: <Protocol>,
                operatingState: <OperatingState>,
                operatingStateDesc: <OperatingStateDesc>,
                createAt: <CreateAt>,
                modifyAt: <ModifyAt>,
            },
            ...
        ]
    }
    
    
    参数解释

    基本参数 请参考

    参数 类型 含义
    Marker string 用于标示下一次从哪个位置开始获取域名列表
    CName string 创建域名成功后七牛生成的域名,用户需要把 Name cname 到这个域名
    TestURLPath string 域名的测试资源,需要保证这个资源是可访问的
    OperatingState string 域名最近一次的操作状态: processing/success/failed/frozen/offlined
    CreateAt string 域名创建时间,格式:RFC3339
    ModifyAt string 域名最后一次修改时间,格式:RFC3339

    错误码

    错误码 含义
    400021 非法的参数marker
    500005 数据查询内部出错

    HTTP升级为HTTPS

    HTTP升级为HTTPS
    
    

    请求包

    POST /domain/<Name>/sslize
    Authorization: QBox <QBoxToken>
    
    {
        certid:<CertID>
    }
    
    
    参数解释
    参数 类型 含义
    CertID string 证书id,从上传或者获取证书列表里拿到证书id

    返回包

    {}
    
    

    错误码

    错误码 含义
    400331 非法参数
    404001 无此域名
    400001 未知的域名
    400064 无权处理该域名
    400008 无此bucket
    400392 非法的域名cname
    400013 重复操作
    400030 正在处理中
    400066 域名状态为失败
    400401 无此证书
    400324 https证书解码失败
    400325 https证书解析失败
    400321 https证书还未生效
    400329 https证书过期
    400326 https证书与域名不匹配
    400327 解析https证书密钥失败
    400328 https证书与密钥不匹配
    400323 验证https证书链失败
    500219 查询证书内部错误
    500005 数据查询内部出错

    修改referer防盗链

    用户修改普通域名及泛域名referer防盗链接口
    
    

    请求包

    PUT /domain/<Name>/referer
    
    {
        Referer
    }
    
    
    参数解释
    参数 类型 必填 含义
    Referer object Referer结构请参考 referer防盗链

    返回包

    {}
    
    

    错误码

    错误码 含义
    404001 无此域名
    400001 未知的域名
    400064 无权处理该域名
    400008 无此bucket
    400013 重复操作
    400030 正在处理中
    400066 域名状态为失败
    400998 域名已下线
    500923 域名已冻结
    500930 删除中的域名
    400060 未知的referer防盗链类型
    400061 未知的referer防盗链参数
    500005 数据查询内部出错

    修改ip黑白名单

    用户修改普通域名及泛域名ip黑白名单接口
    
    

    请求包

    PUT /domain/<Name>/ipacl
    
    {
        IPACL
    }
    
    
    参数解释
    参数 类型 必填 含义
    IPACL object IPACL结构请参考 ip黑白名单

    返回包

    {}
    
    

    错误码

    错误码 含义
    404001 无此域名
    400001 未知的域名
    400064 无权处理该域名
    400008 无此bucket
    400013 重复操作
    400030 正在处理中
    400066 域名状态为失败
    400998 域名已下线
    500923 域名已冻结
    500930 删除中的域名
    400074 非法的ip黑白名单类型
    400075 非法的ip黑白名单参数
    500005 数据查询内部出错

    修改时间戳防盗链

    用户修改普通域名及泛域名时间戳防盗链接口
    
    

    请求包

    PUT /domain/<Name>/timacl
    
    {
        TimeACL
    }
    
    
    参数解释
    参数 类型 必填 含义
    TimeACL object TimeACL结构请参考 时间戳防盗链

    返回包

    {}
    
    

    错误码

    错误码 含义
    404001 无此域名
    400001 未知的域名
    400064 无权处理该域名
    400008 无此bucket
    400013 重复操作
    400030 正在处理中
    400066 域名状态为失败
    400998 域名已下线
    500923 域名已冻结
    500930 删除中的域名
    400204 开启时间戳防盗链时,必须两组key
    400318 修改时间戳防盗链未带key
    400308 不能同时修改时间戳防盗链上所有的key
    400031 非法的url
    500005 数据查询内部出错

    修改回源鉴权

    用户修改普通域名及泛域名回源鉴权接口
    
    

    请求包

    PUT /domain/<Name>/bsauth
    
    {
        Bsauth
    }
    
    
    参数解释
    参数 类型 必填 含义
    Bsauth object 请参考 回源鉴权

    返回包

    {}
    
    

    错误码

    错误码 含义
    404001 无此域名
    400001 未知的域名
    400064 无权处理该域名
    400200 未知的bucket
    400008 无此bucket
    400013 重复操作
    400030 正在处理中
    400066 域名状态为失败
    400998 域名已下线
    500923 域名已冻结
    500930 删除中的域名
    400520 不能同时设置时间戳防盗链和回源鉴权
    400521 非法的回源鉴权地址
    400522 非法的回源鉴权http方法
    400523 非法的回源鉴权http code
    400524 非法的回源鉴权超时时间
    400525 非法的回源鉴权url参数
    500005 数据查询内部出错

    修改特殊配置

    用户修改普通域名及泛域名特殊配置接口
    
    

    请求包

    PUT /domain/<Name>/external
    
    {
        External
    }
    
    
    参数解释
    参数 类型 必填 含义
    External object 结构请参考 特殊配置

    返回包

    {}
    
    

    错误码

    错误码 含义
    404001 无此域名
    400001 未知的域名
    400064 无权处理该域名
    400200 未知的bucket
    400008 域名绑定的bucket已删除
    400013 重复操作
    400030 正在处理中
    400066 域名状态为失败
    400998 域名已下线
    500923 域名已冻结
    500930 删除中的域名
    404911 非法的路径
    404912 非法的正则表达式
    500005 数据查询内部出错

    证书相关

    上传证书

    用户上传证书的接口, 注意我们不会自动补全证书链,需要用户自己补全
    
    

    请求包

    POST /sslcert
    
    {
        Cert
    }
    
    
    参数解释
    参数 类型 必填 含义
    Cert object 结构请参考 证书

    返回包

    {
        certID: <CertID>
    }
    
    
    参数解释
    参数 类型 含义
    CertID string

    错误码

    错误码 含义
    400500 超过用户绑定证书最大额度
    404906 https证书解码失败
    400323 验证https证书链失败
    400322 https证书有效期太短
    400329 https证书过期

    删除证书

    用户删除证书的接口
    
    

    请求包

    DELETE /sslcert/<CertID>
    Authorization: QBox <QBoxToken>
    
    
    参数解释
    参数 类型 含义
    CertID string

    返回包

    {}
    
    

    错误码

    错误码 含义
    400401 无此证书
    404908 无权操作该证书

    获取证书

    用户获取单个证书的接口
    
    

    请求包

    GET /sslcert/<CertID>
    Authorization: QBox <QBoxToken>
    
    
    参数解释
    参数 类型 含义
    CertID string

    返回包

    {
        Cert
    }
    
    
    参数解释
    参数 类型 含义
    Cert object 结构请参考 证书

    错误码

    错误码 含义
    400401 无此证书
    404908 无权操作该证书

    获取证书列表

    用户获取证书列表的接口
    
    

    请求包

    GET /sslcert?marker=<Marker>&limit=<Limit>
    Authorization: QBox <QBoxToken>
    
    
    参数解释
    参数 类型 含义
    Marker string 用于标示从哪个位置开始获取证书列表。不填或空表示从头开始
    Limit int 返回的最大域名个数。默认 100

    返回包

    {
        marker: <Marker>,
        certs: [
            <Cert>,
            ...
        ]
    }
    
    
    参数解释
    参数 类型 含义
    Marker string 用于标示下一次从哪个位置开始获取证书列表
    Cert object 结构请参考 证书

    错误码

    错误码 含义
    404908 无权操作该证书

    产品功能

    缓存策略

    结构

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

    注意

    • 缓存配置优先级依从配置数组的前后顺序依次从高到低
    • 全局配置要放到最后,不然自定义规则缓存配置优先级最低
    • 如果是遵循源站配置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
        }
    
    

    回源

    结构

        {
            sourceHost: <SourceHost>,
            sourceType: <SourceType>,
            sourceIPs: [<SourceIP>, ...],
            sourceDomain: <SourceDomain>,
            sourceQiniuBucket: <SourceQiniuBucket>,
            sourceURLScheme: <SourceURLScheme>,
            advancedSources: [
                {
                    addr: <ASAddr>,
                    weight: <ASWeight>,
                    backup: <ASBackup>
                }
            ]
        }
    
    
    参数 类型 含义
    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, 默认不填是follow请求协议
    ASAddr string 高级回源的回源地址, 可以是IP或者域名, sourceType为advanced时advancedSources字段必填
    ASWeight int 高级回源的回源addr权重, 1 ~ 65535, 按照权重比例回源
    ASBackup bool 高级回源的回源addr是否为备源地址

    注意

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

    referer 防盗链

    结构

    请求结构

        {
            refererType: <RefererType>,
            refererValue: <RefererValue>,
            nullReferer: <NullReferer>
        }
    
    
    参数 类型 含义
    RefererType string Referer防盗链类型: black/white
    RefererValue string Referer防盗链黑白名单列表,以逗号,分割
    NullReferer bool Referer防盗链, 是否支持空referer

    响应结构

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

    注意

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

    IP黑白名单

    结构

    请求结构

        {
            ipACLType: <IpACLType>,
            ipACLValue: <IpACLValue>,
        }
    
    
    参数 类型 含义
    ipACLType string ip黑白名单控制控制类型, black/white
    IpACLValue string ip黑白名单列表, 以逗号,分割,ip格式为:127.0.0.1/24

    响应结构

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

    注意

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

    时间戳防盗链

    结构

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

    注意

    回源鉴权

    结构

        {
            path: [<Path>, ...],
            method: <Method>,
            parameters: [<Parameter>, ...],
            timeLimit: <TimeLimit>,
            userAuthUrl: <UserAuthUrl>,
            strict: <Strict>,
            enable: <Enable>,
            successStatusCode: <SuccessStatusCode>,
            failureStatusCode: <FailureStatusCode>
        }
    
    
    参数 类型 含义
    Path string 要匹配这个回源鉴权的path,目前该功能还不支持
    Method string 回源鉴权支持的http方法,GET/POST/HEAD
    Parameter string 回源鉴权中参与鉴权的url 参数
    TimeLimit int 回源鉴权的鉴权超时时间,单位ms, 最小 100ms(0.1s), 最大10000ms(10s)
    UserAuthUrl string 回源鉴权: 用户鉴权的鉴权服务地址
    Strict bool 回源鉴权: 超时后,是否严格为鉴权失败
    Enable bool 回源鉴权开关
    SuccessStatusCode int 回源鉴权: 鉴权通过的http code, 最小100,最大10000
    FailureStatusCode int 回源鉴权: 鉴权失败的http code, 最小100,最大10000

    注意

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

    HTTPS

    结构

        {
            certId: <CertID>,
            forceHttps: <ForceHttps>
        }
    
    
    参数 类型 含义
    CertID string 证书ID, 如果Protocol是https, 则需要填写该证书id
    ForceHttps bool 是否开启强制https访问,即http访问时30x到https

    注意

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

    特殊配置

    结构

        {
            enableFop: <EnableFop>,
            imageSlim: {
                enableImageSlim: <EnableImageSlim>,
                prefixImageSlims: <PrefixImageSlims>,
                regexpImageSlims: <RegexpImageSlims>
            }
        }
    
    
    参数 类型 含义
    EnableFop bool 是否自动开启七牛fop图片处理
    EnableImageSlim bool 是否自动开启图片瘦身
    PrefixImageSlims string 图片瘦身匹配的指定目录列表, 以分号分割, 例如/abc;/cde
    RegexpImageSlims string 图片瘦身匹配的指定的正则表达式列表, 以分号分割, 例如.png;.jpg

    证书配置

    结构

    请求结构

        {
            "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 证书内容

    注意

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