CDN加速

创建加速域名

更新时间:2021-04-27 17:35:55
适用产品:网页加速、下载加速、全站加速、点播加速、直播加速、移动加速

接口描述

为指定的域名申请加速服务

  • 调用URL: https://open.chinanetcenter.com/api/domain
  • 限制说明:· 加速域名必须已备案完成。 · 加速域名必须不包含如下信息:出售药物和管制刀具类,含有不法言论、信息。 · 视频类加速域名必须有视听许可证;博客论坛或社区类加速域名必须有BBS专项审批资质。 · 接口请求和返回结果接受xml和json格式。
  • 调用频率:无限制

请求参数

参数名称类型必填描述
cname-with-customized-prefixString一级cname前缀,true表示使用域名名称作为cname前缀,否则,使用14位随机串(数字+字母)作为cname前缀。   注意:当前缀是泛域名时,则再增加wsall作为前缀。如.baidu.com.wscloudcdn.com,会生成wsall.baidu.com.wscloudcdn.com
versionString版本号,当前版本号1.0.0
service-areasString加速域名的服务区域,不指定加速区域,我们将按照客户开通的服务区域,以最优的资源覆盖提供加速服务;如果有需要根据区域限定资源覆盖时,才需要指定加速区域。多个区域以分号分隔,兼容新旧两种区域如下: 新区域:cn(中国大陆)、am(美洲)、emea(欧洲、中东、非洲)、apac(亚太地区) 旧区域:cn(中国大陆)、ov(海外平均)、apac(亚太地区)、euna(欧美)、sa(南美)、af(非洲)、hk(香港)、tw(台湾) 注意: 1、新的用户请使用新区域,历史原因,兼容部分老用户继续使用旧区域类型。
commentString备注信息,最大限制1000个字符
config-form-idint配置单模板,特定的使用场景下,如果希望新增的加速域名参照某些指定配置时,可以指定配置单模板,具体使用请咨询对应的客户负责人。
service-typeString加速域名的服务类型(一次只能提交一个服务类型): web/web-https:网页加速/网页加速-https wsa/wsa-https:全站加速/全站加速-https vodstream/vod-https:点播加速/点播加速-https download/dl-https:下载加速/下载加速-https wss:防攻击 注意: 1、新增域名如果要使用https,需传入对应的业务类型,例如:web加速域名要使用https,需传入web-https。 2、web-https中的https并不代表立刻支持https访问,需上传完证书后才可以支持https,切记~!
cname-labelString共用一级别名,客户存在较多一级域名共用的需求,因此在接口中引入cname-label标识,即拥有相同cname-label的一组域名,共用一级cname。当加速域名的加速区域、加速类型、资源链是一致的时候,建议使用共用一级别名,相同的业务使用相同一级别名cname。 注意: 1、拥有相同cname-label的域名共用一级cname,且有完全一致的dns覆盖 2、共用一级的约束:配置一致、加速类型一致、证书id一致(如果有证书)、加速区域一致、平台套餐一致 3、多个http域名可共用一级,多个sni https域名可共用一级,多个共享证书域名可共用一级 4、单个域名使用cname-label时,域名可取消加速;多个域名共用一级时,不允许取消加速这些域名 5、支持通过修改cname-label达到修改cname的目的
origin-ipsString回源地址,可以是IP或域名。 1.IP以分号分隔,支持多个。 2.域名只能输入一个。IP与域名不能同时输入。 3.限制最大不能超过500个字符长度。 4.源IP个数不能超过15个
default-origin-host-headerString回源HOST,用于更改回源HTTP请求头中的HOST字段。支持格式为: ①域名;②域名:端口;③ip;④ip:port 注意: 1、必须符合ip/域名格式规范。如果是域名,则域名长度小于等于128。 2、端口部分(可以不传),整数,取值范围[0,65536)。
accelerate-no-chinaString标识域名是否是纯海外加速的。 默认是否(false) true :表示客户域名纯海外加速 false:表示客户域名有在中国加速
domain-nameString需要接入CDN的域名。支持泛域名,以符号“.”开头,如:.example.com,泛域名也包含多级“a.b.example.com”。 如果example.com已备案,那么域名xx.example.com则不需要备案。
referenced-domain-nameString参照指定域名的配置,来创建加速域名。参照域名如果有使用证书,新增域名也要在对应证书授权范围内。
origin-portstring回源协议端口号,仅支持填写1935,不传系统也默认为1935。仅支持查看,新增修改不会赋值
header-of-clientipString传递客户端ip的响应头部,可选值为Cdn-Src-Ip和X-Forwarded-For,默认值为Cdn-Src-Ip

返回参数

