4.2 域名配置
4.2.12 配置 HTTPS
4.2.12 配置 HTTPS
功能介绍
设置加速域名HTTPS。通过配置加速域名的HTTPS证书,并将其部署在全网CDN节 点,实现HTTPS安全加速。
调试
您可以在API Explorer中调试该接口。
URI
PUT /v1.0/cdn/domains/{domain_id}/https-info
表4-117 路径参数
参数 是否必选 参数类型 描述
domain_id 是 String 加速域名ID。获取方法请参见查 询加速域名。
表4-118 Query 参数
参数 是否必选 参数类型 描述
enterprise_pro
ject_id 否 String 当用户开启企业项目功能时,该
参数生效,表示查询资源所属项 目,不传表示查询默认项目。注 意:当使用子账号调用接口时,
该参数必传。
请求参数
表4-119 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 用户Token。
通过调用IAM服务获取用户 Token接口获取(响应消息头中 X-Subject-Token的值)。
表4-120 请求 Body 参数
参数 是否必选 参数类型 描述
https 是 HttpInfoRequ estBody object
https对象。
表4-121 HttpInfoRequestBody
参数 是否必选 参数类型 描述
cert_name 是 String 证书名字。(长度限制为3-32字 符)。
参数 是否必选 参数类型 描述
https_status 是 Integer HTTPS证书是否启用。0:不启 用,此时无需填写证书及私钥参
certificate 否 String 功能说明:HTTPS协议使用的证 书内容,不启用证书则无需输 入。取值范围:PEM编码格式。
初次配置证书时必传。
private_key 否 String 功能说明: HTTPS协议使用的 私钥,不启用证书则无需输入。
取值范围:PEM编码格式。初次 配置证书时必传。
http2 否 Integer 是否使用HTTP2.0。(1:是,
0:否。)
_https 否 Integer 强制跳转HTTPS(0:不强制;
1:强制) 为空值时默认设置为 关闭。(建议使用
force_redirect_config修改配 置)
force_redirect
_config 否 ForceRedirect
object 强制跳转
表4-122 ForceRedirect
参数 是否必选 参数类型 描述
switch 是 Integer 强制跳转开关。1打开。0关
闭。
redirect_type 否 String 强制跳转类型。http:强制跳转 HTTP。https:强制跳转 HTTPS。
响应参数
状态码: 200
表4-123 响应 Body 参数
参数 参数类型 描述
https HttpInfoResp onseBody object
https对象。
表4-124 HttpInfoResponseBody
参数 参数类型 描述
https_status Integer HTTPS证书是否启用。0:不启用,此时无需填写 证书及私钥参数;1:启用HTTPS加速并协议跟随 回源;2:启用HTTPS加速并HTTP回源;3:启用 HTTPS加速并HTTPS回源,开启时需要传递证书 及私钥
cert_name String 证书名称。(长度限制为3-32字符)。
certificate String 证书内容。
private_key String 功能说明: HTTPS协议使用的私钥,不启用证书 则无需输入。(为了客户信息安全,接口返回私 钥为空)
certificate_typ
e Integer 证书类型。1:代表华为云托管证书;0:表示自
有证书。
force_redirect
_https Integer 客户端请求是否强制重定向。1是,0否。(如果 为2,表示强制跳转HTTP)
force_redirect
_config ForceRedirect
object 强制跳转
http2 Integer 是否使用HTTP2.0。(1是,0否。)
expiration_tim
e Long 证书过期时间
表4-125 ForceRedirect
参数 参数类型 描述
switch Integer 强制跳转开关。1打开。0关闭。
redirect_type String 强制跳转类型。http:强制跳转HTTP。https:强 制跳转HTTPS。
请求示例
PUT https://cdn.myhuaweicloud.com/v1.0/cdn/domains/ff8080**********************d71/https-info?
enterprise_project_id=0
{ "https" : { "http2" : 0,
"certificate_type" : 0, "force_redirect_config" : { "redirect_type" : "http", "switch" : 1
},
"force_redirect_https" : 1, "https_status" : 2,
"cert_name" : "cdn_test_cert",
"certificate" : "---BEGIN CERTIFICATE---END CERTIFICATE---",
"private_key" : "---BEGIN RSA PRIVATE KEY---END RSA PRIVATE KEY---"
}}
"certificate_type" : 0, "force_redirect_config" : { "redirect_type" : "http", "switch" : 1
},
"expiration_time" : 1636183290000, "force_redirect_https" : 2,
"https_status" : 2,
"cert_name" : "cdn_test_cert",
"certificate" : "---BEGIN CERTIFICATE---END CERTIFICATE---", "private_key" : ""
您可以在API Explorer中调试该接口。