AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 边缘安全加速 边缘安全加速 ESA（全新一代） 开发参考 API参考 API目录 站点配置 规则配置 回源规则 GetOriginRule - 查询站点回源规则配置

GetOriginRule - 查询站点回源规则配置

更新时间：
产品详情
我的收藏

查询单条回源规则配置。

调试

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

授权信息

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

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

请求参数

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

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

3400350********
ConfigIdlong是

配置的 ConfigId，可通过调用 ListOriginRules 接口获取 ConfigId。

33793140540****

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

04F0F334-1335-436C-A1D7-6C044FE73368
ConfigIdlong

配置 ID。

352816096987136
ConfigTypestring

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

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

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

1
Sequenceinteger

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

1
RuleEnablestring

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

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

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

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

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

rule_example
OriginHoststring

回源请求中携带的 HOST。

origin.example.com
OriginSchemestring

回源请求使用的协议。取值范围：

  • http：使用 HTTP 协议回源。
  • https：使用 HTTPS 协议回源。
  • follow：跟随客户端协议回源。
http
OriginSnistring

回源请求中携带的 SNI。

origin.example.com
DnsRecordstring

改写回源请求的 DNS 解析记录。

test.example.com
OriginHttpPortstring

使用 HTTP 协议回源时访问的源站端口。

8080
OriginHttpsPortstring

使用 HTTPS 协议回源时访问的源站端口。

4433
Rangestring

使用 range 分片方式回源下载文件。取值范围：

  • on：开启。
  • off：关闭。
  • force：强制。
on
OriginMtlsstring

mtls 开关。取值范围：

  • on：开启。
  • off：关闭。
on
OriginVerifystring

源站证书校验开关。取值范围：

  • on：开启。
  • off：关闭。
on
RangeChunkSizestring

range 分片大小。取值范围：

  • 512KB
  • 1MB
  • 2MB
  • 4MB
1MB
OriginReadTimeoutstring

源站读超时时间(秒)。

10
Follow302Enablestring

回源 302 跟随开关。取值范围：

  • on：开启。
  • off：关闭。
on
Follow302MaxTriesstring

302 跟随次数上限，取值范围[1-5]。

1
Follow302RetainArgsstring

保留原始请求参数开关。取值范围：

  • on：开启。
  • off：关闭。
on
Follow302RetainHeaderstring

保留原始请求头开关。取值范围：

  • on：开启。
  • off：关闭。
on
Follow302TargetHoststring

修改 302 后的回源 host。

test.com

示例

正常返回示例

JSON格式

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "ConfigId": 352816096987136,
  "ConfigType": "rule",
  "SiteVersion": 1,
  "Sequence": 1,
  "RuleEnable": "on",
  "Rule": "(http.host eq \\\"video.example.com\\\")\n",
  "RuleName": "rule_example",
  "OriginHost": "origin.example.com\n",
  "OriginScheme": "http",
  "OriginSni": "origin.example.com\n",
  "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"
}

错误码

HTTP status code错误码错误信息描述
400InternalExceptionFailed to call the service. Try again later or contact technical support.调用服务失败，请稍后重试或联系客服咨询详情。

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

变更历史

变更时间变更内容概要操作
2025-02-27OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
上一篇：UpdateOriginRule - 修改站点回源规则配置下一篇：ListOriginRules - 查询站点回源规则配置列表