设置域名配置 下载PDF文档

接口地址

请求URL: domain/config (POST)

接口请求域名: cdn.api.baishan.com
接口版本: v2

接口描述

对加速域名各项功能进行设置和修改。支持功能项：源站、回源host、缓存规则、referer黑白名单、ip黑名单、添加响应头。

注意：
接口调用频率不超过30次/分钟。
每次提交既支持单个功能设置，也支持多个功能同时设置。当同时设置多个功能设置时，如果某一项功能设置不合法，那么本次提交的所有功能均无法成功设置。
如需使用请联系项目经理申请开通。

输入参数

公有参数：用户的 token 可向值班同事获取。

请求参数(POST)

参数支持 form-data、x-www-form-urlencoded、json 等格式

origin (源站)

# 修改源站
curl -X POST "https://cdn.api.baishan.com/v2/domain/config"\
  -H 'content-type: application/json' \
  -d '{
    "token":"xxx",
    "domains":"example.com",
    "config": {   
        "origin": {
            "default_master":"1.1.1.1,1.1.1.2",
            "default_slave":"2.2.2.2",
            "origin_mode":"custom",
            "ori_https":"yes",
            "port":1040
        }
    }
}'

origin_host (回源host)

# 设置源站host
curl -X POST "https://cdn.api.baishan.com/v2/domain/config"\
  -H 'content-type: application/json' \
  -d '{
    "token":"xxx",
    "domains":"example.com",
    "config": {   
        "origin_host": {
            "host": "www.example.com"
        }
    }
}'

cache_rule (缓存规则)

缓存规则正则使用说明 : 正则规则是作为一般类型无法满足情形下的补充, 使用不当会引起缓存不必要的故障, 建议有一定正则基础的开发者使用, 请理解清楚正则的使用规则后再应用到线上服务中, 设置缓存规则为正则, 会将请求的url地址(url地址:包含http/https协议部分、域名、端口[有的话]、路径、参数等几个部分)与正则去做匹配, 匹配成功则会使用该规则设定的缓存时间.

1. 举例1: .*\.(gif|png|jpg)$, 那么他将匹配所有含(gif,png,jpg)文件名后缀的url
2. 举例2: ^https?://[^/]+/dir1/dir2/(dir3_1|dir3_2)\.html, 该规则匹配当前域名下/dir1/dir2/dir3_1.html和/dir1/dir2/dir3_2.html规则.

# 添加缓存规则(可以为多个缓存规则)
curl -X POST "https://cdn.api.baishan.com/v2/domain/config"\
  -H 'content-type: application/json' \
  -d '{
    "token":"xxx",
    "domains":"aa.qingcdn.com",
    "config": {
        "cache_rule":[
            {
                "type":1,
                "pattern":"jpg,png,gif",
                "time":3600
            },
            {
                "type":1,
                "pattern":"avi,mp4,mpeg",
                "time":3600
            }
        ]
    }
}'

cache_rule_list (缓存规则新)

# 设置2条缓存规则
curl -X POST "http://cdn.api.baishan.com/v2/domain/config"\
  -H 'content-type: application/json' \
  -d '{
    "token":"xxx",
    "domains":"example.com",
    "config": {
        "cache_rule_list":[
            {
            "match_method":"dir",
            "pattern":"/www/html,/www/aaa",
            "case_ignore":"no",
            "priority":13,
            "expire":60,
            "expire_unit":"i",
            "ignore_no_cache_headers":"yes", 
            "follow_expired":"no",
            "query_params_op":"do_nothing"
            },
            {
            "match_method":"ext",
            "pattern":"php,jsp,asp,aspx",
            "case_ignore":"no",
            "priority":15,
            "expire":3600,
            "expire_unit":"s",
            "ignore_no_cache_headers":"yes", 
            "follow_expired":"no",
            "query_params_op":"cache_back_source_remove"
            }
        ]
    }
}'

referer (referer黑白名单)

# 设置referer黑名单
curl -X POST "https://cdn.api.baishan.com/v2/domain/config"\
  -H 'content-type: application/json' \
  -d '{
    "token":"xxx",
    "domains":"example.com",
    "config": {   
        "referer": {
            "type":"1",
            "list":[
                "*.example.com",
                "www.example2.com"
            ],
            "allow_empty":true
        }
    }
}'

