设置HTTPS加速
更新时间:2021-01-26
接口
本接口用于设置HTTPS加速相关选项,属于全量配置接口。
Method | Path | 说明 |
---|---|---|
PUT | /v2/domain/{domain}/config?https | 配置HTTPS加速 |
domain: CDN加速域名。
请求体(Request Body)
参数 | 可选 | 类型 | 说明 |
---|---|---|---|
https | 必选 | HTTPSConfig | HTTPS配置信息 |
HTTPSConfig的类型如下:
参数 | 可选 | 类型 | 说明 |
---|---|---|---|
enabled | 必选 | Bool | 开启HTTPS加速(服务端HTTPS认证),默认为false,当enabled=false,以下几列字段设置无效(当certId=""时certId字段是有效的) |
certId | 可选 | String | 当enabled=true时此项为必选,为SSL证书服务返回的证书ID,当enablae为false且certId为""时解绑domain当前绑定的certId,否则当enabled=False时此项无效 |
httpRedirect | 可选 | Bool | 为true时将HTTP请求重定向到HTTPS(重定向状态码为httpRedirectCode所配置),默认为false,当enabled=false此项无效,不可与httpsRedirect同时为true |
httpRedirectCode | 可选 | Int | 重定向状态码,可选值301/302,默认302,当enabled=false此项无效,httpRedirect=false此项无效 |
httpsRedirect | 可选 | Bool | 为true时将HTTPS请求重定向到HTTP重定向状态码为httpsRedirectCode所配置),默认为false,当enabled=false此项无效,不可与httpRedirect同时为true |
httpsRedirectCode | 可选 | Int | 重定向状态码,可选值301/302,默认302,当enabled=false此项无效,httpsRedirect=false此项无效 |
http2Enabled | 可选 | Bool | 开启HTTP2特性,默认true,当enabled=false此项无效 |
verifyClient | 可选 | Bool | 为true时开启HTTPS双向认证。只有开启了服务端HTTPS认证时可以开启该配置,默认为false |
sslProtocols | 可选 | List<String> | 设置访问TLS版本,默认为支持从TLSv1.0到TLSv1.3的版本,也可以主动设置为以下四个中的一个或多个,"TLSv1.0","TLSv1.1","TLSv1.2","TLSv1.3"。该参数不能为空list。当enabled=false时此项无效。此项一般取默认值,无需设置 |
响应码 (Http Status Code)
HTTP Status Code | 说明 |
---|---|
200 | 成功 |
400 | 更新失败,参数错误等 |
请求示例1
开启HTTPS,certId为"ssl-82fdaufdsaldsuaow"其他属性遵循默认值。不会将HTTP请求重定向到HTTPS,也不会将HTTPS请求重定向到HTTP,开启HTTP2特性,以HTTPS协议回源,支持所有的TLS版本,包括TLSv1.0,TLSv1.1,TLSv1.2和TLSv1.3。
PUT /v2/domain/myself.baidu.com/config?https HTTP/1.1
Host: cdn.baidubce.com
Content-Length: 59
Content-Type: text/json;utf-8
{
"https": {
"enabled": true,
"certId": "ssl-82fdaufdsaldsuaow"
}
}
请求示例2
开启HTTPS,certId为"ssl-82fdaufdsaldsuaow",将HTTP请求重定向到HTTPS,重定向状态码为301,关闭HTTP2特性。其他属性遵循默认值,不会将HTTPS请求重定向到HTTP,以HTTPS协议回源,支持所有的TLS版本,包括TLSv1.0,TLSv1.1,TLSv1.2和TLSv1.3。
PUT /v2/domain/myself.baidu.com/config?https HTTP/1.1
Host: cdn.baidubce.com
Content-Length: 123
Content-Type: text/json;utf-8
{
"https":{
"enabled":true,
"certId":"ssl-82fdaufdsaldsuaow",
"httpRedirect":true,
"httpRedirectCode":301,
"http2Enabled":false
}
}
请求示例3
关闭HTTPS,其他选项无意义。
PUT /v2/domain/myself.baidu.com/config?https HTTP/1.1
Host: cdn.baidubce.com
Content-Length: 27
Content-Type: text/json;utf-8
{
"https":{
"enabled": false
}
}
响应示例
HTTP/1.1 200 OK
Server: nginx
Date: Wed, 26 Jun 2019 05:57:29 GMT
Content-Type: application/json; charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
X-Powered-By: PHP/7.1.5
x-bce-request-id: 8a9c4d38-5198-ed4e-b279-272fdde46e4b
{
"status":"RUNNING"
}