获取响应头允许的 Key 列表--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

获取响应头允许的 Key 列表

最近更新时间：2024.08.13 20:23:51首次发布时间：2024.04.30 11:20:34

本接口支持获取当前账号全部合法的响应头 key 信息。

注意事项

请求频率限制：单用户请求频率限制为 10 次/秒。
超时时间：约为 5 秒。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

请求方式：GET
请求地址：https://imagex.volcengineapi.com/?Action=GetResponseHeaderValidateKeys&Version=2023-05-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetResponseHeaderValidateKeys`	接口名称。当前 API 的名称为 `GetResponseHeaderValidateKeys`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数	类型	示例值	描述
ValidateRespHdrKeys	Array of String	`["Content-Disposition","Content-Language","Access-Control-Allow-Origin","Access-Control-Expose-Headers","Access-Control-Max-Age","Cache-Control","Access-Control-Allow-Methods","Timing-Allow-Origin","Access-Control-Allow-Headers","Access-Control-Allow-Credentials","Access-Control-Max-Age"]`	合法的响应头 key 列表

请求示例

GET https://imagex.volcengineapi.com/?Action=GetResponseHeaderValidateKeys&Version=2023-05-01

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "GetResponseHeaderValidateKeys",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "ValidateRespHdrKeys": [
            "Content-Disposition",
            "Content-Language",
            "Access-Control-Allow-Origin",
            "Access-Control-Expose-Headers",
            "Access-Control-Max-Age",
            "Cache-Control",
            "Access-Control-Allow-Methods",
            "Timing-Allow-Origin",
            "Access-Control-Allow-Headers",
            "Access-Control-Allow-Credentials",
            "Access-Control-Max-Age"
        ]
    }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码以及 veImageX 错误码。

SDK

veImageX 提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。

历史版本

2018-08-01 版本 GetResponseHeaderValidateKeys 接口文档现已停止维护，建议您参考本文档使用最新版本。