全站加速网络
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 全站加速网络 > API 文档 > 全站加速网络 API 2017 > 域名管理相关接口 > 新增加速域名

新增加速域名

最近更新时间：2021-01-22 10:56:14

前往 GitHub 编辑 我的收藏

本页目录：

接口描述

本接口（ CreateDsaHost ）用于新增 ECDN 加速域名。
接口请求域名：dsa.api.qcloud.com

  • 接入域名必须尚未接入腾讯云 CDN 或 ECDN 服务。
  • 接入的域名必须通过工信部备案。
  • 使用此接口，一次仅能添加一个域名至腾讯云 ECDN。
  • 使用此接口新建的域名默认处于启用状态。
  • 该接口调用频次上限为100次/分钟，超出上限则会返回错误，请勿高频调用。

输入参数

以下请求参数列表仅列出了接口请求参数，正式调用时需要加上公共请求参数，详情请参见 公共请求参数 页面。其中，此接口的 Action 字段为 CreateDsaHost。

参数名称 必选 类型 描述
host 是 String 待新增的加速域名 host。
origin 是 String 回源地址，支持配置一个域名，或配置多个源站 IP（支持 '域名：port' 和 'ip:port' 类型），端口仅支持 ＞0 且 ≤ 65535，多 IP 时采用逗号分隔。
projectId 否 Unsigned 项目 ID，指域名要添加入的项目的对应 ID，查看项目 ID。
https 否 String HTTPS 配置（JSON），默认不启用 HTTPS，配置格式见下文 HTTPS 配置格式。
rspHeader 否 String 自定义返回头部（JSON），配置格式见下文 HTTPS 配置格式。
strategyWeight 否 String 权重回源配置。源站仅允许配置 IP，且 key 值与 “origin” 字段配置源站相同，value 值为权重，权重范围1 - 100。示例：若 origin = "1.1.1.1:8080,2.2.2.2"，则权重 = {"1.1.1.1:8080":10,"2.2.2.2":20}。
backupOrigin 否 String 备份源站配置。仅支持一主一备，且备份源站仅允许配置 IP。示例：["1.2.3.4:8080"]。

HTTPS 配置格式

参数名称 是否必选 类型 描述
type 是 Int HTTPS 开关：
0：表示关闭。
2：表示启用，并且采用 HTTP 回源。
4：表示启用，并采用协议跟随回源，默认关闭 HTTPS 配置。
crt 否 String 当启用 HTTPS，并且采用自有证书时，必须配置证书信息。
private_key 否 String 当启用 HTTPS，并且采用自有证书时，必须配置私钥信息。
cert_id 否 String 当启用 HTTPS，并且采用腾讯云托管证书时，必须配置证书 ID 信息。
message 否 String 备注信息。
注意：

当启用 HTTPS 配置，且采用自有证书时，由于需要上传证书信息，请采用 POST 方式提交。

自定义头部配置格式

自定义回源头部采用 JSON 格式配置，配置格式如下： 

{
"key_name_1":"value_1",
"key_name_2":"value_2",
...
"key_name_N":"value_N"
}
注意：

当设置自定义头部时，请尽量采用 POST 方式提交，防止 URL 长度越界问题。

输出参数

参数名称 类型 描述
code Int 公共错误码
0：表示成功
其他值：表示失败
详情请参见错误码页面的 公共错误码。
message String 模块错误信息描述，与接口相关。
codeDesc String 英文错误信息，或业务侧错误码。
data Object 输出结果，若域名添加成功，则返回域名配置信息。

data 字段说明

参数名称 类型 描述
host_id Int 域名接入 ECDN 后的唯一标识 ID。
app_id Int 域名归属人的 AppID。
project_id Unsigned 域名所属的项目 ID。
host String 加速域名。
cname String 域名接入 ECDN 的 CNAME 别名。
status String 域名当前状态
online：启用
offline：关闭。
progress Int 配置部署状态
0：表示部署完毕
1：表示正在部署中。
mode Int 域名封禁状态，若为 '0'，则表示域名未被封禁。
locked Int 运维锁状态
0：表示未锁定，用户可直接修改配置
1：表示锁定状态，需要提交工单审核后才能修改配置。
deleted Int 域名是否删除
0：表示域名未删除
1：表示域名已删除。
origin String 源站地址。
fwd_host String 回源 host 配置。
rsp_header Object 自定义返回头部配置信息。
https Object HTTPS 配置信息，详情见下文 HTTPS 字段说明。
message String 信息描述。
create_time String 域名创建时间。
update_time String 域名上一次配置更新时间。
strategy_weight String 回源权重。
backup_origin String 备份源站。

HTTPS 字段说明

参数名称 类型 描述
type Unsigned HTTPS 开关
0：表示关闭
2：表示启用，并且采用 HTTP 回源
4：表示启用，并采用协议跟随回源。
cert_id String 腾讯云托管证书 ID，当使用腾讯云托管证书时返回此参数。
cn String 证书域名。
expire String SSL 证书过期时间。
message String 证书备注信息。
http2 String HTTP 2.0 开关
on：表示开启
off：表示关闭。
注意：

未在上述文档中说明的字段均为无效字段，可直接忽略。

代码示例

配置需求示例

host：dsa.qcloud.com   
projectId：0  
origin：origin.dsa.qcloud.com：8080

GET 请求

GET 请求需要将所有参数都加在 URL 后： 

https://dsa.api.qcloud.com/v2/index.php?
Action=CreateDsaHost   
&SecretId=XXXXXXXXXXXXXXXXXXXXXXXXX   
&Timestamp=1462440051   
&Nonce=123456789   
&Signature=XXXXXXXXXXXXXXXXXXXXXXXXXX  
&host=dsa.qcloud.com   
&projectId=0   
&origin=origin.dsa.qcloud.com:8080

POST 请求

POST 请求时，参数填充在 HTTP Request-body 中，请求地址：

https://dsa.api.qcloud.com/v2/index.php

参数支持 form-data、x-www-form-urlencoded 等格式，参数数组如下： 

array(
'Action' => 'CreateDsaHost',
'SecretId' => 'SecretId',
'Timestamp' => 1462782282,
'Nonce' => 123456789,
'Signature' => 'Signature',  
'host' => 'host',
 'origin' => 'origin',  
 'projectId' => 'project_id',  
);

返回结果示例

创建成功

{
   "code": 0,
   "message": "",
   "codeDesc": "Success",
"data":    {
    "host_id":3827,
    "app_id":1251396975,
    "project_id":0,
    "host":"arnoapi2.elliotxing.com",
    "cname":"arnoapi2.elliotxing.com.dsa.dnsv1.com",
    "status":"online",
    "progress":1,
    "mode":0,
    "locked":0,
    "deleted":0,
    "origin":"8.8.8.8:8080",
    "fwd_host":"arnoapi2.elliotxing.com",
    "rsp_header":[],
    "https":{"type":0},
    "message":"",
    "create_time":"2018-05-27 19:42:04",
    "update_time":"2018-05-27 19:42:06"
    }
}

创建失败

{
   "code": 4000,
   "message": "(2001)您提交的域名已经存在，请勿重复添加",
   "codeDesc": "InvalidParameter"
}
中国站