文档首页/ Web应用防火墙 WAF/ API参考 (巴黎) / API说明/ 云模式/ 获取选项信息/ 查询获取真实源IP的HTTP请求头的选项信息
更新时间:2022-02-22 GMT+08:00

查询获取真实源IP的HTTP请求头的选项信息

功能介绍

查询获取真实源IP的HTTP请求头的选项信息。

URI

  • URI格式

    GET /v1/{project_id}/waf/map/sipheader?lang={lang}

  • 参数说明
    表1 Path参数说明

    名称

    是否必选

    参数类型

    说明

    project_id

    String

    用户操作的项目ID。

    lang

    String

    语言类型,zh-cn代表中文,en-us代表英文,默认是英文。

请求消息

请求参数

响应消息

响应参数
表2 响应参数说明

名称

参数类型

说明

sipheadermap

表3

对应的选项。

locale

表4

对应的名称。

表3 sipheadermap

名称

参数类型

说明

default

Array

默认获取真实源IP的HTTP请求头。

cloudflare

Array

CloudFlare获取真实源IP的HTTP请求头。

akamai

Array

Akamai获取真实源IP的HTTP请求头。

custom

Array

自定义获取真实源IP的HTTP请求头。

表4 locale

名称

参数类型

说明

default

String

默认。

cloudflare

String

CloudFlare。

akamai

String

Akamai。

custom

String

自定义。

示例

如下以查询获取真实源IP的HTTP请求头为例。

响应样例
{
  "sipheadermap": {
      "default": ["X-Forwarded-For"],
      "cloudflare": ["CF-Connecting-IP", "X-Forwarded-For"],
      "akamai": ["True-Client-IP"],
      "custom": []
  },
  "locale": {
       "default": "Default",
       "cloudflare": "CloudFlare",
       "akamai": "Akamai",
       "custom": "Custom"
   }
}

状态码

表5描述的是API返回的正常状态码。
表5 状态码

状态码

编码

状态说明

200

OK

客户端请求已处理成功。

异常状态码,请参见状态码