ListFlowRules - Query throttling rules | MSE API - Microservices Engine

Queries the list of flow control 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 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:ListFlowRules

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Namespace	string	Yes	The namespace.	default
AppName	string	Yes	The application name.	xx-demo
ResourceSearchKey	string	No	The search keyword.	/a
AppId	string	No	The application ID.	hkhon1po62@c3df23522******
Resource	string	No	The resource name.	/a
PageIndex	integer	No	The target page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page.	10
AcceptLanguage	string	No	The language of the returned information. Valid values: zh: Chinese en: English	zh

Response elements

Element	Type	Description	Example
	object
Code	integer	The status code.	200
Message	string	The response message.	The request is processed successfully.
RequestId	string	The request ID.	316F5F64-F73D-42DC-8632-01E308B6****
Success	boolean	Indicates whether the request is successful. Valid values: true : The request is successful. false : The request fails.	true
Data	object	The node data.
Result	array<object>	The returned collection.
	array<object>	The data structure.
Namespace	string	The namespace.	default
RuleId	integer	The rule ID.	2
AppName	string	The application name.	finance
Resource	string	The API resource name.	/a
ResourceType	integer	The API resource category.	1
ControlBehavior	integer	The flow control behavior. Valid values: 0 : Fast failure. 2 : Queuing.	0
MaxQueueingTimeMs	integer	The timeout period in milliseconds when the flow control behavior is set to queuing.	500
Threshold	number	The threshold of the flow control rule.	10
Enable	boolean	Indicates whether the rule is enabled. Valid values: true : Enabled. false : Disabled.	true
AppId	string	The application ID.	hkhon1po62@5f1b08becb*****
RegionId	string	The region ID.	cn-hangzhou
FallbackObject	string	The fallback behavior.	"{\"appName\":\"spring-cloud-a\",\"fallbackBehavior\":{\"webFallbackMode\":0,\"webRespContentType\":0,\"webRespMessage\":\"Blocked\",\"webRespStatusCode\":429},\"id\":977,\"name\":\"Fallback\",\"namespace\":\"default\",\"resourceClassification\":1}"
MetricType	integer	The statistical dimension. A value of 1 indicates the number of passed requests.	1
TrafficTags	object	The reserved field.	{\"origin\":\"default\"}
LimitApp	string	The source application of the request.	spring-cloud-a
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
TotalSize	integer	The total number of entries.	11
HttpStatusCode	integer	The HTTP status code.	200

Examples

Success response

JSON format

{
  "Code": 200,
  "Message": "The request is processed successfully.",
  "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
}

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.