ListCircuitBreakerRules - 擷取熔斷規則列表 - Microservices Engine

擷取熔斷規則列表。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

mse:ListCircuitBreakerRules

list

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
Namespace	string	是	應用所屬的微服務命名空間。	default
AppName	string	是	應用程式名稱。	spring-cloud-a
ResourceSearchKey	string	否	尋找包含介面關鍵字的防護規則。	a
AppId	string	否	應用 ID。	hkhon1po62@c3df23522bXXXXX
Resource	string	否	尋找指定介面的防護規則。	/a
PageIndex	integer	否	起始頁。預設值為 1。	1
PageSize	integer	否	頁大小。預設值為 6。	10
AcceptLanguage	string	否	返回結果顯示的語言。取值：zh-CN（預設值）：中文，en-US：英文	zh

返回參數

名稱	類型	描述	樣本值
	object
Code	integer	響應碼。	200
Message	string	響應資訊。	OK
RequestId	string	請求 ID。	4E9FDCFE-0738-493B-B801-82BDFBCB****
Success	boolean	請求結果。	true
Data	object	規則資訊。
Result	array	返回結果。
	object
Namespace	string	應用所屬的微服務命空間。	default
RuleId	integer	規則 ID。	1
AppName	string	應用程式名稱。	spring-cloud-a
Resource	string	介面名稱：適用該規則的應用資源。需要與控制台介面詳情處介面名稱一致。	/a
ResourceType	integer	介面資源分類。	1
Strategy	integer	閾實值型別：選擇以慢調用比例或異常比例作為閾值。	0
Threshold	number	熔斷比例閾值：觸發熔斷的比例閾值，取值範圍為 0 - 1，代表 0% - 100%。	0.8
Enable	boolean	規則的啟用狀態。	true
RetryTimeoutMs	integer	熔斷時間長度（單位毫秒）：即熔斷觸發後持續的時間。資源進入熔斷狀態後，在配置的熔斷時間長度內，請求都會快速失敗。	10000
StatIntervalMs	integer	統計視窗時間長度（單位毫秒）：統計的時間視窗長度，取值範圍為 1 秒~120 分鐘。	20000
AppId	string	應用 ID。	hkhon1po62@c3df23522bXXXXX
RegionId	string	叢集所在地區。	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}"
MaxAllowedRtMs	integer	慢調用 RT（單位毫秒）：閾實值型別為慢調用比例時，超過該時間長度則判定為慢請求。	200
MinRequestAmount	integer	觸發熔斷的最小請求數目，若當前統計視窗請求數小於此值，即使達到熔斷條件規則也不會觸發。	10
HalfOpenBaseAmountPerStep	integer	熔斷恢複每步最小通過數目。	5
HalfOpenRecoveryStepNum	integer	熔斷恢複階段數。	1
PageNumber	integer	起始頁。	1
PageSize	integer	頁大小。	10
TotalSize	integer	總頁數。	3
HttpStatusCode	integer	狀態代碼。	200

樣本

正常返回樣本

JSON格式

{
  "Code": 200,
  "Message": "OK",
  "RequestId": "4E9FDCFE-0738-493B-B801-82BDFBCB****",
  "Success": true,
  "Data": {
    "Result": [
      {
        "Namespace": "default",
        "RuleId": 1,
        "AppName": "spring-cloud-a",
        "Resource": "/a",
        "ResourceType": 1,
        "Strategy": 0,
        "Threshold": 0.8,
        "Enable": true,
        "RetryTimeoutMs": 10000,
        "StatIntervalMs": 20000,
        "AppId": "hkhon1po62@c3df23522bXXXXX",
        "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}\"",
        "MaxAllowedRtMs": 200,
        "MinRequestAmount": 10,
        "HalfOpenBaseAmountPerStep": 5,
        "HalfOpenRecoveryStepNum": 1
      }
    ],
    "PageNumber": 1,
    "PageSize": 10,
    "TotalSize": 3
  },
  "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

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

變更歷史

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