GetRedirectRule - 查询重定向配置详情

查询站点的重定向配置的详情。

调试

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

授权信息

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

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

请求参数

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

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

34003500310****
ConfigIdlong

配置 ID。可通过调用 ListRedirectRules 接口获取。

35281609698****

返回参数

名称类型描述示例值
object

请求响应结果。

RequestIdstring

请求 ID。

0AEDAF20-4DDF-4165-8750-47FF9C1929C9
ConfigIdlong

配置 ID。

35281609698****
ConfigTypestring

配置类型。取值范围:

  • global:全局配置。
  • rule:规则配置。
rule
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
Typestring

重定向类型。取值范围:

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

重定向后的目标 URL。

http://www.exapmle.com/index.html
StatusCodestring

节点给客户端响应重定向地址时候使用的响应状态码。取值范围:

  • 301
  • 302
  • 303
  • 307
  • 308
301
ReserveQueryStringstring

保留查询字符串。取值范围:

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

示例

正常返回示例

JSON格式

{
  "RequestId": "0AEDAF20-4DDF-4165-8750-47FF9C1929C9",
  "ConfigId": 0,
  "ConfigType": "rule",
  "SiteVersion": 0,
  "Sequence": 1,
  "RuleEnable": "on",
  "Rule": "(http.host eq \"video.example.com\")",
  "RuleName": "rule_example",
  "Type": "static",
  "TargetUrl": "http://www.exapmle.com/index.html",
  "StatusCode": 301,
  "ReserveQueryString": "on"
}

错误码

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

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