All Products
Search
Document Center

Microservices Engine:CreateFlowRule

Last Updated:Aug 12, 2024

Creates a throttling rule.

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:CreateFlowRulecreate
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
NamespacestringYes

The namespace.

default
AppNamestringYes

The application name.

spring-cloud-a
ThresholdintegerYes

The throttling threshold.

20
EnablebooleanYes

Specifies whether to enable the rule.

Valid values:

  • true

  • false

false
ResourcestringYes

The name of the API resource.

/b
AppIdstringNo

The application ID.

ib09eblv6p@c3df23522******
ControlBehaviorintegerYes

The throttling effect.

Valid values:

  • 0: fast failure
  • 2: in queue
0
MaxQueueingTimeMsintegerNo

The timeout period. Unit: milliseconds. This value is required if the ControlBehavior parameter is set to 2.

10
RegionIdstringNo

The region in which the instance resides.

cn-hangzhou
AcceptLanguagestringNo

The language of the response. Valid values:

  • zh: Chinese
  • en: English
zh

Response parameters

ParameterTypeDescriptionExample
object
Messagestring

The error message returned.

RequestIdstring

The request ID.

69AD2AA7-DB47-449B-941B-B14409DF****
Codestring

The response code.

200
Dataobject

The data returned.

Namespacestring

The namespace.

default
Idlong

The ID.

12
AppNamestring

The application name.

spring-cloud-a
Resourcestring

The name of the API resource.

app
ControlBehaviorinteger

The throttling effect.

Valid values:

  • 0

    :

    fast failure

  • 2

    :

    in queue

0
MaxQueueingTimeMsinteger

The timeout period for queuing when the value of ControlBehavior is set to 2. Unit: milliseconds.

500
Thresholdfloat

The throttling threshold.

200
Enableboolean

Indicates whether the rule is enabled.

Valid values:

  • true

  • false

true
AppIdstring

The application ID.

hkhon1po62@54e1f42f3******
RegionIdstring

The region ID.

cn-hangzhou
Successboolean

Indicates whether the request was successful.

Valid values:

  • true

  • false

true

Examples

Sample success responses

JSONformat

{
  "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"
  },
  "Success": true
}

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.

Change history

Change timeSummary of changesOperation
2024-05-22The internal configuration of the API is changed, but the call is not affectedView Change Details
2023-12-19The request parameters of the API has changedView Change Details