调用ListForwardingRules接口查看已经创建的转发策略信息。

说明 调用该接口只能查看自定义转发策略信息,无法查看默认转发策略信息。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ListForwardingRules

系统规定参数。取值:ListForwardingRules

RegionId String cn-hangzhou

全球加速实例所属的地域ID,仅取值:cn-hangzhou

ClientToken String 02fb3da4****

客户端Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。

说明 若您未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。
ListenerId String lsr-bp1s0vzbi5bxlx5pw****

监听实例ID。

AcceleratorId String ga-bp17frjjh0udz4qzk****

全球加速实例ID。

ForwardingRuleId String frule-bp19a3t3yzr21q3****

转发策略ID。

NextToken String FFmyTO70tTpLG6I3FmYAXGKPd****

是否拥有下一次查询的令牌(Token)。取值:

  • 第一次查询和没有下一次查询时,均无需填写。
  • 如果有下一次查询,取值为上一次API调用返回的NextToken值。
MaxResults Integer 20

分批次查询时每次显示的条目数。取值范围:1~100。默认值:20

返回数据

名称 类型 示例值 描述
RequestId String CFC67ED9-4AB1-431F-B6E3-A752B7B8CCD4

请求ID。

TotalCount Integer 1

列表条目数。

NextToken String FFmyTO70tTpLG6I3FmYAXGKPd****

是否拥有下一次查询的令牌(Token)。取值:

  • 如果NextToken为空表示没有下一次查询。
  • 如果NextToken有返回值,该取值表示下一次查询开始的令牌。
MaxResults Integer 20

分批次查询时每次显示的条目数。

ForwardingRules Array of ForwardingRules

转发策略信息列表。

Priority Integer 1000

转发策略优先级。

返回为1~10000。值越小表示优先级越高。

ForwardingRuleId String frule-bp19a3t3yzr21q3****

转发策略ID。

ForwardingRuleName String auto_named_rule

转发策略名称。

ForwardingRuleDirection String request

规则生效方向。

目前默认返回request,表示请求方向生效。

ForwardingRuleStatus String active

转发策略状态。

  • active:正常。
  • configuring:变配中。
  • deleting:删除中。
RuleConditions Array of RuleConditions

转发条件列表。

RuleConditionType String Host

转发条件类型。

  • Host:域名。
  • Path:路径。
  • RequestHeader:HTTP标头。
  • Query:查询字符串。
  • Method:HTTP请求方法。
  • Cookie:Cookie。
  • SourceIP:源IP。
RuleConditionValue String ["www.example.com", "www.aliyun.com"]

转发条件类型对应的值。

根据RuleConditionType返回不同的JSON字符串值。

  • RuleConditionTypeHost时,该参数返回域名条件配置信息。若一个转发规则内返回多个域名,多个域名间为“或”关系。
  • RuleConditionTypePath时,该参数返回路径条件配置信息。一个转发策略若返回多个路径类型转发规则,多个路径类型转发规则间为”或“关系,一个转发路径类型规则若返回多个路径,多个路径间为“或”关系。
  • RuleConditionTypeRequestHeader时,该参数返回HTTP标头字段条件配置信息,由键(Key)和值(Value)组成。
  • RuleConditionTypeQuery时,该参数返回查询字符串条件配置信息,由键(Key)和值(Value)组成。
  • RuleConditionTypeMethod时,该参数返回请求方法配置信息。
  • RuleConditionTypeCookie时,该参数返回Cookie配置信息,由键(Key)和值(Value)组成。
  • RuleConditionTypeSourceIP时,该参数返回源IP配置信息。若一个转发规则内返回了多个源IP,多个IP之间为“或”关系。
PathConfig Object

路径配置信息。

Values Array of String /test

路径。

