ListGatewayCircuitBreakerRule - Microservices Engine - Alibaba Cloud Documentation Center

Queries the circuit breaker rules of the gateway.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

mse:ListGatewayCircuitBreakerRule

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
FilterParams	string	Yes	just for POP	param
AcceptLanguage	string	No	The language in which the returned results are displayed. Valid values: zh (default): Chinese, en: English	zh

Response elements

Parameter	Type	Description	Example
	object	RestResult<PageResult>
RequestId	string	The request ID.	DC34E4A3-5F1C-4E40-86EA-02EDF967****
Data	object	The returned data.
PageNumber	integer	The page number of the instance list	1
TotalSize	integer	The total number of instances queried	11
PageSize	integer	The number of rows per page set during input	100
Result	array	The returned result.
	object	The returned collection.
Id	integer	The circuit breaker rule ID.	467
GatewayId	integer	The gateway ID.	11919
GatewayUniqueId	string	The unique ID of the gateway.	gw-5017305290e14centbrveca****
RouteId	integer	The route ID.	3091
RouteName	string	The route name.	routeName
Strategy	integer	The threshold pattern. 0: Slow call pattern. 1: Exception pattern.	0
TriggerRatio	integer	The percentage to trigger circuit breaking.	10
StatDurationSec	integer	The circuit breaking statistics duration.	11
RecoveryTimeoutSec	integer	The circuit breaking recovery duration.	12
MinRequestAmount	integer	The minimum number of requests to trigger circuit breaking.	10
MaxAllowedMs	integer	The slow call threshold in slow call pattern.	14
LimitMode	integer	The threshold conversion mode. 0: Single machine. 1: Cluster. 2: Cluster to single machine.	0
BehaviorType	integer	The Web fallback behavior type. 0: Return specified content. 1: Redirect to a specified page.	0
BodyEncoding	integer	The encoding type. 0: Plain text 1: JSON	0
ResponseStatusCode	integer	The HTTP status code.	204
ResponseContentBody	string	The HTTP response text.	text
ResponseRedirectUrl	string	The redirect URL.	www.******.com
ResponseAdditionalHeaders	string	The custom header, input as key-value pairs.	key=value
Enable	integer	Whether to enable. 0: Not enabled. 1: Enabled.	0
IdList	array	The filter rule id
	integer	The rule ID.	467
Results	array	The returned result collection.
	object	The returned collection.
Id	integer	The circuit breaker rule ID.	467
GatewayId	integer	The gateway ID.	11919
GatewayUniqueId	string	The unique ID of the gateway.	gw-1ee34548c68f4778a25c05abd657****
RouteId	integer	The route ID.	3450
RouteName	string	The route name.	routeName
Strategy	integer	The threshold pattern. 0: Slow call pattern. 1: Exception pattern.	0
TriggerRatio	integer	The percentage to trigger circuit breaking.	10
StatDurationSec	integer	The circuit breaking statistics duration.	11
RecoveryTimeoutSec	integer	The circuit breaking recovery duration.	12
MinRequestAmount	integer	The minimum number of requests to trigger circuit breaking.	10
MaxAllowedMs	integer	The slow call threshold in slow call pattern.	10
LimitMode	integer	The threshold conversion mode. 0: Single machine. 1: Cluster. 2: Cluster to single machine.	0
BehaviorType	integer	The Web fallback behavior type. 0: Return specified content 1: Redirect to a specified page	0
BodyEncoding	integer	The encoding type. 0: Plain text 1: JSON	0
ResponseStatusCode	integer	The HTTP status code.	204
ResponseContentBody	string	The HTTP response text.	text
ResponseRedirectUrl	string	The redirect URL.	www.******.com
ResponseAdditionalHeaders	string	The custom header, input as key-value pairs.	key=value
Enable	integer	Whether to enable. 0: Not enabled. 1: Enabled.	0
IdList	array	The filter rule id
	integer	The rule ID.	467

Examples

Success response

JSON format

{
  "RequestId": "DC34E4A3-5F1C-4E40-86EA-02EDF967****",
  "Data": {
    "PageNumber": 1,
    "TotalSize": 11,
    "PageSize": 100,
    "Result": [
      {
        "Id": 467,
        "GatewayId": 11919,
        "GatewayUniqueId": "gw-5017305290e14centbrveca****",
        "RouteId": 3091,
        "RouteName": "routeName",
        "Strategy": 0,
        "TriggerRatio": 10,
        "StatDurationSec": 11,
        "RecoveryTimeoutSec": 12,
        "MinRequestAmount": 10,
        "MaxAllowedMs": 14,
        "LimitMode": 0,
        "BehaviorType": 0,
        "BodyEncoding": 0,
        "ResponseStatusCode": 204,
        "ResponseContentBody": "text",
        "ResponseRedirectUrl": "www.******.com",
        "ResponseAdditionalHeaders": "key=value",
        "Enable": 0,
        "IdList": [
          467
        ]
      }
    ],
    "Results": [
      {
        "Id": 467,
        "GatewayId": 11919,
        "GatewayUniqueId": "gw-1ee34548c68f4778a25c05abd657****",
        "RouteId": 3450,
        "RouteName": "routeName",
        "Strategy": 0,
        "TriggerRatio": 10,
        "StatDurationSec": 11,
        "RecoveryTimeoutSec": 12,
        "MinRequestAmount": 10,
        "MaxAllowedMs": 10,
        "LimitMode": 0,
        "BehaviorType": 0,
        "BodyEncoding": 0,
        "ResponseStatusCode": 204,
        "ResponseContentBody": "text",
        "ResponseRedirectUrl": "www.******.com",
        "ResponseAdditionalHeaders": "key=value",
        "Enable": 0,
        "IdList": [
          467
        ]
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalRequest	Invalid request:%s	Invalid request: %s
400	InvalidParameter	Parameter error:%s	Request parameter error: %s
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s
403	NoPermission	You are not authorized to perform this operation:%s	You do not have the permission to use this interface:%s
404	NotFound	Not found:%s	The resource does not exist:%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.