修改域名配置

最近更新时间:2019-07-12 14:34:13

接口描述

本接口(UpdateDsaHostInfo)用于修改域名对应源站配置。
接口请求域名:dsa.api.qcloud.com

  • 状态为下线、部署中的域名不可修改配置。
  • 一次仅支持修改一个域名对应的配置。
  • 一次可修改同一个域名的多个配置项。
  • 该接口调用频次上限为100次/分钟,超出上限则会返回错误,请勿高频调用。

可支持配置

  • 修改源站配置。
  • 修改域名所属项目。
  • 修改 HTTPS 配置。
  • 设置 response header。

输入参数

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

参数名称 是否必选 类型 描述
hostId Int 域名接入 DSA 后的标识 ID。
您可通过 查询域名列表信息 接口查询域名的 hostId。
projectId Unsigned 项目 ID,指域名要添加入的项目的对应 ID,查看项目 ID
origin String 源站地址,源站配置可填写一个源站域名或者多个源站 IP。
可支持 domain:port 或者 ip:port 类型配置。
端口可配置区间0 - 65535。
https String HTTPS 配置信息(JSON),需要修改 HTTPS 配置时使用,查看 HTTPS 配置
rspHeader String 自定义头部信息,需要修改自定义回源头部时使用,查看自定义头部配置
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 ","1.1.1.1:8080"] 。
fwdHost String 回源 Host 配置。需要修改回源 Host 时使用。示例:fwdHost = www.abc.com。

HTTPS 配置格式

参数名称 是否必选 类型 描述
type Int HTTPS 开关:
0:表示关闭。
2:表示启用,并且采用 HTTP 回源。
4:表示启用,并采用协议跟随回源。
crt String PEM 格式证书,当启用 HTTPS 时必须配置证书。
private_key String PEM 格式密钥,当启用 HTTPS 时必须配置私钥。
cert_id String 启用 HTTPS 后,需要采用腾讯云托管证书时,必须配置证书 ID 信息,证书托管配置只需传入此参数即可。
message String 备注信息。

注意:

当需要提交证书信息时,请采用 POST 方式提交,防止出现 URL 长度越界问题。

自定义头部配置格式

自定义回源头部采用 JOSN 格式配置,配置格式如下:

{
    "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 域名接入 DSA 后的唯一标识 ID。
app_id Int 域名归属人的 AppID。
project_id Unsigned 域名所属的项目 ID。
host String 加速域名。
cname String 域名接入 DSA 的 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 Array 自定义返回头部配置信息。
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:表示关闭。

注意:

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

代码示例:修改源站地址

配置示例

dsa.qcloud.com 的源站地址由 source.dsa.qcloud.com 修改为 source2.dsa.qcloud.com

host: dsa.qcloud.com
hostId: 1234
origin: source2.dsa.qcloud.com

GET 请求

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

https://dsa.api.qcloud.com/v2/index.php?
Action=UpdateDsaHostInfo
&SecretId=XXXXXXXXXXXXXXXXXXXXXXXXXXX
&Timestamp=1462520137
&Nonce=123456789
&Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXXXX
&hostId=1234
&origin=source2.dsa.qcloud.com

POST 请求

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

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

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

array (
  'Action' => 'UpdateDsaHostInfo',
  'SecretId' => 'XXXXXXXXXXXXXXXXXXXXXXXXXXXX',
  'Timestamp' => 1462782282,
  'Nonce' => 123456789,
  'Signature' => 'XXXXXXXXXXXXXXXXXXXXXXXX',
  'hostId' => '1234',
  'origin' => 'source2.dsa.qcloud.com',
)

返回结果示例

修改成功

{
    "code": 0,
    "message": "",
    "codeDesc": "Success",
    "data": {
        "host_id": 1234,
        "app_id": "*******",
        "project_id": 0,
        "host": "dsa.qcloud.com",
        "cname": "dsa.qcloud.com.dsa.dnsv1.com",
        "status": "online",
        "progress": 0,
        "mode": 0,
        "locked": 0,
        "deleted": 0,
        "origin": "source2.dsa.qcloud.com",
        "fwd_host": "dsa.qcloud.com",
        "rsp_header": [],
        "https": {"type": 0},
        "ip_access":{"type":"off","ips":[]},
        "ip_freq_limit":0,
        "message": "",
        "create_time": "2017-11-17 11:07:08",
        "update_time": "2018-01-28 12:52:02"
    }
}

修改失败

{
    "code": 4000,
    "message": "(2000)加速域名不存在",
    "codeDesc": "InvalidParameter"
}

示例代码:修改 HTTPS 配置

配置示例

启用 dsa.qcloud.com 域名的 HTTPS 配置,采用自有证书和协议跟随方式回源。

host: dsa.qcloud.com
hostId: 1234
回源方式:协议跟随  
证书信息: *************** 
证书私钥: ***************   

GET 请求

当需要上传证书信息时,由于URL长度限制,请不要采用 Get 方式提交配置修改请求。

POST 请求

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

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

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

array (
  'Action' => 'UpdateDsaHostInfo',
  'SecretId' => 'SecretId',
  'Timestamp' => 1462782282,
  'Nonce' => 123456789,
  'Signature' => 'Signature',
  'hostId' => '1234',
  'https' => '{"type":4,"crt":"证书内容","private_key":"证书私钥内容"}',
)

返回结果示例

修改成功

{
    "code": 0,
    "message": "",
    "codeDesc": "Success",
    "data": {
        "host_id": 1234,
        "app_id": "*******",
        "project_id": 0,
        "host": "dsa.qcloud.com",
        "cname": "dsa.qcloud.com.dsa.dnsv1.com",
        "status": "online",
        "progress": 0,
        "mode": 0,
        "locked": 0,
        "deleted": 0,
        "origin": "source.dsa.qcloud.com",
        "fwd_host": "dsa.qcloud.com",
        "rsp_header": [],
        "https": {
            "type": 4,
            "crt":"***************",
            "private_key":"***************"
        },
        "message": "",
        "create_time": "2017-11-17 11:07:08",
        "update_time": "2018-01-28 12:52:02"
    }
}

修改失败

{
    "code": 4000,
    "message": "(3003)证书与私钥不匹配",
    "codeDesc": "InvalidParameter"
}