文档中心

更新 https 配置

最近更新时间：2024.01.31 15:06:40

首次发布时间：2021.02.23 10:42:28

本接口支持通过指定服务 ID 和域名来更新 HTTPS 配置。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。
超时时间：5 秒。

请求说明

接口名称：UpdateHttps
请求方式：POST
接口地址示例：https://imagex.volcengineapi.com/?Action=UpdateHttps&Version=2018-08-01

说明

veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共参数。

Query

参数类型是否必选示例值描述

Action String 是 UpdateHttps 接口名称。

Version String 是 2018-08-01 接口版本。

参数	类型	是否必选	示例值	描述
Action	String	是	`UpdateHttps`	接口名称。
Version	String	是	`2018-08-01`	接口版本。
ServiceId	String	是	`uh****2h`	服务 ID。您可以在veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

ServiceId

String

是

uh****2h

服务 ID。

您可以在veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。
您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

Body

参数	类型	是否必选	示例值	描述
domain	String	是	`a.imagex.cn`	域名，您可以通过获取服务下全部域名获取服务下域名信息。
https	Object of https	是		https 配置

https

参数	类型	是否必选	示例值	描述
enable_http2	Boolean	是	`true`	是否开启 http2，取值如下所示： `true`：开启 `false`：关闭
enable_https	Boolean	是	`true`	是否开启 https，取值如下所示： `true`：开启 `false`：关闭
enable_ocsp	Boolean	是	`true`	是否启用 OCSP 装订配置，取值如下所示： `true`：开启 `false`：关闭
tls_versions	Array of String	是	`tlsv1.2`	支持的 tls 版本。取值如下所示： `tlsv1.0` `tlsv1.1` `tlsv1.2` `tlsv1.3`
cert_id	String	否	`iuhs2928jdh`	需要关联的证书 ID，若`enable_https`为`true`，则为必填。
enable_force_redirect	Boolean	否	`true`	开启强制跳转，取值如下所示： `true`：开启 `false`：关闭
force_redirect_type	String	否	`http2https`	仅当`enable_force_redirect`取值为`true`时需要配置，强制跳转类型。取值如下所示： `http2https`：HTTP 到 HTTPS `https2http`：HTTPS 到 HTTP
force_redirect_code	String	否	`301`	仅当`enable_force_redirect`取值为`true`时需要配置，强制跳转状态码。取值如下所示： `301`：返回给用户 301 状态码进行重定向。 `302`：返回给用户 302 状态码进行重定向。

返回参数

正确更新返回 ok，否则错误在 Err 中返回。

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=UpdateHttps&Version=2018-08-01
{
    "domain": "test.com",
    "https": {
        "enable_http2": false,
        "enable_https": true,
        "enable_ocsp": true,
        "tls_versions": [
            "tlsv1.1"
        ],
        "force_redirect_code": "301",
        "cert_id": "iuhs2928jdh",
        "force_redirect_type": "http2https",
        "enable_force_redirect": false
    }
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "UpdateHttps",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result":"ok"
}

错误码

访问公共错误码和域名相关错误码获取详细信息。