API中心

CDNW修改加速域名

更新时间:2024-04-17 14:15:52

修改指定加速域名的配置。

  • 限制说明:修改指定加速域名的配置,包括:返回原点策略配置、ssl配置、缓存规则、访问控制、客户端访问速度限制、错误页面重定向、视频拖动(VOD加速)。 注意: •数据格式:请求和响应都支持XML。 •推荐频率:1/ 15min。
  • 单用户调用频率:300/5min
  • 适用产品:互动直播、静态加速、动态加速、流媒体点播、Flood Shield、Flood Shield 2.0

请求参数

Path 参数

参数名称描述
*domainString
需要修改的域名,可以是域名名称或域名id。

Body 参数

参数名称描述
versionString
版本号
service-areasString
加速域名的加速区域,如果有需要根据区域限定资源覆盖时,才需要指定加速区域。未指定加速区域时,我们将按照客户开通的服务区域,以最优的资源覆盖提供加速服务。多个区域以分号分隔,支持配置的区域如下:cn(中国大陆)、am(美洲)、emea(欧洲、中东、非洲)、apac(亚太地区)
cname-labelString
共用一级标签,若有多个加速域名需要共用一级域名,则可以使用该参数。即拥有相同cname-label的一组域名,共用一级cname。 注意: 1、拥有相同cname-label的域名共用一级cname,且有完全一致的dns覆盖 2、共用一级的约束:加速类型一致(service-type)、证书id一致(certificate-id,如果有证书)、加速区域一致(service-areas) 3、多个http域名可共用一级,多个sni https域名可共用一级 4、单个域名使用cname-label时,域名可cancel;多个域名共用一级时,不允许cancel这些域名 5、支持通过修改cname-label达到修改cname的目的。
commentString
备注信息,最大限制1000个字符
cache-hostString
缓存文件HOST。缓存HOST域名和加速域名的缓存规则必须一致。
header-of-clientipString
传递客户端ip的响应头部,可选值为Cdn-Src-Ip和X-Forwarded-For,默认值为Cdn-Src-Ip
origin-configObject
回源策略设置,用于设置加速域名的源站信息和回源策略
origin-ipsString
回源地址,可以是IP或域名。 1、IP以分号分隔,支持多个。 2、域名只能输入一个。IP与域名不能同时输入。 3、限制最大不能超过500个字符长度。 4、IP最多15个。
adv-origin-configsObject
detect-urlString
高级源监控url,通过该url请求,如果返回非2**,3**响应时,认为主要回源ip故障,此时使用。 需要输入完整的url,例如:http://a.example.com/test.html
detect-periodString
高级源监控周期,单位秒,可选值为大于等于0的整数,0表示不监控
adv-origin-configList
高级源配置
master-ipsString
高级源主要回源IP,多个IP用分号“;”分隔,回源IP不能重复
backup-ipsString
高级源备用回源IP,多个IP用分号“;”分隔,回源IP不能重复
default-origin-host-headerString
回源HOST,用于更改回源HTTP请求头中的HOST字段。支持格式为域名或ip。 注意:必须符合ip/域名格式规范。如果是域名,则域名每段(点号分隔)长度小于等于62,域名总长度小于等于128。
origin-portString
回源请求端口。
live-configObject
直播域名配置,用于设置直播加速域名的推拉流
origin-ipsString
源站IP,当stream-type为pull时,源站IP和配套推流域名至少一个不为空。 1、如果是推拉流配套,则填写127.0.0.1,不传系统也默认为127.0.0.1 2、如果是直接回源拉流,则填写回源拉流的源站IP
origin-push-hostString
配套推流域名,用于设置直播拉流域名对应的推流域名,当stream-type为pull时,源站IP和配套推流域名至少一个不为空;当stream-type为push时,无需传入。
sslObject
ssl证书设置,用于设置加速域名的ssl证书配置。上传证书请使用接口:【新增证书V2】;若要修改证书,请使用接口:【修改证书V2】。
use-sslString
使用证书,可选值为true和false,true表示使用证书,false表示不使用证书
use-for-sniString
使用sni证书,可选值为true和false,true表示使用sni证书,false表示使用合用证书(暂不支持)
ssl-certificate-idString
证书ID,新增证书成功后,系统返回的证书ID use-ssl为true时,才能传ssl-certificate-id。(点播和下载加速类型的证书需要下单给运维单独配置)
cache-behaviorsList
缓存规则设置,用于设置加速域名的缓存规则,请使用新接口:修改缓存时间配置接口
path-patternString
url匹配模式,支持正则,如果是全部匹配,入参可以配置为:* 如果要修改缓存规则,此项必填
priorityString
表示一条配置的优先级,值越大优先级越高
cache-ttlString
缓存时间:设置缓存对象对应的时间。入参格式:整数,不缓存设置为0。 缓存时间理论上没有上限限制,这个时间根据客户自身的需求设定,如果客户觉得其中一些文件,变更不频繁,那么就设置长一点。例如,文本类的js,css,html等可以设置得短一些,图片、视频音频类的可以设置的长一点(因为缓存时间会因文件热度算法,旧文件会被新文件替换掉,最长建议不要超过一个月) 如果要修改缓存规则,此项必填
cache-unitString
缓存时间单位:设置缓存对象对应的时间单位:比如s、m、h、d。不输入单位默认是秒
ignore-cache-controlString
忽略源站不缓存头。可选值为true和false,用于忽略请求头中cache-control的两种配置(private,no-cache)和客户端设置的Authorization。 ture表示会忽略掉源站对于这三者的设定。使得资源能够以cache-control: public的方式缓存在服务节点上,然后我们的节点才能缓存这种类型的资源,提供加速服务。 false表示当源站对某种资源设定了cache-control: private,cache-control:no-cache或指定根据authorization进行缓存时,我们的服务节点将不会对此类文件进行缓存。
publish-pointsList
设置直播推拉流域名的发布点 注意: 1、拉流和对应的推流域名,必须配置相同的发布点; 2、不想修改发布点时,不要传入该节点及以下入参; 3、发布点采用覆盖式更新,每次修改时,需要提交全部发布点,不能仅提交需要修改的部分。
uriString
发布点,支持多个,不传系统默认生成一条发布点uri为“/”

