帮助与文档

查询域名配置 下载PDF文档

接口地址

请求URL: domain/config (GET)

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

接口描述

查询域名下的配置,包括:缓存规则,域名源站,ip黑名单,referer黑白名单的配置

注意:
接口调用频率不超过30次/分钟;该接口用来查询非直播加速类型的域名配置。
如需使用请联系项目经理申请开通。

输入参数

以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,公有参数:用户的 token 可向值班同事获取。

请求参数(GET)

参数添加到在url的query部分,例如: ?key1=value1&key2=value2

参数名数据类型是否必须说明
domainsstring域名, 多个域名以逗号(,)分隔, 单次域名不超过10个
configarray要查询的配置项,为空时返回所有配置,例如:["referer","origin","ip_black_list ","cache_rule"]
referer:黑/白名单配置项;
origin:源站配置 ;
ip_black_list : ip黑名单;
cache_rule:缓存规则
origin_host:回源host

调用示例

示例:
curl -X GET 'https://cdn.api.baishan.com/v2/domain/config?token=token&domains=www.test.com&config[]=referer&config[]=origin' -g

返回示例

json格式

{
    "code": 0,   //0为成功,  成功时, 返回配置查询结果
    "data": [
    {
        "domain": "www.test.com",   //域名
        "domain_id": "25419",       //域名ID
        "config": {
            "referer": {        //referer黑/白名单配置项
                "allow_empty": true, //true:允许空refer, false:不允空refer 
                "type": 1,        // 配置项类型:1:白名单 2:黑名单
                "list": [          //refer列表
                    "*.aaa.test.com",
                    "www.test.com"
                ]
            },
            "origin": {
                "default_master": "xj-mbs-yabo-origin-a937umzq6s5.prdasbbwla2.com",
                "default_slave": "1.1.1.1",
                "origin_mode": "custom",
                "ori_https": "yes",
                "port": "444",
                "dx_master": "1.1.1.1",
                "lt_master": "1.1.1.2"
            }
        }
    },
        ...
    ]
}

响应(Response Header)

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

http状态码说明

错误状态码说明
404您输入的 URL 错误
401鉴权错误,您的token错误,或者没有开通接口权限
400请求参数有误
200执行成功,返回请求的数据
5xx请联系值班同事
CopyRight © 2015-2024 BaishanCloud . All Rights Reserved.