ListFlowRules - Microservices Engine - Alibaba Cloud Documentation Center

Obtains a list of throttling rules.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
mse:ListFlowRules	list	All Resources *	none	none

Request parameters

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

Response parameters

Parameter	Type	Description	Example
	object
Code	integer	The HTTP status code.	200
Message	string	The returned message.
RequestId	string	The request ID.	316F5F64-F73D-42DC-8632-01E308B6****
Success	boolean	Indicates whether the request was successful. Valid values: true : The request was successful. false : The request failed.	true
Data	object	The details of the data.
Result	array<object>	The data returned.
Result	object
Namespace	string	The namespace.	default
RuleId	long	The rule ID.	2
AppName	string	The application name.	finance
Resource	string	The name of the interface resource.	/a
ControlBehavior	integer	The throttling effect. Valid values: 0 : fast failure 2 : in queue	0
MaxQueueingTimeMs	integer	The timeout period for queuing when the value of ControlBehavior is set to 2. Unit: milliseconds.	500
Threshold	float	The throttling threshold.	10
Enable	boolean	Indicates whether the throttling rule was enabled. Valid values: true false	true
AppId	string	The ID of the application.	hkhon1po62@5f1b08becb*****
RegionId	string	The ID of the region in which the instance resides.	cn-hangzhou
FallbackObject	string	The throttling 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. The value 1 indicates that the number of accepted requests is used for statistics.	1
TrafficTags	object	A reserved parameter.	{\"origin\":\"default\"}
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

Sample success responses

JSONformat

{
  "Code": 200,
  "Message": "",
  "RequestId": "316F5F64-F73D-42DC-8632-01E308B6****",
  "Success": true,
  "Data": {
    "Result": [
      {
        "Namespace": "default",
        "RuleId": 2,
        "AppName": "finance",
        "Resource": "/a",
        "ResourceType": 0,
        "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
        }
      }
    ],
    "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
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
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-12-19	The response structure of the API has changed	View Change Details