添加 HTTP 请求头¶

1. 接口描述¶

接口请求路径：POST /prod-api/cdn/layer7/advance/addHttpHeaders

addHttpHeaders 用于为指定域名添加 HTTP 请求头规则，支持预设标准 Header 与自定义 Header。

Token 获取方式见密钥鉴权。

2. 输入参数¶

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

参数名称	必选	类型	描述
domainId	是	Integer	域名 ID 示例值：`195`
headerList	是	[L7HttpHeaderVO]	待添加的 HTTP 请求头列表

3. 示例¶

示例1 添加预设请求头¶

输入示例¶

{
  "domainId": 195,
  "headerList": [
    {
      "type": "Access-Control-Allow-Origin",
      "parameter": "Access-Control-Allow-Origin",
      "value": "*"
    }
  ]
}

代码调用¶

请将 {登录域名}、token 替换为实际值。

JavaGo

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class AddHttpHeadersTest {

    public static void main(String[] args) throws Exception {
        String url = "https://{登录域名}/prod-api/cdn/layer7/advance/addHttpHeaders";
        String token = "eyJhbGciOiJIUzUxMiJ9.xxxxxx";

        String requestBody = "{"
                + "\"domainId\":195,"
                + "\"headerList\":["
                + "{\"type\":\"Access-Control-Allow-Origin\","
                + "\"parameter\":\"Access-Control-Allow-Origin\","
                + "\"value\":\"*\"}"
                + "]}";

        try (CloseableHttpClient httpClient = HttpClients.createDefault()) {
            HttpPost httpPost = new HttpPost(url);
            httpPost.setHeader("Authorization", "Bearer " + token);
            httpPost.setEntity(new StringEntity(requestBody, ContentType.APPLICATION_JSON));

            try (CloseableHttpResponse response = httpClient.execute(httpPost)) {
                int statusCode = response.getStatusLine().getStatusCode();
                String body = EntityUtils.toString(response.getEntity(), "UTF-8");
                System.out.println("Status Code: " + statusCode);
                System.out.println("Body: " + body);
            }
        }
    }
}

package main

import (
    "bytes"
    "fmt"
    "io"
    "net/http"
)

func main() {
    url := "https://{登录域名}/prod-api/cdn/layer7/advance/addHttpHeaders"
    token := "eyJhbGciOiJIUzUxMiJ9.xxxxxx"

    requestBody := []byte(`{
  "domainId": 195,
  "headerList": [
    {
      "type": "Access-Control-Allow-Origin",
      "parameter": "Access-Control-Allow-Origin",
      "value": "*"
    }
  ]
}`)

    req, err := http.NewRequest(http.MethodPost, url, bytes.NewReader(requestBody))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer "+token)
    req.Header.Set("Content-Type", "application/json")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println("Status Code:", resp.StatusCode)
    fmt.Println("Body:", string(body))
}

输出示例¶

{
  "msg": "更新成功",
  "code": 200
}

添加自定义请求头（type 传 0，parameter 传自定义 Header 名称）：

{
  "domainId": 195,
  "headerList": [
    {
      "type": "0",
      "parameter": "X-Custom-Header",
      "value": "custom-value"
    }
  ]
}

4. 输出参数¶

参数名称	类型	描述
code	Integer	状态码。示例值：`200`
msg	String	提示信息。示例值：`更新成功`

5. parameter 与 type 填写说明¶

场景	`type`	`parameter`
预设请求头	与 `parameter` 相同，均为下方标准 Header 名	标准 Header 名
自定义请求头	固定传 `0`	自定义的 Header 名称

预设 parameter / type 可选值

值
`Access-Control-Allow-Origin`
`Access-Control-Expose-Headers`
`Content-Language`
`Access-Control-Max-Age`
`Content-Disposition`
`Access-Control-Allow-Methods`

6. 错误码¶

HTTP 状态码 / 业务提示	描述
200	成功
401	未鉴权或 Token 无效
403	无权限
请填写header内容	`headerList` 为空或 Header 内容不完整
域名ID不存在请刷新后重试	域名不存在或不属于当前账号

7. 数据模型¶

L7HttpHeaderVO¶

HTTP 请求头配置项。

参数名称	必选	类型	描述
parameter	是	String	Header 名称。预设：传标准 Header 名，且与 `type` 相同；自定义：传实际 Header 名，`type` 传 `0`
type	是	String	Header 类型。预设：与 `parameter` 传相同的标准 Header 名；自定义：固定传 `0`
value	是	String	Header 值示例值：`*`