更新响应头配置--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

更新响应头配置

最近更新时间：2024.01.31 15:06:11首次发布时间：2021.02.23 10:42:28

支持通过指定服务 ID 等参数修改响应头配置。

注意事项

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

请求说明

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

说明

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

请求参数

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

Query

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

Action String 是 UpdateResponseHeader 接口名称。

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

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

ServiceId

String

是

uh****7d

服务 ID。

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

Body

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

resp_hdrs

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

key String 否 Access-Control-Allow-Origin Header Key，请见支持配置的响应头。

value String 否 * Header Value，设置该响应头字段的值。字段值不能超过 1,024 个字符，可以包含除美元符号（$），Delete（ASCII code 127）外的可打印 ASCII 字符。

参数	类型	是否必选	示例值	描述
key	String	否	`Access-Control-Allow-Origin`	Header Key，请见支持配置的响应头。
value	String	否	`*`	Header Value，设置该响应头字段的值。字段值不能超过 1,024 个字符，可以包含除`美元符号（$），Delete（ASCII code 127）`外的可打印 ASCII 字符。
access_origin_control	Boolean	是	`true`	在 veImageX 响应用户请求时，是否校验请求头中的 Origin 字段。仅对响应头部`Access-Control-Allow-Origin`有效，取值如下所示： `true`：开启校验，veImageX 会校验 Origin 字段。如果校验成功，响应头中会包含 Access-Control-Allow-Origin 字段。字段值与 Origin 字段值相同。如果校验失败，响应头中不会包含 Access-Control-Allow-Origin 字段。 `false`：关闭校验，veImageX 不会校验 Origin 字段。响应头中将始终包含 Access-Control-Allow-Origin 头部和您配置的值。

access_origin_control

Boolean

是

true

在 veImageX 响应用户请求时，是否校验请求头中的 Origin 字段。仅对响应头部Access-Control-Allow-Origin有效，取值如下所示：

true：开启校验，veImageX 会校验 Origin 字段。
- 如果校验成功，响应头中会包含 Access-Control-Allow-Origin 字段。字段值与 Origin 字段值相同。
- 如果校验失败，响应头中不会包含 Access-Control-Allow-Origin 字段。
false：关闭校验，veImageX 不会校验 Origin 字段。响应头中将始终包含 Access-Control-Allow-Origin 头部和您配置的值。

返回参数

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

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=UpdateResponseHeader&Version=2018-08-01
{
   "domain":"a.test.cn",
   "resp_hdrs":[
      {
         "key":"Access-Control-Allow-Origin",
         "value":"a",
         "access_origin_control":true
      }
   ]
}

返回示例

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

错误码

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