ListHttpResponseHeaderModificationRules - 查询修改HTTP响应头的配置列表

更新时间:2025-04-16 06:11:00

查询站点的修改HTTP响应头的配置列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
操作访问级别资源类型条件关键字关联操作
esa:ListHttpResponseHeaderModificationRulesnone
*Site
acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

请求参数

名称类型必填描述示例值
名称类型必填描述示例值
SiteIdlong

站点 ID,可通过调用 ListSites 接口获取。

123456****
ConfigIdlong

配置 ID。

35281609698****
ConfigTypestring

配置类型,可以根据此参数查全局配置或者规则配置,取值范围:

  • global:查询全局配置。
  • rule:查询规则配置。

该参数可以不传,不传时不区分全局或者规则配置。

rule
RuleNamestring

规则名称。添加全局配置的时候不需要设置该参数。

rule_example
PageNumberinteger

页码。

1
PageSizeinteger

分页大小,默认 500。取值范围:1~500 之前的任意整数。

20
SiteVersioninteger

站点配置的版本号。开启了配置版本管理的站点,可以通过该参数指定配置生效的站点版本,默认为版本 0。

0

返回参数

名称类型描述示例值
名称类型描述示例值
object

请求响应结果。

RequestIdstring

请求 ID。

CB1A380B-09F0-41BB-280B-72F8FD6DA2FE
Configsarray<object>

修改 HTTP 响应头列表。

configsobject

修改 HTTP 响应头详情。

ConfigIdlong

配置 ID。

35281609698****
SiteVersioninteger

站点配置的版本号。开启了配置版本管理的站点,可以通过该参数指定配置生效的站点版本,默认为版本 0。

0
Sequenceinteger

规则执行顺序。数值越小越优先执行。

1
RuleEnablestring

规则开关。添加全局配置的时候不需要设置该参数。取值范围:

  • on:开启。
  • off:关闭。
on
Rulestring

规则内容,使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景:

  • 匹配所有传入请求:值设置为 true
  • 匹配指定请求:值设置为自定义表达式,例如:(http.host eq "video.example.com")
(http.host eq "video.example.com")
RuleNamestring

规则名称。添加全局配置的时候不需要设置该参数。

rule_example
ConfigTypestring

配置类型。取值范围:

  • global:全局配置。
  • rule:规则配置。
rule
ResponseHeaderModificationarray<object>

修改响应头,支持添加、删除、修改三种操作方式。

ItemResponseHeaderobject

响应头详情。

Namestring

响应头名称。

headerName
Operationstring

操作方式。取值范围:

  • add:添加。
  • del:删除
  • modify:变更。
add
Valuestring

响应头值。

headerValue
Typestring

值类型。取值范围:

  • static:静态模式。
  • dynamic:动态模式。
static
PageNumberinteger

页码。

1
PageSizeinteger

分页大小。

20
TotalCountinteger

总条数。

14
TotalPageinteger

总页数。

1

示例

正常返回示例

JSON格式

{
  "RequestId": "CB1A380B-09F0-41BB-280B-72F8FD6DA2FE",
  "Configs": [
    {
      "ConfigId": 0,
      "SiteVersion": 0,
      "Sequence": 1,
      "RuleEnable": "on",
      "Rule": "(http.host eq \"video.example.com\")\n",
      "RuleName": "rule_example",
      "ConfigType": "rule",
      "ResponseHeaderModification": [
        {
          "Name": "headerName",
          "Operation": "add",
          "Value": "headerValue",
          "Type": "static"
        }
      ]
    }
  ],
  "PageNumber": 1,
  "PageSize": 20,
  "TotalCount": 14,
  "TotalPage": 1
}

错误码

HTTP status code错误码错误信息描述
HTTP status code错误码错误信息描述
400InternalExceptionFailed to call the service. Try again later or contact technical support.调用服务失败,请稍后重试或联系客服咨询详情。
400InvalidParameter.FunctionNameThe specified feature does not exist. Specify a valid feature name based on the related documentation.您所输入的功能名称不存在,请参照功能配置文档选择正确的功能名进行操作。

访问错误中心查看更多错误码。

  • 本页导读
  • 调试
  • 授权信息
  • 请求参数
  • 返回参数
  • 示例
  • 错误码