# 设置referer白名单
curl -X POST "https://cdn.api.baishan.com/v2/domain/config"\
  -H 'content-type: application/json' \
  -d '{
    "token":"xxx",
    "domains":"example.com",
    "config": {   
        "referer": {
            "type":"2",
            "list":[
                "*.example.com",
                "www.example2.com"
            ],
            "allow_empty":false
        }
    }
}'

ip_black_list (ip黑名单)

# 设置ip黑名单
curl -X POST "https://cdn.api.baishan.com/v2/domain/config"\
  -H 'content-type: application/json' \
  -d '{
    "token":"xxx",
    "domains":"example.com",
    "config": {   
        "ip_black_list": {
            "list": [
                "14.12.11.0/24",
                "1.2.3.4"
            ],
            "mode": "cover"
        }
    }
}'

add_response_head (添加响应头)

#添加响应头，reset模式
curl -X POST "https://cdn.api.baishan.com/v2/domain/config"\
    -H "Content-Type: application/json"\
    -d '{
    "token":"xxx",
    "domains":"example.com",
    "config": {
        "add_response_head": {
            "type":"reset",
            "list":[
                {
                    "name":"Content-Type", 
                    "value":"text/html; charset=ISO-8859-4"
                },
                {
                    "name":"Cache-Control", 
                    "value":"max-age=300, must-revalidate"
                }
            ]
        }
    }
}'

#添加响应头，add模式
curl -X POST "https://cdn.api.baishan.com/v2/domain/config"\
    -H "Content-Type: application/json"\
    -d '{
    "token":"xxx",
    "domains":"example.com",
    "config": {
        "add_response_head": {
            "type":"add",
            "list":[
                {
                    "name":"Content-T1", 
                    "value":"text/html; charset=ISO-8859-4"
                },
                {
                    "name":"Cache-C1", 
                    "value":"max-age=300, must-revalidate"
                }
            ]
        }
    }
}'

#添加响应头，remove模式
curl -X POST "https://cdn.api.baishan.com/v2/domain/config"\
    -H "Content-Type: application/json"\
    -d '{
    "token":"xxx",
    "domains":"example.com",
    "config": {
        "add_response_head": {
            "type":"remove",
            "list":[
               "Content-T1",
                "Cache-C1"
            ]
        }
    }
}'

https (https证书)

# 设置https证书
curl -X POST "https://cdn.api.baishan.com/v2/domain/config"\
  -H 'content-type: application/json' \
  -d '{
    "token":"xxx",
    "domains":"example.com",
    "config": {
        "https": {
            "cert_id": 10101,
            "http2":"on",
            "force_https":"301"
        }
    }
}'

调用示例

# 修改多个功能
curl -X POST "https://cdn.api.baishan.com/v2/domain/config"\
    -H "Content-Type: application/json"\
    -d '{
    "token":"xxx",
    "domains":"example.com,example2.com",
    "config": {
        "origin": {
            "default_master": "133.233.133.33",
            "default_slave": "12.13.41.21"
        },
        "origin_host": {
            "host": "test.example.com"
        },
        "referer": {
            "type": 1,
            "list": [
                "*.example.com",
                "new.vx.example.com"
            ],
            "allow_empty": false
        },
        "ip_black_list": {
            "list": [
                "14.12.11.0/24",
                "1.2.3.1"
            ]
        },
        "add_response_head":{
            "type":"add",
            "list":[
                {
                    "name":"Content-Type", 
                    "value":"text/html; charset=ISO-8859-4"
                },
                {
                    "name":"Cache-Control", 
                    "value":"max-age=300, must-revalidate"
                }
            ]
        },
        "https":{
            "cert_id":123
        }
    }
}'

返回示例

JSON格式(请求时传对应的参数, 设置成功后会输出对应设置成功后的配置参数)

{
    "code": 0,//0操作成功, 非0时会给出对应的错误提示
    "data": {
        "config": {
            "origin": {
                "default_master": "133.233.133.33",
                "default_slave": "12.13.41.21"
            },
            ...
        }
    }
}

响应(Response Header)

HTTP/1.0 200 OK
Api-Id: 221328331
Content-Type: application/json; charset=utf-8
X-Ratelimit-Grad: minute   //接口调用频率限制粒度(分/小时/天)
X-Ratelimit-Limit: 50      //当前每分钟请求次数上限
X-Ratelimit-Remaining: 29  //每分钟剩余请求次数
X-Retry-After: 43          //xx秒后重置当前粒度(分/小时/天)请求次数限制

http状态码说明