参数名称类型描述
http status codeinthttpstatus=202;   表示成功调用新增域名接口,可使用header中的x-cnc-request-id查看当前新增域名的部署情况
x-cnc-request-idString唯一标示的id,用于查询每次请求的任务 (适用全部接口)
LocationString用于访问该域名信息的URL,其中domain-id为我司云平台为该域名生成的唯一标示,其值为字符串。
cnameString由我司自动生成的服务域名名称,例如:xxxx.cdn30.com
codeString错误代码,当HTTPStatus不为202时出现,表示当前请求调用的错误类型
messageString响应信息,成功时为success

错误码

错误代码(code)描述(message)HTTP状态码语义
InternalErrorWe encountered an internal error. Please try again.500服务器异常,数据获取失败等内部错误
DomainAlreadyExistsThe domain name you provided is already in our system.409添加的域名已经存在。
ICPNotFoundThere is no ICP number for the domain you provided.400您提供的域名没有备案号
InvalidOrigin{"$domainName":{"ssl":"No   certificate id when use ssl."}}400使用证书时没有传入证书id
CustomizedCnameErrorCustomized CNAME error.409客户共用一级错误
ConfigFormNotExistsThe configuration does not exist.400配置不存在
NoSuchConfigTempletThe specified config templet does not exist.404配置单模板不存在
NO_AVAILABLE_CONFIGCan not find effective ConfServiceForm by input parameter custSuitType :   [$CustSuitType]400根据加速类型找不到合适的服务单
PARSE_PARAM_ERRORError parameter.400入参解析错误
SERVICE_TYPE_NOT_MATCH_TEMPLET_IDThe service-type does not match the service-type associated with the value of templetId.400加速类型与模板id的加速类型不匹配
MAIN_DOMAIN_NAME_EXISTMain domain names exists for domain [$errDomainNames]400主域名已存在
MalformedXMLThe XML you provided was not well-formed or did not validate against our published schema.400提供的xml不正确或者不符合规则
ConfigErrorthe non-back-origin-src rtmp-pull domains can not find corresponding push domain name!400非直接回源拉流域名没有关联配套推流
DomainExistsCdnAreaErrorThe domain's service area is invalid.409入参服务区域错误
CnameErrorThe cname label has one more templet forms400共用一级属于多个配置单模板
NULL_DOMAIN_NAMEDomain name is null.400域名为空
DOMAIN_NOT_IN_SSL_DNS_DOMAINThe domain is not in ssl dns domains.400域名不在证书允许使用范围内
NOT_HTTPS_IN_SERVICEFORMSnot https in serviceforms400没有匹配的https服务单
STAGING_SUIT_ERRORcan not find any suit400找不到套餐
SERVICE_TYPE_NOT_USE_SNI_SSLThe domain service type can't use sni ssl.400域名配置不能使用sni证书
SUIT_HAS_NOT_CONFIG_CERTIFICATE_SERVICEThe suit belong to serviceForm does not have a certificate service.400服务单是https类型,但是所属套餐没有配置证书的相关二级服务
ERROR_CONFIG_PARAM{"$configXmlTag":"$msg"}或Wrong delete data id $dataId或Wrong data id $dataId400配置单配置项错误
NOT_ALLOW_SRC_IP_AS_ACCELERATE_DOMAINThe back-to-origin domain of this domain is also another accelerated domain, which may lead to abnormal access to the accelerated domain .400回源域名是另一个加速域名,这种情况可能导致加速域名访问异常
NOT_ALLOW_ACCELERATE_DOMAIN_AS_SRC_IPThis accelerated domain is duplicated with another back-to-origin domain, which may lead to abnormal access to the accelerated domain.400此加速域名和另外一个回源域名重名,这种情况可能导致加速域名访问异常。

示例

示例说明
请求示例
复制
#!/bin/bash
username="example_username"
apiKey="example_apiKey"
date=`env LANG="en_US.UTF-8" date -u "+%a, %d %b %Y %H:%M:%S GMT"`
password=`echo -en "$date" | openssl dgst -sha1 -hmac $apiKey -binary | openssl enc -base64`
curl -i --url "https://open.chinanetcenter.com/api/domain" \
-X "POST" \
-u "$username:$password" \
-H "Date: $date" \
-H "Accept: application/json" \
-H "Content-Type:application/json" \
-d '
{
    "version":"1.0.0",
    "domain-name":"test12.eaxmple1.com",
    "service-areas":"cn",
    "comment":"",
    "service-type":"web",
    "origin-config":{
        "origin-ips":"127.0.0.1",
        "default-origin-host-header":""
    },
    "referenced-domain-name":"aaa.linlytest.com"
}'
返回示例
复制
HTTP/1.1 202 Accepted
Date: Fri, 17 May 2017 06:33:26 GMT
Content-Type: application/json;charset=utf-8
x-cnc-request-id:c54cbbb4-19fe-407a-930c-3988b62ed2fd
Location:https://open.chinanetcenter.com/api/domain/1234567
cname: 7nt6mrh7sdkslj.cdn30.com
{"message":"success"}