調用ListFlowRules介面查詢流控規則-微服務引擎-阿里雲

擷取流控規則列表。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

mse:ListFlowRules

list

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
Namespace	string	是	命名空間。	default
AppName	string	是	應用程式名稱。	xx-demo
ResourceSearchKey	string	否	搜尋索引鍵。	/a
AppId	string	否	應用 ID。	hkhon1po62@c3df23522******
Resource	string	否	資源名。	/a
PageIndex	integer	否	目標頁號，預設為 1	1
PageSize	integer	否	分頁，每頁 N 個。	10
AcceptLanguage	string	否	返回資訊的語言類型： zh：中文 en：英文	zh

返回參數

名稱	類型	描述	樣本值
	object
Code	integer	狀態代碼。	200
Message	string	響應資訊。	請求處理成功
RequestId	string	請求 ID。	316F5F64-F73D-42DC-8632-01E308B6****
Success	boolean	請求結果。枚舉值： true : 請求成功 false : 請求失敗	true
Data	object	節點資料。
Result	array<object>	返回集合。
	array<object>	資料結構。
Namespace	string	命名空間。	default
RuleId	integer	規則 ID	2
AppName	string	應用程式名稱。	finance
Resource	string	介面資源名	/a
ResourceType	integer	介面資源分類	1
ControlBehavior	integer	流控效果。枚舉值： 0 : 快速失敗 2 : 排隊等待	0
MaxQueueingTimeMs	integer	流控效果為排隊等待時對應的逾時時間，單位毫秒。	500
Threshold	number	流控規則閾值。	10
Enable	boolean	規則啟用狀態。枚舉值： true : 啟用 false : 關閉	true
AppId	string	應用 ID。	hkhon1po62@5f1b08becb*****
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}"
MetricType	integer	統計維度，1 表示通過請求數。	1
TrafficTags	object	預留欄位。	{\"origin\":\"default\"}
LimitApp	string	請求來源應用。	spring-cloud-a
PageNumber	integer	頁碼。	1
PageSize	integer	分頁大小。	10
TotalSize	integer	總條數。	11
HttpStatusCode	integer	HTTP 狀態代碼。	200

樣本

正常返回樣本

JSON格式

{
  "Code": 200,
  "Message": "請求處理成功",
  "RequestId": "316F5F64-F73D-42DC-8632-01E308B6****",
  "Success": true,
  "Data": {
    "Result": [
      {
        "Namespace": "default",
        "RuleId": 2,
        "AppName": "finance",
        "Resource": "/a",
        "ResourceType": 1,
        "ControlBehavior": 0,
        "MaxQueueingTimeMs": 500,
        "Threshold": 10,
        "Enable": true,
        "AppId": "hkhon1po62@5f1b08becb*****",
        "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}\"",
        "MetricType": 1,
        "TrafficTags": {
          "test": "test",
          "test2": 1
        },
        "LimitApp": "spring-cloud-a"
      }
    ],
    "PageNumber": 1,
    "PageSize": 10,
    "TotalSize": 11
  },
  "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

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

變更歷史

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