ListOriginRules - 查询站点回源规则配置列表 - 边缘安全加速

查询多条回源规则配置。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

esa:ListOriginRules

none

*Site

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

无

请求参数

名称	类型	必填	描述	示例值
SiteId	integer	是	站点 ID，可通过调用 ListSites 接口获取。	1234567890123
ConfigId	integer	否	配置 ID。	35281609698****
ConfigType	string	否	配置类型，可以根据此参数查全局配置或者规则配置，取值范围： global：查询全局配置。 rule：查询规则配置。该参数可以不传，不传时不区分全局或者规则配置。	global
RuleName	string	否	规则名称。添加全局配置的时候不需要设置该参数。	test
PageNumber	integer	否	第几页，不传时默认为 1。	1
PageSize	integer	否	每页几条，最大 500，不传时默认 500。	20
SiteVersion	integer	否	站点的版本号。开启了版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本 0。	1

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	0AEDAF20-4DDF-4165-8750-47FF9C1929C9
Configs	array<object>	返回体配置。
	object
ConfigId	integer	配置 ID。	395386449776640
SiteVersion	integer	站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本 0。	1
Sequence	integer	规则执行顺序。数值越小越优先执行。	1
RuleEnable	string	规则开关。添加全局配置的时候不需要设置该参数。取值范围： on：开启。 off：关闭。	on
Rule	string	规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：匹配所有传入请求：值设置为 true 匹配指定请求：值设置为自定义表达式，例如：(http.host eq "video.example.com")	(http.host eq \"video.example.com\")
RuleName	string	规则名称。添加全局配置的时候不需要设置该参数。	rule_example
ConfigType	string	配置类型，可以根据此参数查全局配置或者规则配置，取值范围： global：查询全局配置。 rule：查询规则配置。	global
OriginHost	string	回源请求中携带的 HOST。	origin.example.com
OriginScheme	string	回源请求使用的协议。取值范围： http：使用 HTTP 协议回源。 https：使用 HTTPS 协议回源。 follow：跟随客户端协议回源。	http
OriginSni	string	回源请求中携带的 SNI。	origin.example.com
DnsRecord	string	改写回源请求的 DNS 解析记录。	test.example.com
OriginHttpPort	string	使用 HTTP 协议回源时访问的源站端口。	8080
OriginHttpsPort	string	使用 HTTPS 协议回源时访问的源站端口。	4433
Range	string	使用 range 分片方式回源下载文件。取值范围： on：开启 off：关闭 force：强制	on
OriginMtls	string	mtls 开关。取值范围： on：开启。 off：关闭。	on
OriginVerify	string	源站证书校验开关。取值范围： on：开启。 off：关闭。	on
RangeChunkSize	string	range 分片大小。	1MB
OriginReadTimeout	string	源站读超时时间(秒)。	10
Follow302Enable	string	回源 302 跟随开关。取值范围： on：开启。 off：关闭。	on
Follow302MaxTries	string	302 跟随次数上限，取值范围[1-5]。	1
Follow302RetainArgs	string	保留原始请求参数开关。取值范围： on：开启。 off：关闭。	on
Follow302RetainHeader	string	保留原始请求头开关。取值范围： on：开启。 off：关闭。	on
Follow302TargetHost	string	修改 302 后的回源 host。	test.com
PageNumber	integer	当前页码。	1
PageSize	integer	分页大小。	10
TotalCount	integer	记录总数。	100
TotalPage	integer	总页数。	2

示例

正常返回示例

JSON格式

{
  "RequestId": "0AEDAF20-4DDF-4165-8750-47FF9C1929C9",
  "Configs": [
    {
      "ConfigId": 395386449776640,
      "SiteVersion": 1,
      "Sequence": 1,
      "RuleEnable": "on",
      "Rule": "(http.host eq \\\"video.example.com\\\")\n",
      "RuleName": "rule_example",
      "ConfigType": "global",
      "OriginHost": "origin.example.com\n",
      "OriginScheme": "http",
      "OriginSni": "origin.example.com",
      "DnsRecord": "test.example.com\n",
      "OriginHttpPort": "8080",
      "OriginHttpsPort": "4433",
      "Range": "on",
      "OriginMtls": "on",
      "OriginVerify": "on",
      "RangeChunkSize": "1MB",
      "OriginReadTimeout": "10",
      "Follow302Enable": "on",
      "Follow302MaxTries": "1",
      "Follow302RetainArgs": "on",
      "Follow302RetainHeader": "on",
      "Follow302TargetHost": "test.com"
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 100,
  "TotalPage": 2
}

错误码

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

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

变更历史

更多信息，参考变更详情。