调用ListForwardingRules获取转发规则列表_全球加速(GA)-阿里云帮助中心

调用ListForwardingRules接口获取转发规则列表。

接口说明

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

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
ga:ListForwardingRules	list	Listener acs:ga:{#regionId}:{#accountId}:listener/{#listenerId}	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	全球加速实例所属的地域 ID，仅取值：cn-hangzhou。	cn-hangzhou
ClientToken	string	否	客户端 Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。说明若您未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。	02fb3da4****
ListenerId	string	是	监听实例 ID。	lsr-bp1s0vzbi5bxlx5pw****
AcceleratorId	string	是	全球加速实例 ID。	ga-bp17frjjh0udz4qzk****
ForwardingRuleId	string	否	转发策略 ID。	frule-bp19a3t3yzr21q3****
NextToken	string	否	是否拥有下一次查询的令牌（Token）。取值：第一次查询和没有下一次查询时，均无需填写。如果有下一次查询，取值为上一次 API 调用返回的 NextToken 值。	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	否	分批次查询时每次显示的条目数。取值范围：1~100。默认值：20。	20

返回参数

名称	类型	描述	示例值
	object	返回信息列表。
RequestId	string	请求 ID。	CFC67ED9-4AB1-431F-B6E3-A752B7B8CCD4
TotalCount	integer	列表条目数。	1
NextToken	string	是否拥有下一次查询的令牌（Token）。取值：如果 NextToken 为空表示没有下一次查询。如果 NextToken 有返回值，该取值表示下一次查询开始的令牌。	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	分批次查询时每次显示的条目数。	20
ForwardingRules	array<object>	转发策略信息列表。
	object	转发策略信息列表。
Priority	integer	转发策略优先级。返回为 1~10000。值越小表示优先级越高。	1000
ForwardingRuleId	string	转发策略 ID。	frule-bp19a3t3yzr21q3****
ForwardingRuleName	string	转发策略名称。	auto_named_rule
ForwardingRuleDirection	string	规则生效方向。目前默认返回 request，表示请求方向生效。	request
ForwardingRuleStatus	string	转发策略状态。 active：正常。 configuring：变配中。 deleting：删除中。	active
RuleConditions	array<object>	转发条件列表。
	object	转发条件列表。
RuleConditionType	string	转发条件类型。 Host：域名。 Path：路径。 RequestHeader：HTTP 标头。 Query：查询字符串。 Method：HTTP 请求方法。 Cookie：Cookie。 SourceIP：源 IP。	Host
RuleConditionValue	string	转发条件类型对应的值。根据 RuleConditionType 返回不同的 JSON 字符串值。当 RuleConditionType 为 Host 时，该参数返回域名条件配置信息。若一个转发规则内返回多个域名，多个域名间为“或”关系。当 RuleConditionType 为 Path 时，该参数返回路径条件配置信息。一个转发策略若返回多个路径类型转发规则，多个路径类型转发规则间为”或“关系，一个转发路径类型规则若返回多个路径，多个路径间为“或”关系。当 RuleConditionType 为 RequestHeader 时，该参数返回 HTTP 标头字段条件配置信息，由键（Key）和值（Value）组成。当 RuleConditionType 为 Query 时，该参数返回查询字符串条件配置信息，由键（Key）和值（Value）组成。当 RuleConditionType 为 Method 时，该参数返回请求方法配置信息。当 RuleConditionType 为 Cookie 时，该参数返回 Cookie 配置信息，由键（Key）和值（Value）组成。当 RuleConditionType 为 SourceIP 时，该参数返回源 IP 配置信息。若一个转发规则内返回了多个源 IP，多个 IP 之间为“或”关系。	["www.example.com", "www.aliyun.com"]
PathConfig	object	路径配置信息。说明针对 2022 年 07 月 12 日之后创建的全球加速实例，支持所有转发条件类型和转发动作类型，建议通过 RuleConditionType 和 RuleConditionValue 查看转发条件信息。
Values	array	路径配置信息。说明针对 2022 年 07 月 12 日之后创建的全球加速实例，支持所有转发条件类型和转发动作类型，建议通过 RuleConditionType 和 RuleConditionValue 查看转发条件信息。
	string	路径。路径长度为 1~128 个字符，必须以正斜线（/）开头，只允许包含字母、数字、美元符号（$）、短划线（-）、下划线（_）、半角句号（.）、加号（+）、正斜线（/）、and（&）、波浪线（~）、at（@）、半角冒号（:）、半角单引号（'），支持使用星号（）和半角问号（?）作为通配符。说明针对 2022 年 07 月 12 日之后创建的全球加速实例，支持所有转发条件类型和转发动作类型，建议通过 RuleConditionType* 和 RuleConditionValue 查看转发条件信息。	/test
HostConfig	object	域名配置信息。说明针对 2022 年 07 月 12 日之后创建的全球加速实例，支持所有转发条件类型和转发动作类型，建议通过 RuleConditionType 和 RuleConditionValue 查看转发条件信息。
Values	array	域名配置信息。说明针对 2022 年 07 月 12 日之后创建的全球加速实例，支持所有转发条件类型和转发动作类型，建议通过 RuleConditionType 和 RuleConditionValue 查看转发条件信息。
	string	域名。域名长度为 3~128 个字符，允许包含字母、数字、短划线（-）和半角句号（.），支持使用星号（）和半角问号（?）作为通配符。说明针对 2022 年 07 月 12 日之后创建的全球加速实例，支持所有转发条件类型和转发动作类型，建议通过 RuleConditionType* 和 RuleConditionValue 查看转发条件信息。	www.example.com
RuleActions	array<object>	转发动作。
	object	转发动作。
Order	integer	转发优先级。说明当前无实际意义。	1
RuleActionType	string	转发动作类型。 ForwardGroup：转发。 Redirect：重定向。 FixResponse：返回固定响应。 Rewrite：重写。 AddHeader：写入头字段。 RemoveHeader：删除头字段。 Drop：丢弃。	ForwardGroup
RuleActionValue	string	转发动作类型对应的值。根据 RuleActionType 返回不同的 JSON 字符串值。当 RuleActionType 为 ForwardGroup 时，该参数返回虚拟终端节点组信息。其中： `type`：`endpointgroup`。 `value`：目标虚拟终端节点组 ID。当 RuleActionType 为 Redirect 时，该参数返回重定向配置信息。其中： `protocol`：要跳转的协议。 `domain`：要跳转的域名。 `port`：要跳转的端口。 `path`：要跳转的路径。 `query`：要跳转的查询字符串。 `code`：跳转方式。当 RuleActionType 为 FixResponse 时，该参数返回配置的返回固定响应信息。其中： `code`：响应状态码。 `type`：响应正文类型。 `content`：响应正文。当 RuleActionType 为 AddHeader 时，该参数返回插入 HTTP 标头字段配置信息。其中： `name`：HTTP 标头字段名称。 `type`：HTTP 标头字段内容类型。 `value`：HTTP 标头字段内容。当 RuleActionType 为 RemoveHeader 时，该参数返回删除 HTTP 标头字段信息。当 RuleActionType 为 Rewrite 时，该参数返回重写配置信息。其中： `domain`：要跳转的域名。 `path`：要跳转的路径。 `query`：要跳转的查询字符串。当 RuleActionType 取值为 Drop 时，该参数返回空字符串。	[{"type":"endpointgroup", "value":"epg-bp1enpdcrqhl78g6r****"}]
ForwardGroupConfig	object	转发动作配置信息。说明针对 2022 年 07 月 12 日之后创建的全球加速实例，支持所有转发条件类型和转发动作类型，建议通过 RuleActionType 和 RuleActionValue 查看转发动作信息。
ServerGroupTuples	array<object>	终端节点组信息。说明针对 2022 年 07 月 12 日之后创建的全球加速实例，支持所有转发条件类型和转发动作类型，建议通过 RuleActionType 和 RuleActionValue 查看转发动作信息。
	object	终端节点组信息。说明针对 2022 年 07 月 12 日之后创建的全球加速实例，支持所有转发条件类型和转发动作类型，建议通过 RuleActionType 和 RuleActionValue 查看转发动作信息。
EndpointGroupId	string	终端节点组 ID。说明针对 2022 年 07 月 12 日之后创建的全球加速实例，支持所有转发条件类型和转发动作类型，建议通过 RuleActionType 和 RuleActionValue 查看转发动作信息。	epg-bp1enpdcrqhl78g6r****
ListenerId	string	监听实例 ID。	lsr-bp1s0vzbi5bxlx5****
ServiceId	string	托管实例所属的服务方 ID。说明仅在 ServiceManaged 参数为 True 时有效。	ALB
ServiceManaged	boolean	是否为托管实例。取值： true：是托管实例。 false：不是托管实例。	true
ServiceManagedInfos	array<object>	用户在此托管实例下可执行的动作策略列表。说明仅在 ServiceManaged 参数为 True 时有效。当实例处于托管状态时，用户对实例的操作会受到限制，某些操作行为会被禁止。
	object	用户在此托管实例下可执行的动作策略列表。
Action	string	托管策略动作名称，取值： Create：创建实例。 Update：更新当前实例。 Delete：删除当前实例。 Associate：引用/被引用当前实例。 UserUnmanaged：用户解托管实例。 CreateChild：在当前实例下创建子资源。	Update
ChildType	string	子资源类型，取值： Listener：监听资源。 IpSet：加速地域资源。 EndpointGroup：终端节点组资源。 ForwardingRule：转发策略资源。 Endpoint：终端节点资源。 EndpointGroupDestination：自定义路由监听下的终端节点组协议映射资源。 EndpointPolicy：自定义路由监听下的终端节点通行策略资源。说明仅在 Action 参数为 CreateChild 时有效。	Listener
IsManaged	boolean	托管策略动作是否被托管，取值： true：托管策略动作被托管，用户无权在托管实例下执行 Action 指定的操作。 false：托管策略动作未被托管，用户可在托管实例下执行 Action 指定的操作。	false

示例

正常返回示例

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****",
      "ServiceId": "ALB",
      "ServiceManaged": true,
      "ServiceManagedInfos": [
        {
          "Action": "Update",
          "ChildType": "Listener",
          "IsManaged": false
        }
      ]
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
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	StateError.Accelerator	The state of the accelerated instance is invalid.	加速实例状态非法。
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。

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

变更历史

变更时间	变更内容概要	操作
2024-08-30	OpenAPI 错误码发生变更	查看变更详情
2023-08-15	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情