返回参数

Body 参数

参数名称描述
codeString
Error code occurs when HTTPStatus is not 202, indicating the error type of the current request calls.
messageString
Response information, demonstrates success when it is successful.

错误码

错误代码(code)描述(message)HTTP状态码语义
InvalidParameterThe request has null config with null data-id, please remove it.400请求的配置为空,数据ID为空,请将其删除。
InternalErrorWe encountered an internal error. Please try again.500服务器异常,数据获取失败等内部错误
MalformedXMLThe XML you provided was not well-formed or did not validate against our   published schema.400提供的xml不正确或者不符合规则
NoSuchDomainThe specified domain does not exist.404指定的域名不存在
ForbiddenThe domain is being deleted403域名被删除
ConfigErrorRenaming the domain is not permitted.400不允许变更域名名称
ConfigErrorThe service type cannot be changed.400不允许变更域名类型
ConfigErrorThe config form id cannot be changed.400不允许变更配置单模板id
ConfigErrorThe suit does not match the suit associated with the value of cname-label.409指定配置与指定共用一级域名不匹配
InvalidOrigin{"$domainName":{"$xmlTag":"$msg"}}400域名属性值错误
InvalidOriginOrigin domain and accelerated domain can not be the same.400回源域名和加速域名不能相同
InvalidOriginThe origin IP or hostname is invalid.400回源ip/域名不合法
InvalidOrigin{"$domainName":{"src-ip":"Duplicate source ip or source domain name."}}400回源ip重复
InvalidOrigin{"$domainName":{"src-host":"Not in suit."}}400套餐没有规划回源请求HOST
InvalidOrigin{"$domainName":{"src-host":"Error source host."}}400回源请求HOST配置错误
InvalidOriginCan not change advanced source ip or source domain name.400不能修改域名的高级源
CustomizedCnameErrorCustomized CNAME error.409客户共用一级错误
ConfigVersionOutOfDateThe specified version is out of date.409您提供的版本已经过期
CnameErrorCNAME cancel.400共用一级错误
ConfigFormNotExistsThe configuration does not exist.400域名的服务区域入参解析错误
NO_DOMAIN_2_UPDATENo domain to update.400配置不存在
DOMAIN_NOT_USE_SSLThe domain $domainName does not use ssl.400域名没有关联证书
NOT_SUPPORT_CERTIFICATE_CONFIGuse ssl must all or no400使用证书必须同时使用或者同时取消
NOT_SUPPORT_CERTIFICATE_CONFIGuse ssl type useForSni is diff400证书类型不一致
NOT_SUPPORT_CERTIFICATE_CONFIGuse ssl type useForSni is {$type}, but certId to more400使用传统(Sni)证书,但是使用的证书有多个
NOT_SUPPORT_CERTIFICATE_CONFIGuse tra but cnameLabel certId and use certId diff400使用传统证书,但是cnamelabel对应的证书与使用的证书不一致
NO_AVAILABLE_HTTPS_SERVICE_FORMNo available https serviceForm to switch from http serviceForm [testForm] to   https serviceForm.400没有可用的httpps服务单来切换
NO_AVAILABLE_HTTPS_SERVICE_FORMProduct Line is limited for http serviceForm [testForm].400当前服务单的产品线不在允许切换https服务单的范围内
NO_AVAILABLE_HTTPS_SERVICE_FORMNo suitId for http serviceForm [testForm]400当前服务单没有套餐id
NO_AVAILABLE_HTTPS_SERVICE_FORMIsUseSsl not all used for domains in the same configForm.400同一个配置单下的所有域名必须同时使用证书
APPG_NAME_EMPTYThe appGroupName is empty.400应用服务组检查不通过(应用服务组名称为空)
APPG_NOT_SUPPORT_HTTPS_8_APIThe appGroup does not support HTTPS by API.400应用服务组检查不通过(应用服务组不对外开放HTTPS自助)
APPG_NOT_SUPPORT_HTTPSThe appGroup does not support HTTPS.400应用服务组检查不通过(应用服务组不对外开放HTTPS自助)
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"}orWrong delete data id $dataIdorWrong data id $dataId400配置单配置项错误
CONFIG_NOT_OWN_DOMAIN_NAMECan not deal with domain name [{$name}].400不能处理该域名
DUPLICATE_DOMAIN_NAMECan not operate 2 domain with the same name.400入参中域名重复

