All Products
Search
Document Center

Microservices Engine:CreateGatewayFlowRule

Last Updated:Aug 12, 2024

Creates a throttling rule for a gateway.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
mse:CreateGatewayFlowRulecreate
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
GatewayIdlongNo

The ID of the gateway.

14407
GatewayUniqueIdstringYes

The unique ID of the gateway.

gw-e2d226bba4b2445c9e29fa7f8216****
RouteIdlongYes

The ID of the route.

52853
RouteNamestringYes

The name of the routing rule.

routeName
ThresholdintegerYes

The overall queries per second (QPS) threshold.

10
BehaviorTypeintegerYes

The type of the web fallback behavior.

0: returns the specified content.

1: redirects to the specified page.

0
BodyEncodingintegerNo

The encoding format.

0: normal text

1: JSON

0
ResponseStatusCodeintegerNo

The HTTP status code.

429
ResponseContentBodystringNo

The HTTP text to be returned.

text
ResponseRedirectUrlstringNo

The address to be redirected to.

www.******.com
EnableintegerYes

Specifies whether to enable the throttling rule.

0: disables the throttling rule.

1: enables the throttling rule.

0
AcceptLanguagestringNo

The language in which you want to display the results. Valid values: zh and en. zh indicates Chinese, which is the default value. en indicates English.

zh

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

72FC625E-9629-591B-9C01-3F0BFDAB****
Datalong

The ID of the rule.

608

Examples

Sample success responses

JSONformat

{
  "RequestId": "72FC625E-9629-591B-9C01-3F0BFDAB****",
  "Data": 608
}

Error codes

HTTP status codeError codeError messageDescription
400IllegalRequestInvalid request:%sInvalid request: %s
400InvalidParameterParameter error:%sRequest parameter error: %s
403NoPermissionYou are not authorized to perform this operation:%sYou do not have the permission to use this interface:%s
404NotFoundNot found:%sThe resource does not exist:%s
500InternalErrorConsole error. Try again later:%sConsole error. Try again later: %s

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