ListWebFlowRules - 查询热点参数防护规则（HTTP）_微服务引擎(MSE)-阿里云帮助中心

查询热点参数防护规则（HTTP 请求）。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

mse:ListWebFlowRules

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
Namespace	string	否	命名空间。	default
AppName	string	是	应用名称。	spring-cloud-a
ResourceSearchKey	string	否	查找包含接口关键字的防护规则（与 Resource 不可同时存在）。	flow
AppId	string	否	应用 Id	b22qb1**@2f0586be4b1**
Resource	string	否	查找指定接口的防护规则（与 ResourceSearchKey 不可同时存在）。	/flow
PageIndex	integer	否	起始页。默认值为 1。	1
PageSize	integer	否	分页，每页 N 个。	10
AcceptLanguage	string	否	返回结果显示的语言。取值：zh（默认值）：中文，en：英文	zh

返回参数

名称	类型	描述	示例值
	object
Code	integer	响应码。	200
Message	string	返回信息。	OK
RequestId	string	请求 Id。	4AE73569-304C-5AA9-AE11-C1D99C7D1689
Success	boolean	请求结果，取值如下： `true`：请求成功。 `false`：请求失败。	true
Data	object	返回数据。
Result	array	返回集合。
	object	规则信息
Namespace	string	命名空间。	default
StatIntervalMs	integer	统计窗口时长（单位毫秒）：统计的时间窗口长度。	1000
RuleId	string	规则 Id	1
AppName	string	应用名。	spring-cloud-a
Resource	string	接口资源名	/flow
ResourceType	integer	资源类型 0(自定义接口) 1(WEB) 2(RPC)	1
ControlBehavior	integer	流控方式 0(快速失败) 2(排队等待)	0
Burst	integer	针对突发请求额外允许的请求数目（效果等同于令牌桶算法的最大令牌数）	0
MaxQueueingTimeMs	integer	流控效果为排队等待时对应的超时时间，单位毫秒。	200
ResourceMode	integer	资源模式 0(资源名模式)	0
Threshold	number	阈值	20
Enable	boolean	开启或关闭。 `true`：开启。 `false`：关闭。	true
ParamItem	string	参数描述项，JSON 格式的字符串，包含以下键值对 parseStrategy：参数属性（0: Client IP、1: RemoteHost、 2: Header、 3: URL 参数） fieldName：Header 名称/URL 参数名称，仅在参数属性为 2、3 时填写 matchStrategy：属性值匹配方式，仅在参数属性为 2、3 且需要属性值匹配时填写（0: 精确、 2: 正则、 3: 子串） pattern：匹配串，仅在参数属性为 2、3 且需要属性值匹配时填写	{"fieldName":"testKey","matchStrategy":2,"parseStrategy":2,"pattern":"testValue"}
AppId	string	应用 Id。	hkhon1XXXX@c3df23522bXXXXX
MetricType	integer	阈值类型 1(请求数)	1
RegionId	string	地域 Id。	cn-hangzhou
FallbackObject	string	规则绑定的行为。	{\"appName\":\"spring-cloud-a\",\"fallbackBehavior\":{\"webFallbackMode\":0,\"webRespContentType\":0,\"webRespMessage\":\"Blocked\",\"webRespStatusCode\":429},\"id\":977,\"name\":\"Fallback\",\"namespace\":\"default\",\"resourceClassification\":1}
PageNumber	integer	页码	1
PageSize	integer	页面大小。	10
TotalSize	integer	查询到的总数。	36
HttpStatusCode	integer	HTTP 状态码。	200

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "OK",
  "RequestId": "4AE73569-304C-5AA9-AE11-C1D99C7D1689",
  "Success": true,
  "Data": {
    "Result": [
      {
        "Namespace": "default",
        "StatIntervalMs": 1000,
        "RuleId": "1",
        "AppName": "spring-cloud-a",
        "Resource": "/flow",
        "ResourceType": 1,
        "ControlBehavior": 0,
        "Burst": 0,
        "MaxQueueingTimeMs": 200,
        "ResourceMode": 0,
        "Threshold": 20,
        "Enable": true,
        "ParamItem": "{\"fieldName\":\"testKey\",\"matchStrategy\":2,\"parseStrategy\":2,\"pattern\":\"testValue\"}",
        "AppId": "hkhon1XXXX@c3df23522bXXXXX",
        "MetricType": 1,
        "RegionId": "cn-hangzhou",
        "FallbackObject": "{\\\"appName\\\":\\\"spring-cloud-a\\\",\\\"fallbackBehavior\\\":{\\\"webFallbackMode\\\":0,\\\"webRespContentType\\\":0,\\\"webRespMessage\\\":\\\"Blocked\\\",\\\"webRespStatusCode\\\":429},\\\"id\\\":977,\\\"name\\\":\\\"Fallback\\\",\\\"namespace\\\":\\\"default\\\",\\\"resourceClassification\\\":1}"
      }
    ],
    "PageNumber": 1,
    "PageSize": 10,
    "TotalSize": 36
  },
  "HttpStatusCode": 200
}

错误码

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

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

变更历史

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