添加或更新 HTTP header 配置--视频直播-火山引擎

文档中心

立即注册

导航

添加或更新 HTTP header 配置

最近更新时间：2024.05.29 19:20:23首次发布时间：2024.04.07 19:16:33

调用 UpdateHTTPHeaderConfig 接口，为拉流域名添加或更新 HTTP Header 配置。HTTP Header 配置包括在响应拉流请求时的响应 Header 配置和在请求回源服务器时的请求头 Header 配置。

注意事项

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

请求说明

请求方式：POST
请求地址：https://live.volcengineapi.com?Action=UpdateHTTPHeaderConfig&Version=2023-01-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
Vhost	String	是	`push.example.com`	域名空间，即直播流地址的域名所属的域名空间。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，查看需要域名所属的域名空间。
Domain	String	否	`pull.example.com`	拉流域名。默认为空，表示 Vhost 下的全部拉流域名。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，查看配置的拉流域名。
Phase	Integer	是	`0`	HTTP Header 的类型，支持的取值及含义如下所示。 `0`：请求响应头； `1`：回源请求头。
HeaderConfigList	Array of HeaderConfigList	是	`-`	Header 具体字段配置。
BlockOriginal	Integer	否	`0`	是否保留原 Header 配置，取值及含义如下所示。 `0`：保留（默认值）； `1`：不保留。
Enable	Boolean	是	`true`	配置完成后是否启用，取值及含义如下所示。 `true`：启用； `false`：禁用。

HeaderConfigList

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

HeaderKey String 否 Content-Type Header 配置中字段的 Key 值，最大长度为 1024 个字符，多个 Header 不可重名。

参数	类型	是否必选	示例值	描述
HeaderKey	String	否	`Content-Type`	Header 配置中字段的 Key 值，最大长度为 1024 个字符，多个 Header 不可重名。
HeaderValue	String	否	`text/plain`	Header 配置中字段的 Value 值，最大长度为 1024 个字符，支持使用常量和变量作为 Value 值。 HTTP Header 类型为回源请求头时，支持使用以下变量为 Value 赋值： `${domain}`：客户端拉流请求中使用的域名。 `${uri}`：客户端拉流请求中不包括查询参数的路径。如果请求被重写，则表示重写后的路径。 `${args}`：客户端拉流请求中的查询参数。如果请求被重写，则表示重写后的参数。 `${remote_addr}`：发送拉流请求的客户端 IP 地址。 `${server_addr}`：响应客户端拉流请求的 CDN 节点 IP 地址。 HTTP Header 类型为请求响应头时，支持使用以下变量为 Value 赋值： `${upstream_host}`：客户端拉流请求中使用的域名。 `${upstream_uri}`：客户端拉流请求中不包括查询参数的路径。如果请求被重写，则表示重写后的路径。 `${upstream_args}`：客户端拉流请求中的查询参数。如果请求被重写，则表示重写后的参数。 `${remote_addr}`：发送拉流请求的客户端 IP 地址。
HeaderFieldType	Integer	是	`0`	Header 配置中字段 Value 值的类型，取值及含义如下所示。 `0`：常量； `1`：变量。

HeaderValue

String

否

text/plain

Header 配置中字段的 Value 值，最大长度为 1024 个字符，支持使用常量和变量作为 Value 值。
HTTP Header 类型为回源请求头时，支持使用以下变量为 Value 赋值：

${domain}：客户端拉流请求中使用的域名。
${uri}：客户端拉流请求中不包括查询参数的路径。如果请求被重写，则表示重写后的路径。
${args}：客户端拉流请求中的查询参数。如果请求被重写，则表示重写后的参数。
${remote_addr}：发送拉流请求的客户端 IP 地址。
${server_addr}：响应客户端拉流请求的 CDN 节点 IP 地址。
HTTP Header 类型为请求响应头时，支持使用以下变量为 Value 赋值：
${upstream_host}：客户端拉流请求中使用的域名。
${upstream_uri}：客户端拉流请求中不包括查询参数的路径。如果请求被重写，则表示重写后的路径。
${upstream_args}：客户端拉流请求中的查询参数。如果请求被重写，则表示重写后的参数。
${remote_addr}：发送拉流请求的客户端 IP 地址。

HeaderFieldType

Integer

是

0

Header 配置中字段 Value 值的类型，取值及含义如下所示。

0：常量；
1：变量。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

POST https://live.volcengineapi.com?Action=UpdateHTTPHeaderConfig&Version=2023-01-01
{
    "Vhost": "push.example.com",
    "Domain": "pull.example.com",
    "Phase": 0,
    "HeaderConfigList": [
        {
            "HeaderKey": "Content-Type",
            "HeaderValue": "text/plain",
            "HeaderFieldType": 0
        }
    ],
    "BlockOriginal": 0,
    "Enable": true
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "UpdateHTTPHeaderConfig",
        "Version": "2023-01-01",
        "Service": "live",
        "Region": "cn-north-1"
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。

状态码	错误码	错误信息	说明
200	CommonErr	-	未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。
400	InvalidParam	-	输入的参数无效或不符合要求，请参照请求参数说明进行检查。
400	InvalidParam.BindError	Request parameter error, please check input data	参数未通过校验，请检查参数类型是否正确。
403	RequestForbidden	-	请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403	RequestForbidden.AccountIDNotAllow	this AccountID does not have permission to access the corresponding resource, please check the request parameters	请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403	RequestForbidden.BillingStatus	Billing status is not available for the AccountID, please activate the service or recharge.	未开通视频直播服务或账号欠费，造成账单不可用，请检查服务开通情况和账号欠费情况。
404	ResourceNotFound	-	未找到资源（域名空间、域名、应用、配置模版、证书）。建议重试，如果仍返回该错误码，请联系技术支持。
404	ResourceNotFound.DomainNotExist	domain not found	未找到域名（Domain）。请检查传入的域名是否与实际使用的域名一致。
500	InternalError	an internal error occurred, please contact the administrator.	出现内部错误，请联系技术支持。
500	InternalError.DB	an internal error related to database occurred, please contact the administrator.	出现与数据库相关的内部错误，请联系技术支持。
502	InternalServiceError	an internal error occurred, please contact the administrator.	服务间出现错误，请联系技术支持。
502	InternalServiceError.BadResponse	an internal error occurred, please contact the administrator.	服务间出现错误，请联系技术支持。
504	InternalServiceTimeout	Internal Service is timeout. please contact the administrator.	内部服务超时，请联系技术支持。

服务端 SDK

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