帮助与文档

域名列表查询 下载PDF文档

接口地址

请求URL: domain/list (GET)

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

接口描述

查询账号下域名的基础信息。

接口调用频率限制见响应头部(Response Header)。

输入参数

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

请求参数(GET)

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

参数名数据类型是否必须说明
page_numberint取得第几页。
不填充时,默认值为1。
page_sizeint分页大小,取值范围:1-500
不填充时,默认值为100。
domain_statusstring指定域名的服务状态查询,支持指定多个服务状态查询:
serving:服务中。指定serving查询时,响应"status"="deploying"的域名处于配置部署状态。
suspend:挂起
deleted:删除
不填充时,默认返回所有状态域名的基础信息。

调用示例

//请求需要经过URL编码处理。
curl -X GET "https://cdn.api.baishan.com/v2/domain/list?token=xxx\
&page_number=1\
&page_size=50\
&domain_status=suspend,serving"

返回示例

json格式

{
    "code": 0, //code为0,表示数据返回正常,非0时则不正常
    "data": {
        "list": [
            {
                "id": "4612392",
                "domain": "example.com",//域名
                "type": "page",//域名类型(page(网页)|download(下载)|video_demand(点播)|dynamic(动态)|video_live(直播))
                "status": "suspend",
                "cname": "example.com.baishan.com.",
                "icp_status": "yes",//备案状态(checking(查询中)|yes(已备案)| no(未备案))
                "icp_num": "蜀ICP备93014234号-2",//icp备案号
                "https": 1,//是否开启HTTPS服务(1(开启)|0(未开启))
                "create_time": "2019-12-17 17:11:35",
                "update_time": "2020-06-30 13:58:52",                
                "config": {
                    //回源配置
                    "origin": {
                        "default_master": "1.1.1.1",//主源IP
                        "origin_mode": "default",//回源模式
                        "ori_https": "no",//是否使用https回源
                        "port": ""//回源端口, 默认空时为80
                    }
                }
            },
            {
                "id": "4612393",
                "domain": "example2.com",
                "type": "page",
                "status": "serving",
                "cname": "example2.com.baishan.com.",
                "icp_status": "yes",
                "icp_num": "蜀ICP备93014233号-1",
                "https": 1,//是否开启HTTPS服务(1(开启)|0(未开启))
                "create_time": "2019-11-17 17:11:35",
                "update_time": "2020-05-30 13:58:52", 
                "config": {
                    "origin": {
                        "default_master": "22.22.22.22",
                        "origin_mode": "https",//回源模式
                        "ori_https": "yes",//是否使用https回源
                        "port": "443",//回源端口, 默认空时为80
                        "dx_master": "1.2.1.2"
                    }
                }
            },
        ],
        "page_size": 100, //每页数量
        "page_number": "1", //当前页数
        "total_number": "33960" //当前传入参数条件下的总记录数
    }
}

响应(Response Header)

HTTP/1.0 200 OK
Api-Id:                112006099
Content-Type:          application/json; charset=utf-8
X-Ratelimit-Grad:      minute
X-Ratelimit-Limit:     300
X-Ratelimit-Remaining: 300
X-Retry-After:         53
CopyRight © 2015-2024 BaishanCloud . All Rights Reserved.