CDN加速

文档中心 API文档 域名配置 预部署域名配置修改接口

预部署域名配置修改接口

更新时间:2020-11-16 16:48:56
适用产品:网页加速、下载加速、全站加速、点播加速、直播加速、移动加速、云存储、通用功能

接口描述

预部署指定加速域名的配置,包含:回源策略、ssl配置、等参数的配置进行预部署。

请求参数

参数名称类型必填描述
domain-name/domain-idString加速域名的名称或系统返回的域名ID
versionString版本号,当前版本号1.0.0
commentString备注信息,最大限制1000个字符
service-areasString加速域名的服务区域,不指定加速区域,我们将按照客户开通的服务区域,以最优的资源覆盖提供加速服务;如果有需要根据区域限定资源覆盖时,才需要指定加速区域。多个区域以分号分隔,兼容新旧两种区域如下: 新区域:cn(中国大陆)、am(美洲)、emea(欧洲、中东、非洲)、apac(亚太地区)   旧区域::cn(中国大陆)、ov(海外平均)、apac(亚太地区)、euna(欧美)、sa(南美)、af(非洲)、hk(香港)、tw(台湾) 注意: 1、新的用户请使用新区域,历史原因,兼容部分老用户继续使用旧区域类型。
cname-labelString共用一级别名,客户存在较多一级域名共用的需求,因此在接口中引入cname-label标识,即拥有相同cname-label的一组域名,共用一级cname。当加速域名的加速区域、加速类型、资源链是一致的时候,建议使用共用一级别名,相同的业务使用相同一级别名cname。 注意: 1、拥有相同cname-label的域名共用一级cname,且有完全一致的dns覆盖 2、共用一级的约束:配置一致、加速类型一致、证书id一致(如果有证书)、加速区域一致、平台套餐一致 3、多个http域名可共用一级,多个sni   https域名可共用一级,多个共享证书域名可共用一级 4、单个域名使用cname-label时,域名可cancel;多个域名共用一级时,不允许cancel这些域名 5、支持通过修改cname-label达到修改cname的目的
origin-configcomplex回源策略设置,用于设置加速域名的源站信息和回源策略
origin-ipsString回源地址,可以是IP或域名。 1、IP以分号分隔,支持多个。 2、域名只能输入一个。IP与域名不能同时输入。 3、限制最大不能超过500个字符长度。
default-origin-host-headerString回源HOST,用于更改回源HTTP请求头中的HOST字段。 注意: 1、必须符合域名格式规范,各个lable以点号分隔,各lable长度不超过62个字符,而且总长度不超过128。例如:***.***.com域名中,***的长度不能超过62,总长度不超过128 2、端口部分(可以不传)需要满足 <65536, >=0
detect-urlString高级源监控url,通过该url请求<master-ips>,如果返回非2**,3**响应时,认为主要回源ip故障,此时使用<backup-ips>。 需要输入完整的url,例如:http://a.example.com/test.html
detect-periodint高级源监控周期,单位秒,可选值为大于等于0的整数,0表示不监控
master-ipsString高级源主要回源IP,多个IP用分号“;”分隔,回源IP不能重复
backup-ipsString高级源备用回源IP,多个IP用分号“;”分隔,回源IP不能重复
sslcomplexssl证书设置,用于设置加速域名的ssl证书配置
use-sslString使用证书,可选值为true和false,true表示使用证书,false表示不使用证书
use-for-sniString使用sni证书,可选值为true和false,true表示使用sni证书,false表示使用合用证书(暂不支持)
ssl-certificate-idint证书ID,新增证书成功后,系统返回的证书ID use-ssl为true时,才能传ssl-certificate-id。(点播和下载加速类型的证书需要下单给运维单独配置)

返回参数

参数名称类型描述
preDeployIdString预部署任务的id,可以根据这个id查询预部署的进展和结果

示例

