# 配置HTTPS #### 功能介绍 设置加速域名HTTPS。通过配置加速域名的HTTPS证书，并将其部署在全网CDN节点，实现HTTPS安全加速。 #### URI PUT /v1.0/cdn/domains/{domain_id}/https-info 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | domain_id | 是 | String | 加速域名id。 您可以通过查询加速域名接口查询加速域名id。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | enterprise_project_id | 否 | String | 当用户开启企业项目功能时，该参数生效，表示修改当前企业项目下加速域名的配置，"all"代表所有项目。注意：当使用子账号调用接口时，该参数必传。 您可以通过调用企业项目管理服务（EPS）的查询企业项目列表接口（ListEnterpriseProject）查询企业项目id。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 | 表4请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | https | 是 | [HttpInfoRequestBody] object | https配置。 | 表5HttpInfoRequestBody | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | cert_name | 是 | String | 证书名字。（长度限制为3-64字符）。 | | https_status | 是 | Integer | HTTPS证书是否启用。0：不启用，此时无需填写证书及私钥参数；1：启用HTTPS加速并协议跟随回源；2：启用HTTPS加速并HTTP回源；3：启用HTTPS加速并HTTPS回源，首次配置证书需要传递证书及私钥，如已有证书可不用传证书及私钥。 | | certificate | 否 | String | HTTPS协议使用的SSL证书内容，仅支持PEM编码格式。不启用证书则无需输入。初次配置证书时必传。 | | private_key | 否 | String | HTTPS协议使用的SSL证书私钥内容，仅支持PEM编码格式。不启用证书则无需输入。初次配置证书时必传。 | | http2 | 否 | Integer | 是否使用HTTP2.0。（1：是，0：否。） | | certificate_type | 否 | Integer | 证书类型。1：代表华为云托管证书；0：表示自有证书。 默认值0。 | | force_redirect_https | 否 | Integer | 强制跳转HTTPS（0：不强制；1：强制） 为空值时默认设置为关闭。（建议使用force_redirect_config修改配置） | | force_redirect_config | 否 | [ForceRedirect] object | 强制跳转 | 表6ForceRedirect | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | switch | 是 | Integer | 强制跳转开关。1打开。0关闭。 | | redirect_type | 否 | String | 强制跳转类型。http：强制跳转HTTP。https：强制跳转HTTPS。 | #### 响应参数 **状态码：200** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | https | [HttpInfoResponseBody] object | https配置。 | 表8HttpInfoResponseBody | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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_type | Integer | 证书类型。1：代表华为云托管证书；0：表示自有证书。 | | force_redirect_https | Integer | 客户端请求是否强制重定向。1是，0否。（如果为2，表示强制跳转HTTP） | | force_redirect_config | [ForceRedirect] object | 强制跳转 | | http2 | Integer | 是否使用HTTP2.0。（1是，0否。） | | expiration_time | Long | 证书过期时间 | 表9ForceRedirect | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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-----" } } ``` #### 响应示例 **状态码：200** OK ``` { "https" : { "http2" : 0, "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" : "" } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-cdn/ErrorCode.html)。