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

创建热点参数防护规则（HTTP 请求）。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

mse:CreateWebFlowRule

update

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
Namespace	string	否	命名空间	default
AppName	string	是	应用名	spring-cloud-a
Threshold	number	是	阈值	20
Enable	boolean	否	规则状态 true(开启) false(关闭)	true
Resource	string	是	接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。	/flow
Burst	integer	否	针对突发请求额外允许的请求数目（效果等同于令牌桶算法的最大令牌数）	0
AppId	string	否	应用 Id	hkhon1**@c3df23522****
ControlBehavior	integer	否	流控方式 0(快速失败) 2(排队等待)	0
MaxQueueingTimeMs	integer	否	超时时间，流控效果为排队等待时需要设置，单位毫秒。	200
ResourceMode	integer	是	资源模式 0(资源名模式)	0
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"}
MetricType	integer	否	阈值类型 1(请求数)	1
StatIntervalMs	integer	否	统计窗口时长（单位毫秒）：统计的时间窗口长度，默认值为 1 秒。	1000
RegionId	string	否	地域 ID。	cn-hangzhou
ResourceType	integer	否	资源类型 0(自定义接口) 1(WEB) 2(RPC)	1
AcceptLanguage	string	否	返回结果显示的语言。取值：zh（默认值）：中文，en：英文	zh

返回参数

名称	类型	描述	示例值
	object
Message	string	响应信息。	OK
RequestId	string	请求 Id。	A73AC37C-C617-4E3A-8049-372CF49C****
Code	string	响应码。	200
Data	object	返回数据。
Namespace	string	命名空间。	default
StatIntervalMs	integer	统计窗口时长（单位毫秒）：统计的时间窗口长度。	1000
Id	integer	规则 ID。	1
AppName	string	应用名称。	spring-cloud-a
Resource	string	接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。	/flow
ControlBehavior	integer	流控方式 0(快速失败) 2(排队等待)	0
ReourceMode	integer	资源模式 0(资源名模式)	0
MaxQueueingTimeMs	integer	流控效果为排队等待时对应的超时时间，单位毫秒。	200
Threshold	number	阈值。	20
Enable	boolean	规则状态 true(开启) false(关闭)	true
AppId	string	应用 Id。	hkhon1**@c3df23522****
MetricType	integer	阈值类型 1(请求数)	1
RegionId	string	地域 Id。	cn-hangzhou
Burst	integer	针对突发请求额外允许的请求数目（效果等同于令牌桶算法的最大令牌数）	0
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"}
Success	boolean	请求结果，取值如下： `true`：请求成功。 `false`：请求失败。	true

示例

正常返回示例

JSON格式

{
  "Message": "OK",
  "RequestId": "A73AC37C-C617-4E3A-8049-372CF49C****",
  "Code": "200",
  "Data": {
    "Namespace": "default",
    "StatIntervalMs": 1000,
    "Id": 1,
    "AppName": "spring-cloud-a",
    "Resource": "/flow",
    "ControlBehavior": 0,
    "ReourceMode": 0,
    "MaxQueueingTimeMs": 200,
    "Threshold": 20,
    "Enable": true,
    "AppId": "hkhon1****@c3df23522******",
    "MetricType": 1,
    "RegionId": "cn-hangzhou",
    "Burst": 0,
    "ParamItem": "{\"fieldName\":\"testKey\",\"matchStrategy\":2,\"parseStrategy\":2,\"pattern\":\"testValue\"}"
  },
  "Success": true
}

错误码

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

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

变更历史

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