CreateWebFlowRule - 建立熱點參數防護（HTTP）規則 - Microservices Engine

建立熱點參數防護規則（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

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。