帮助与文档

域名详情查询 下载PDF文档

接口地址

请求URL: domain (GET)

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

接口描述

查询域名的详细信息。

访问频次见响应头,每分钟请求不超过60次

输入参数

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

请求参数(GET)

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

参数名数据类型是否必须说明
domainsstring指定查询的加速域名或者域名ID,最多可一次性查询10个加速域名或者域名ID。

调用示例:

curl -X GET "https://cdn.api.baishan.com/v2/domain?token=xxx\
&domains=example.com,example2.com"

返回示例

json格式

{
    "code": 0, //code为0,表示数据返回正常,非0时则不正常
    "data": [
        {
            "id": "31335",
            "domain": "example.com",
            "type": "download",
            "status": "serving",
            "icp_status": "yes",//备案状态(checking=查询中, yes已备案, no=未备案)
            "cname": "example.com.baishan.com.",
            "create_time": "2019-01-01 18:00:00",
            "update_time": "2019-01-01 21:00:00",
            "https":0, //是否开启HTTPS服务(0=未开启,1=已开启)
            "config": {
                "cache_rule": [
                     {
                        "type": 4,
                        "time": "1",
                        "timeunit": "D",
                        "pattern": "\\.(png|jpg)",
                        "ignore_no_cache": true,
                        "ignore_query": true
                    }
                ],
                "origin": {
                    "default_master": "1.1.1.1",
                    "origin_mode": "default",
                    "ori_https": "no",
                    "port": ""  //仅支持有配置https的域名查询回源端口信息
                }
            }
        },
        {
            "id": "32810",
            "domain": "example2.com",
            "type": "page",
            "status": "suspend",
            "cname": "example2.com.baishan.com.",
            "create_time": "2019-03-01 18:00:00",
            "update_time": "2019-03-01 21:00:00",
            "https":0, 
            "config": {
                "referer": {
                    "allow_empty": false,
                    "type": 1,
                    "list": [
                        "*.qingcdn.com",
                        "new.vx.qingcdn.com"
                    ]
                },
                "origin": {
                    "default_master": "133.233.133.33",
                    "default_slave": "12.13.41.21",
                    "origin_mode": "custom",
                    "ori_https": "no",
                    "port": 8080,
                    "dx_master": "133.233.133.33,11.11.11.12",  //电信主源
                    "dx_slave": "12.13.41.21,11.11.11.11",     //电信备源
                    "lt_master": "133.233.133.33,11.11.11.12",  //联通主源
                    "lt_slave": "12.13.41.21,11.11.11.11",     //联通备源
                    "yd_master": "133.233.133.33,11.11.11.11",  //移动主源
                    "yd_slave": "12.13.41.21,11.11.11.12"     //移动备源
                },
                "origin_host": {
                    "host": "test.qingcdn.com"
                }
            }
         }
      ]
}
       

响应参数

参数名数据类型说明
idstring域名ID
domainsstring域名
cnamestring域名分配的CNAME
typestring域名的业务类型:
page:网页,download:下载,video_demand:点播, video_live:直播, dynamic:动态
statusstring域名的服务状态:
serving:服务中,deploying:部署中,suspend:挂起
icp_statusstring域名的备案状态:
checking:查询中,yes:已备案,no:未备案
create_timestring域名的创建时间
update_timestring域名的更新时间
httpsint域名是否开启HTTPS服务:
0:未开启,1:已开启
configobject域名的功能配置,详细说明见’config参数说明‘

config 参数说明

origin (回源配置)

参数名数据类型说明
default_masterstring主源
default_slavestring备源
origin_modestring回源方式:
default:以用户访问的协议和端口回源
http:http协议80端口回源
https:https协议443端口回源
custom:自定义协议和端口回源
ori_httpsstring回源是否https
portint回源端口

origin_host (回源HOST)

参数名数据类型说明
hoststring回源host

referer (referer防盗链)

参数名数据类型说明
typeint防盗链类型:
1:黑名单
2:白名单
listarrayreferer列表
allow_emptyboolean是否允许referer为空的访问:
true=允许
false=不允许

cache_rule (缓存规则)

参数名数据类型说明
typeint缓存类型:
1:文件名后缀,
2:目录,
3:完整路径匹配
4:正则表达式
patternstring缓存规则
timeint缓存时间, 当time=0时代表禁止缓存
timeunitstring缓存时间单位
Y:年,M:月,D:日,h:时,i:分,s:秒
ignore_no_cacheboolean忽略不缓存头部:
on:忽略
off:不忽略
ignore_expiredboolean忽略过期时间:
on:忽略
off:不忽略
ignore_queryboolean是否去问号缓存:
on:去问号缓存
off:带问号缓存

ip_black_list (ip黑名单)

参数名数据类型说明
listarrayip黑名单列表

响应(Response Header)

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

http状态码说明

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