示例

JSON
XML
JSON
请求示例
复制代码 复制成功
#!/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://api.cdnetworks.com/api/domain/a1.example.com" \
-X "PUT" \
-u "$username:$password" \
-H "Date: $date" \
-H "Accept: application/json" \
-H "Content-Type:application/json" \
-d '{
    "comment": "my comment here",
    "origin-config": {
        "origin-ips": "1.1.1.0",
        "default-origin-host-header": "a.example.com"
      },
     "ssl":{
             "use-ssl":"",
             "use-for-sni":"",
             "ssl-certificate-id":""
             },
     "cache-behaviors": [{
        "path-pattern": "/jpg",
        "ignore-cache-control": "true",
        "cache-ttl": "1800",
        "cache-unit": "s"
    }]
   "header-of-clientip":"X-Forwarded-For"
}'
返回示例
复制代码 复制成功
HTTP/1.1 202 Accepted
Date: Fri, 17 May 2017 06:33:26 GMT
Content-Type: application/xml;charset=utf-8
x-cnc-request-id:c54cbbb4-19fe-407a-930c-3988b62ed2fd
x-cnc-deploy-version:1420084740000
{"message":"success"}
本篇文档内容对您是否有帮助?
有帮助
我要反馈
提交成功!非常感谢您的反馈,我们会继续努力做到更好!