ListGatewayFlowRule - Microservices Engine - Alibaba Cloud Documentation Center

Queries the gateway throttle rules.

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 support 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:ListGatewayFlowRule

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 parameters

Parameter	Type	Description	Example
	object	RestResult<PageResult>
RequestId	string	The request ID.	0951EBF0-798E-5E0B-8D38-460A14AD****
Data	object	The Meta return information.
PageNumber	integer	The page number of the instance list.	1
TotalSize	integer	The total number of instances queried.	1
PageSize	integer	The number of rows per page set during input.	100
Result	array	The returned data.
	object	The returned collection.
Id	integer	The routing throttle rule ID.	549
GatewayId	integer	The gateway ID.	14407
GatewayUniqueId	string	The unique gateway identity ID.	gw-e2d226bba4b2445c9e29fa7f8216****
RouteId	integer	The routing ID.	48811
RouteName	string	The routing name.	routeA
Threshold	integer	The overall QPS threshold.	10
BehaviorType	integer	The Web fallback behavior type. 0: Return specified content 1: Redirect to specified page	0
BodyEncoding	integer	The encoding type. 0: Plain text 1: JSON	0
ResponseStatusCode	integer	The HTTP status code.	429
ResponseContentBody	string	The HTTP response text.	text
ResponseRedirectUrl	string	The redirect URL.	www.******.com
Enable	integer	Indicates whether the rule is enabled. 0: Disabled. 1: Enabled.	0
Results	array	The paged data collection.
	object	The returned collection.
Id	integer	The routing throttle rule ID.	549
GatewayId	integer	The gateway ID.	14407
GatewayUniqueId	string	The unique gateway identity ID.	gw-e2d226bba4b2445c9e29fa7f8216****
RouteId	integer	The routing ID.	48811
RouteName	string	The routing name.	routeA
Threshold	integer	The overall QPS threshold.	10
StatDurationMs	integer	The statistics duration.	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 specified page	0
BodyEncoding	integer	The encoding type. 0: Plain text 1: JSON	0
ResponseStatusCode	integer	The HTTP status code.	429
ResponseContentBody	string	The HTTP response text.	text
ResponseRedirectUrl	string	The redirect URL.	www.******.com
ResponseAdditionalHeaders	string	The custom headers, entered as key-value pairs.	key=value
Enable	integer	Indicates whether the rule is enabled. 0: Disabled. 1: Enabled.	0
IdList	array	The filtered rule IDs.
	integer	The rule ID.	549

Examples

Success response

JSON format

{
  "RequestId": "0951EBF0-798E-5E0B-8D38-460A14AD****",
  "Data": {
    "PageNumber": 1,
    "TotalSize": 1,
    "PageSize": 100,
    "Result": [
      {
        "Id": 549,
        "GatewayId": 14407,
        "GatewayUniqueId": "gw-e2d226bba4b2445c9e29fa7f8216****",
        "RouteId": 48811,
        "RouteName": "routeA",
        "Threshold": 10,
        "BehaviorType": 0,
        "BodyEncoding": 0,
        "ResponseStatusCode": 429,
        "ResponseContentBody": "text",
        "ResponseRedirectUrl": "www.******.com",
        "Enable": 0
      }
    ],
    "Results": [
      {
        "Id": 549,
        "GatewayId": 14407,
        "GatewayUniqueId": "gw-e2d226bba4b2445c9e29fa7f8216****",
        "RouteId": 48811,
        "RouteName": "routeA",
        "Threshold": 10,
        "StatDurationMs": 10,
        "LimitMode": 0,
        "BehaviorType": 0,
        "BodyEncoding": 0,
        "ResponseStatusCode": 429,
        "ResponseContentBody": "text",
        "ResponseRedirectUrl": "www.******.com",
        "ResponseAdditionalHeaders": "key=value",
        "Enable": 0,
        "IdList": [
          549
        ]
      }
    ]
  }
}

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.