All Products
Search

This Product

    Microservices Engine:CreateGatewayCircuitBreakerRule

    Document Center

    Microservices Engine:CreateGatewayCircuitBreakerRule

    Last Updated:Dec 05, 2025

    Creates a gateway circuit breaking 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:CreateGatewayCircuitBreakerRule

    create

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    GatewayId

    integer

    No

    The gateway ID.

    14407
    GatewayUniqueId

    string

    Yes

    The unique ID of the gateway.

    gw-c9bc5afd61014165bd58f621b491*****
    RouteId

    integer

    Yes

    The route ID.

    645
    RouteName

    string

    Yes

    The route name.

    routeName
    Strategy

    integer

    Yes

    The type of the threshold.

    0: slow call proportion

    1: failure proportion

    0
    TriggerRatio

    integer

    Yes

    The request percentage that triggers circuit breaking.

    10
    StatDurationSec

    integer

    Yes

    The statistical duration for triggering circuit breaking.

    11
    RecoveryTimeoutSec

    integer

    Yes

    The circuit breaking timeout period.

    12
    MinRequestAmount

    integer

    Yes

    The minimum number of requests to trigger circuit breaking.

    10
    MaxAllowedMs

    integer

    No

    The threshold in slow call proportion mode.

    10
    BehaviorType

    integer

    Yes

    The type of the web fallback behavior.

    0: returns the specified content.

    1: redirects to the specified page.

    0
    BodyEncoding

    integer

    No

    The encoding type.

    0: plain text

    1: JSON

    0
    ResponseStatusCode

    integer

    No

    The HTTP status code.

    429
    ResponseContentBody

    string

    No

    The HTTP text to be returned.

    text
    ResponseRedirectUrl

    string

    No

    The redirection URL.

    www.******.com
    Enable

    integer

    Yes

    Specifies whether to enable the rule.

    0: disables the rule.

    1: enables the rule.

    0
    AcceptLanguage

    string

    No

    The language in which you want the results to be displayed. Valid values: zh (default): Chinese. en: English.

    zh

    Response elements

    Parameter

    Type

    Description

    Example

    object

    RestResult

    RequestId

    string

    The request ID.

    DC34E4A3-5F1C-4E40-86EA-02EDF967****
    Data

    integer

    The ID of the circuit breaking rule that you create.

    28

    Examples

    Success response

    JSON format

    {
  "RequestId": "DC34E4A3-5F1C-4E40-86EA-02EDF967****",
  "Data": 28
}

    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.