路径长度为1~128个字符,必须以正斜线(/)开头,只允许包含字母、数字、美元符号($)、短划线(-)、下划线(_)、半角句号(.)、加号(+)、正斜线(/)、and(&)、波浪线(~)、at(@)、半角冒号(:)、半角单引号('),支持使用星号(*)和半角问号(?)作为通配符。

HostConfig Object

域名配置信息。

Values Array of String www.example.com

域名。

域名长度为3~128个字符,允许包含字母、数字、短划线(-)和半角句号(.),支持使用星号(*)和半角问号(?)作为通配符。

RuleActions Array of RuleActions

转发动作。

Order Integer 1

转发优先级。

说明 当前无实际意义。
RuleActionType String ForwardGroup

转发动作类型。

  • ForwardGroup:转发。
  • Redirect:重定向。
  • FixResponse:返回固定响应。
  • Rewrite:重写。
  • AddHeader:写入头字段。
  • RemoveHeader:删除头字段。
RuleActionValue String [{"type":"endpointgroup", "value":"epg-bp1enpdcrqhl78g6r****"}]

转发动作类型对应的值。

根据RuleActionType返回不同的JSON字符串值。

  • RuleActionTypeForwardGroup时,该参数返回虚拟终端节点组信息。其中:
    • typeendpointgroup
    • value:目标虚拟终端节点组ID。
  • RuleActionTypeRedirect时,该参数返回重定向配置信息。其中:
    • protocol:要跳转的协议。
    • domain:要跳转的域名。
    • port:要跳转的端口。
    • path:要跳转的路径。
    • query:要跳转的查询字符串。
    • code:跳转方式。
  • RuleActionTypeFixResponse时,该参数返回配置的返回固定响应信息。其中:
    • code:响应状态码。
    • type:响应正文类型。
    • content:响应正文。
  • RuleActionTypeAddHeader时,该参数返回插入HTTP标头字段配置信息。其中:
    • name:HTTP标头字段名称。
    • type:HTTP标头字段内容类型。
    • value:HTTP标头字段内容。
  • RuleActionTypeRemoveHeader时,该参数返回删除HTTP标头字段信息。
  • RuleActionTypeRewrite时,该参数返回重写配置信息。其中:
    • domain:要跳转的域名。
    • path:要跳转的路径。
    • query:要跳转的查询字符串。
ForwardGroupConfig Object

转发动作配置信息。

ServerGroupTuples Array of ServerGroupTuples

终端节点组信息。

EndpointGroupId String epg-bp1enpdcrqhl78g6r****

终端节点组ID。

ListenerId String lsr-bp1s0vzbi5bxlx5****

监听实例ID。

示例

请求示例

http(s)://[Endpoint]/?Action=ListForwardingRules
&RegionId=cn-hangzhou
&ClientToken=02fb3da4****
&ListenerId=lsr-bp1s0vzbi5bxlx5pw****
&AcceleratorId=ga-bp17frjjh0udz4qzk****
&ForwardingRuleId=frule-bp19a3t3yzr21q3****
&NextToken=FFmyTO70tTpLG6I3FmYAXGKPd****
&MaxResults=20
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListForwardingRulesResponse>
    <RequestId>CFC67ED9-4AB1-431F-B6E3-A752B7B8CCD4</RequestId>
    <TotalCount>1</TotalCount>
    <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>
    <MaxResults>20</MaxResults>
    <ForwardingRules>
        <Priority>1000</Priority>
        <ForwardingRuleId>frule-bp19a3t3yzr21q3****</ForwardingRuleId>
        <ForwardingRuleName>auto_named_rule</ForwardingRuleName>
        <ForwardingRuleDirection>request</ForwardingRuleDirection>
        <ForwardingRuleStatus>active</ForwardingRuleStatus>
        <RuleConditions>
            <RuleConditionType>Host</RuleConditionType>
            <RuleConditionValue>["www.example.com", "www.aliyun.com"]</RuleConditionValue>
            <PathConfig>
                <Values>/test</Values>
            </PathConfig>
            <HostConfig>
                <Values>www.example.com</Values>
            </HostConfig>
        </RuleConditions>
        <RuleActions>
            <Order>1</Order>
            <RuleActionType>ForwardGroup</RuleActionType>
            <RuleActionValue>[{"type":"endpointgroup", "value":"epg-bp1enpdcrqhl78g6r****"}]</RuleActionValue>
            <ForwardGroupConfig>
                <ServerGroupTuples>
                    <EndpointGroupId>epg-bp1enpdcrqhl78g6r****</EndpointGroupId>
                </ServerGroupTuples>
            </ForwardGroupConfig>
        </RuleActions>
        <ListenerId>lsr-bp1s0vzbi5bxlx5****</ListenerId>
    </ForwardingRules>
</ListForwardingRulesResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "CFC67ED9-4AB1-431F-B6E3-A752B7B8CCD4",
  "TotalCount" : 1,
  "NextToken" : "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "MaxResults" : 20,
  "ForwardingRules" : [ {
    "Priority" : 1000,
    "ForwardingRuleId" : "frule-bp19a3t3yzr21q3****",
    "ForwardingRuleName" : "auto_named_rule",
    "ForwardingRuleDirection" : "request",
    "ForwardingRuleStatus" : "active",
    "RuleConditions" : [ {
      "RuleConditionType" : "Host",
      "RuleConditionValue" : "[\"www.example.com\", \"www.aliyun.com\"]",
      "PathConfig" : {
        "Values" : [ "/test" ]
      },
      "HostConfig" : {
        "Values" : [ "www.example.com" ]
      }
    } ],
    "RuleActions" : [ {
      "Order" : 1,
      "RuleActionType" : "ForwardGroup",
      "RuleActionValue" : "[{\"type\":\"endpointgroup\", \"value\":\"epg-bp1enpdcrqhl78g6r****\"}]",
      "ForwardGroupConfig" : {
        "ServerGroupTuples" : [ {
          "EndpointGroupId" : "epg-bp1enpdcrqhl78g6r****"
        } ]
      }
    } ],
    "ListenerId" : "lsr-bp1s0vzbi5bxlx5****"
  } ]
}

错误码

HttpCode 错误码 错误信息 描述
400 NotExist.Listener The listener does not exist. 监听器不存在
400 NotActive.Listener The state of the listener is not active. 监听器状态非稳态
400 NotExist.Accelerator The accelerated instance does not exist. 加速实例不存在。
400 NotExist.BusinessRegion The business region does not exist. 业务region并不存在
400 NotExist.BasicBandwidthPackage You must specify the basic bandwidth package. 缺少基础带宽包
400 QuotaExceeded.EndPoint The maximum number of endpoints is exceeded. 终端节点达到Quota限制
400 Exist.EndpointGroup The endpoint group already exists. 终端节点组已经存在
400 NoPermission.VpcEndpoint You are not authorized to perform the operation. 用户没有创建服务关联角色的权限,请联系主账号或权限管理员授权当前用户AliyunGlobalAccelerationFullAccess或者创建服务关联角色的自定义权限。自定义权限策略的相关信息包含以下内容:ServiceName为vpcendpoint.ga.aliyuncs.com,服务关联角色名称为AliyunServiceRoleForGaVpcEndpoint,执行该操作所需的用户权限为ram:CreateServiceLinkedRole。

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