CreateFlowRule - Microservices Engine - Alibaba Cloud Documentation Center

Creates a throttling rule.

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:CreateFlowRule

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Namespace	string	Yes	The namespace.	default
AppName	string	Yes	The application name.	spring-cloud-a
Threshold	integer	Yes	The throttling threshold.	20
Enable	boolean	Yes	Specifies whether to enable the rule.	false
Resource	string	Yes	The interface resource name.	/b
AppId	string	No	The application ID.	ib09eblv6p@c3df23522******
ControlBehavior	integer	No	The throttling effect.	0
MaxQueueingTimeMs	integer	No	The timeout period. Unit: milliseconds. This parameter is required if the ControlBehavior parameter is set to 2.	10
RegionId	string	No	The region in which the cluster resides.	cn-hangzhou
ResourceType	integer	No	The interface resource type.
LimitApp	string	No	The source application of the request.
AcceptLanguage	string	No	The language of the response. Valid values: zh: Chinese en: English	zh

Response elements

Parameter	Type	Description	Example
	object
Message	string	The returned message.
RequestId	string	The request ID.	69AD2AA7-DB47-449B-941B-B14409DF****
Code	string	The response code.	200
Data	object	The data returned.
Namespace	string	The namespace.	default
Id	integer	The ID.	12
AppName	string	The name of the application.	spring-cloud-a
Resource	string	The interface resource name.	app
ControlBehavior	integer	The throttling effect.	0
MaxQueueingTimeMs	integer	The timeout period for queuing when the ControlBehavior parameter is set to 2. Unit: milliseconds.	500
Threshold	number	The throttling threshold.	200
Enable	boolean	Indicates whether the rule is enabled.	true
AppId	string	The application ID.	hkhon1po62@54e1f42f3******
RegionId	string	The region of the gateway.	cn-hangzhou
LimitApp	string	The source application of the request.
Success	boolean	The result of the request.	true

Examples

Success response

JSON format

{
  "Message": "",
  "RequestId": "69AD2AA7-DB47-449B-941B-B14409DF****",
  "Code": "200",
  "Data": {
    "Namespace": "default",
    "Id": 12,
    "AppName": "spring-cloud-a",
    "Resource": "app",
    "ControlBehavior": 0,
    "MaxQueueingTimeMs": 500,
    "Threshold": 200,
    "Enable": true,
    "AppId": "hkhon1po62@54e1f42f3******",
    "RegionId": "cn-hangzhou",
    "LimitApp": ""
  },
  "Success": true
}

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.