文档

ListGatewayFlowRule - 查询网关流控规则

更新时间:

查询该网关流控规则。

调试

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

授权信息

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

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

请求参数

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

just for POP

param
AcceptLanguagestring

返回结果显示的语言。取值:zh(默认值):中文,en:英文

zh

返回参数

名称类型描述示例值
object

RestResult<PageResult>

RequestIdstring

请求 ID。

0951EBF0-798E-5E0B-8D38-460A14AD****
Dataobject

Meta 返回信息。

PageNumberinteger

实例列表的页码

1
TotalSizeinteger

查询到的实例总数

1
PageSizeinteger

输入时设置的每页行数

100
Resultarray<object>

返回数据。

object

返回集合。

Idlong

路由流控规则 ID。

549
GatewayIdlong

网关 ID。

14407
GatewayUniqueIdstring

网关唯一标识 ID。

gw-e2d226bba4b2445c9e29fa7f8216****
RouteIdlong

路由 ID。

48811
RouteNamestring

路由名称。

routeA
Thresholdinteger

总体 QPS 阈值。

10
BehaviorTypeinteger

Web fallback 行为类型。

0:返回指定内容

1:跳转到指定页面

0
BodyEncodinginteger

编码类型。

0:普通文本

1:JSON

0
ResponseStatusCodeinteger

Http 状态码。

429
ResponseContentBodystring

Http 返回文本。

text
ResponseRedirectUrlstring

跳转地址。

www.******.com
Enableinteger

是否开启。

0:不开启。

1:开启。

0
Resultsarray<object>

分页数据集合。

object

返回集合。

Idlong

路由流控规则 ID。

549
GatewayIdlong

网关 ID。

14407
GatewayUniqueIdstring

网关唯一标识 ID。

gw-e2d226bba4b2445c9e29fa7f8216****
RouteIdlong

路由 ID。

48811
RouteNamestring

路由名称。

routeA
Thresholdinteger

总体 QPS 阈值。

10
StatDurationMsinteger

统计持续时间。

10
LimitModeinteger

阈值转化模式。

0:单机。

1:集群。

2:集群转单机。

0
BehaviorTypeinteger

Web fallback 行为类型。

0:返回指定内容

1:跳转到指定页面

0
BodyEncodinginteger

编码类型。

0:普通文本

1:JSON

0
ResponseStatusCodeinteger

Http 状态码。

429
ResponseContentBodystring

Http 返回文本。

text
ResponseRedirectUrlstring

跳转地址。

www.******.com
ResponseAdditionalHeadersstring

自定义 header,输入为 key-value 键值对。

key=value
Enableinteger

是否开启。

0:不开启。

1:开启。

0
IdListarray

筛选规则 id。

long

规则 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错误码错误信息描述
400IllegalRequestInvalid request:%s非法请求: %s
400InvalidParameterParameter error:%s请求参数错误:%s
403NoPermissionYou are not authorized to perform this operation:%s没有权限使用此接口:%s
404NotFoundNot found:%s资源不存在:%s
500InternalErrorConsole error. Try again later:%s控制台错误.稍后重试:%s

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