示例说明
请求示例
复制
#!/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/predeploy/1234" \
-X "PUT" \
-u "$username:$password" \
-H "Date: $date" \
-H "Accept: application/json" \
-H "Content-Type:application/json" \
-d '<?xml version="1.0" encoding="UTF-8"?>
<domain>
  <version>1.0.0</version>
  <comment>update basic config</comment>
  <service-areas>cn</service-areas>
  <origin-config>
    <origin-ips>1.1.1.0</origin-ips>
    <default-origin-host-header>a.example.com</default-origin-host-header>
    <adv-origin-configs>
      <detect-url>http://a.example.com/test.html</detect-url>
      <detect-period>600</detect-period>
      <adv-origin-config>
        <master-ips>1.1.1.1</master-ips>
        <backup-ips>2.2.2.2</backup-ips>
      </adv-origin-config>
    </adv-origin-configs>
  </origin-config>
  <ssl>
    <use-ssl>true</use-ssl>
    <use-for-sni>true</use-for-sni>
    <ssl-certificate-id>10001</ssl-certificate-id>
  </ssl>
  <cache-behaviors>
    <cache-behavior>
      <path-pattern>/(a|b)/*.(jpg|bmp)</path-pattern>
      <cache-ttl>1800</cache-ttl>
      <ignore-cache-control>true</ignore-cache-control>
    </cache-behavior>
     <cache-behavior>
      <path-pattern>/(a|b)/*.(png|gif)</path-pattern>
      <cache-ttl>1800</cache-ttl>
      <ignore-cache-control>false</ignore-cache-control>
    </cache-behavior>
  </cache-behaviors>
  <query-string-settings>
    <query-string-setting>
      <path-pattern>*.jpg</path-pattern>
      <ignore-query-string>true</ignore-query-string>
    </query-string-setting>
    <query-string-setting>
      <path-pattern>*.gif</path-pattern>
      <ignore-query-string>false</ignore-query-string>
    </query-string-setting>
 </query-string-settings>
  <visit-control-rules>
    <visit-control-rule>
      <path-pattern>*.jpg</path-pattern>
      <allownullreferer>true</allownullreferer>
      <valid-referers>
        <referer>www.a.com</referer>
      </valid-referers>
      <forbidden-ips>192.168.1.0/24</forbidden-ips>
    </visit-control-rule>
    <visit-control-rule>
      <path-pattern>*.gif</path-pattern>
      <allownullreferer>false</allownullreferer>
      <invalid-referers>
        <referer>www.b.com</referer>
      </invalid-referers>
      <forbidden-ips>202.161.1.0/24</forbidden-ips>
    </visit-control-rule>
  </visit-control-rules>
  <error-page-rules>
    <error-page-rule>
      <path-pattern>*.jpg</path-pattern>
      <ignore-case>true</ignore-case>
      <error-code>403;404</error-code>
      <forward-url>http://a.example.com/test.jpg</forward-url>
    </error-page-rule>
    <error-page-rule>
      <path-pattern>*.gif</path-pattern>
      <ignore-case>true</ignore-case>
      <error-code>403;404</error-code>
      <forward-url>http://a.example.com/test.gif</forward-url>
    </error-page-rule>
  </error-page-rules>
  <client-control-rule>
    <access-speed-rules>
      <access-speed-rule>
        <path-pattern>*.jpg</path-pattern>
        <speed>512</speed>
      </access-speed-rule>
      <access-speed-rule>
        <path-pattern>*.gif</path-pattern>
        <speed>1024</speed>
      </access-speed-rule>
    </access-speed-rules>
  </client-control-rule>
  <videodrags>
    <path-pattern>*</path-pattern>
    <drag-mode>time</drag-mode>
    <start-flag>start</start-flag>
    <end-flag>end</end-flag>
  </videodrags>
</domain>'
返回示例
复制
HTTP/1.1 202 OK 
Server: openresty/1.11.2.2
Date: Thu, 14 Mar 2019 08:00:35 GMT
Content-Type: application/xml;charset=utf-8
Content-Length: 60
Connection: keep-alive
App-Name: service_confApi
x-cnc-request-id: d4b62c6f-3d26-4005

<response>
     <preDeployId>66201667e7424820b9e359671178757c</preDeployId>
</response>