调用ListGatewayFlowRule API查询云原生网关流控规则-微服务引擎-阿里云

查询该网关流控规则。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

mse:ListGatewayFlowRule

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
FilterParams	string	是	just for POP	param
AcceptLanguage	string	否	返回结果显示的语言。取值：zh（默认值）：中文，en：英文	zh

返回参数

名称	类型	描述	示例值
	object	RestResult<PageResult>
RequestId	string	请求 ID。	0951EBF0-798E-5E0B-8D38-460A14AD****
Data	object	Meta 返回信息。
PageNumber	integer	实例列表的页码	1
TotalSize	integer	查询到的实例总数	1
PageSize	integer	输入时设置的每页行数	100
Result	array	返回数据。
	object	返回集合。
Id	integer	路由流控规则 ID。	549
GatewayId	integer	网关 ID。	14407
GatewayUniqueId	string	网关唯一标识 ID。	gw-e2d226bba4b2445c9e29fa7f8216****
RouteId	integer	路由 ID。	48811
RouteName	string	路由名称。	routeA
Threshold	integer	总体 QPS 阈值。	10
BehaviorType	integer	Web fallback 行为类型。 0：返回指定内容 1：跳转到指定页面	0
BodyEncoding	integer	编码类型。 0：普通文本 1：JSON	0
ResponseStatusCode	integer	Http 状态码。	429
ResponseContentBody	string	Http 返回文本。	text
ResponseRedirectUrl	string	跳转地址。	www.******.com
Enable	integer	是否开启。 0：不开启。 1：开启。	0
Results	array	分页数据集合。
	object	返回集合。
Id	integer	路由流控规则 ID。	549
GatewayId	integer	网关 ID。	14407
GatewayUniqueId	string	网关唯一标识 ID。	gw-e2d226bba4b2445c9e29fa7f8216****
RouteId	integer	路由 ID。	48811
RouteName	string	路由名称。	routeA
Threshold	integer	总体 QPS 阈值。	10
StatDurationMs	integer	统计持续时间。	10
LimitMode	integer	阈值转化模式。 0：单机。 1：集群。 2：集群转单机。	0
BehaviorType	integer	Web fallback 行为类型。 0：返回指定内容 1：跳转到指定页面	0
BodyEncoding	integer	编码类型。 0：普通文本 1：JSON	0
ResponseStatusCode	integer	Http 状态码。	429
ResponseContentBody	string	Http 返回文本。	text
ResponseRedirectUrl	string	跳转地址。	www.******.com
ResponseAdditionalHeaders	string	自定义 header，输入为 key-value 键值对。	key=value
Enable	integer	是否开启。 0：不开启。 1：开启。	0
IdList	array	筛选规则 id。
	integer	规则 ID。	549

示例

正常返回示例

JSON格式

{
  "RequestId": "0951EBF0-798E-5E0B-8D38-460A14AD****",
  "Data": {
    "PageNumber": 1,
    "TotalSize": 1,
    "PageSize": 100,
    "Result": [
      {
        "Id": 549,
        "GatewayId": 14407,
        "GatewayUniqueId": "gw-e2d226bba4b2445c9e29fa7f8216****",
        "RouteId": 48811,
        "RouteName": "routeA",
        "Threshold": 10,
        "BehaviorType": 0,
        "BodyEncoding": 0,
        "ResponseStatusCode": 429,
        "ResponseContentBody": "text",
        "ResponseRedirectUrl": "www.******.com",
        "Enable": 0
      }
    ],
    "Results": [
      {
        "Id": 549,
        "GatewayId": 14407,
        "GatewayUniqueId": "gw-e2d226bba4b2445c9e29fa7f8216****",
        "RouteId": 48811,
        "RouteName": "routeA",
        "Threshold": 10,
        "StatDurationMs": 10,
        "LimitMode": 0,
        "BehaviorType": 0,
        "BodyEncoding": 0,
        "ResponseStatusCode": 429,
        "ResponseContentBody": "text",
        "ResponseRedirectUrl": "www.******.com",
        "ResponseAdditionalHeaders": "key=value",
        "Enable": 0,
        "IdList": [
          549
        ]
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	IllegalRequest	Invalid request:%s	非法请求： %s
400	InvalidParameter	Parameter error:%s	请求参数错误：%s
500	InternalError	Console error. Try again later:%s	控制台错误.稍后重试：%s
403	NoPermission	You are not authorized to perform this operation:%s	没有权限使用此接口：%s
404	NotFound	Not found:%s	资源不存在：%s

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

变更历史

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