帮助与文档

域名创建 下载PDF文档

接口地址

请求URL: domain (POST)

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

接口描述

创建域名,同时支持添加功能配置项:回源地址、回源host。

注意:
特殊账号使用该接口时,需要添加请求参数用户ID,否则报错提示:user_id is require。
如需使用请联系项目经理申请开通。

输入参数

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

请求参数(POST)

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

参数名数据类型是否必须说明
domainstring需要创建的加速域名
areastring加速区域:
mainland_china:中国境内
outside_mainland_china:中国境外
global :全球。 合同未签约的加速区域将导致域名创建失败。
typestring域名类型:
page:网页
download:下载
video_demand:点播
dynamic:动态
configobject功能配置项, 支持回源地址和回源host的设置。

config参数说明

origin (回源配置)

参数名数据类型是否必须说明
default_masterstring主回源, 可填ip, 域名, 多个以逗号(,)分隔
例如: "133.233.133.33,133.233.22.33", 主源/备源最多6个ip
default_slavestring备回源, 可填ip, 域名, 多个以逗号(,)分隔
例如: "133.233.133.33,133.233.22.33"
注:主备源不可设置为一样, 不可与主源存在重复
origin_modestring回源方式:
default:以用户访问的协议和端口回源
http:http协议80端口回源
https:https协议443端口回源
custom:自定义协议和端口回源,需要设置ori_https和port参数。
不填充时,默认值为default。
ori_httpsstringorigin_mode=custom时, 需要设置。
是否https协议回源:
yes:是
no:否
portintorigin_mode=custom时, 需要设置。
回源端口,可选值范围:(0-65535)

origin_host (回源HOST)

参数名数据类型是否必须说明
hoststring回源host

调用示例

curl -X POST "https://cdn.api.baishan.com/v2/domain?token=xxx"\
    -H "Content-Type: application/json"\
    -d '{
    "domain":"example.com",
    "type":"page",
    "config":{
        "origin":{
            "default_master":"1.1.1.1"
        },
        "origin_host":{
            "host":"test.qingcdn.com"
        }
    }
}'

返回示例

json格式

{
    "code": 0, //code为0,表示数据返回正常,非0时则不正常
    "data": {
        "id": "2729151231",
        "domain": "example.com",
        "type": "page",
        "status": "deploying",
        "cname": "example.com.qingcdn.com.",
        "config": {
            "origin": {
                "default_master": "1.1.1.1."
            },
            "origin_host":{
                "host":"test.qingcdn.com"
            }
        }
    }
}

响应(Response Header)

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