全部产品
Search
文档中心

微服务引擎MSE:ListCircuitBreakerRules - 获取熔断规则列表

更新时间:Nov 13, 2024

获取熔断规则列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
mse:ListCircuitBreakerRuleslist
  • 全部资源
    *

请求参数

名称类型必填描述示例值
Namespacestring

应用所属的微服务命名空间。

default
AppNamestring

应用名称。

spring-cloud-a
ResourceSearchKeystring

查找包含接口关键字的防护规则。

a
AppIdstring

应用 ID。

hkhon1po62@c3df23522bXXXXX
Resourcestring

查找指定接口的防护规则。

/a
PageIndexinteger

起始页。默认值为 1。

1
PageSizeinteger

页大小。默认值为 6。

10
AcceptLanguagestring

返回结果显示的语言。取值:zh-CN(默认值):中文,en-US:英文

zh

返回参数

名称类型描述示例值
object
Codeinteger

响应码。

200
Messagestring

响应信息。

OK
RequestIdstring

请求 ID。

4E9FDCFE-0738-493B-B801-82BDFBCB****
Successboolean

请求结果。

true
Dataobject

规则信息。

Resultarray<object>

返回结果。

Resultobject
Namespacestring

应用所属的微服务命空间。

default
RuleIdlong

规则 ID。

1
AppNamestring

应用名称。

spring-cloud-a
Resourcestring

接口名称:适用该规则的应用资源。需要与控制台接口详情处接口名称一致。

/a
Strategyinteger

阈值类型:选择以慢调用比例或异常比例作为阈值。

0
Thresholdfloat

熔断比例阈值:触发熔断的比例阈值,取值范围为 0 - 1,代表 0% - 100%。

0.8
Enableboolean

规则的启用状态。

true
RetryTimeoutMsinteger

熔断时长(单位毫秒):即熔断触发后持续的时间。资源进入熔断状态后,在配置的熔断时长内,请求都会快速失败。

10000
StatIntervalMsinteger

统计窗口时长(单位毫秒):统计的时间窗口长度,取值范围为 1 秒~120 分钟。

20000
AppIdstring

应用 ID。

hkhon1po62@c3df23522bXXXXX
RegionIdstring

集群所在地域。

cn-hangzhou
FallbackObjectstring

规则绑定的行为。

"{\"appName\":\"spring-cloud-a\",\"fallbackBehavior\":{\"webFallbackMode\":0,\"webRespContentType\":0,\"webRespMessage\":\"Blocked\",\"webRespStatusCode\":429},\"id\":977,\"name\":\"Fallback\",\"namespace\":\"default\",\"resourceClassification\":1}"
MaxAllowedRtMsinteger

慢调用 RT(单位毫秒):阈值类型为慢调用比例时,超过该时长则判定为慢请求。

200
MinRequestAmountinteger

触发熔断的最小请求数目,若当前统计窗口请求数小于此值,即使达到熔断条件规则也不会触发。

10
HalfOpenBaseAmountPerStepinteger

熔断恢复每步最小通过数目。

5
HalfOpenRecoveryStepNuminteger

熔断恢复阶段数。

1
PageNumberinteger

起始页。

1
PageSizeinteger

页大小。

10
TotalSizeinteger

总页数。

3
HttpStatusCodeinteger

状态码。

200

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "OK",
  "RequestId": "4E9FDCFE-0738-493B-B801-82BDFBCB****",
  "Success": true,
  "Data": {
    "Result": [
      {
        "Namespace": "default",
        "RuleId": 1,
        "AppName": "spring-cloud-a",
        "Resource": "/a",
        "ResourceType": 0,
        "Strategy": 0,
        "Threshold": 0.8,
        "Enable": true,
        "RetryTimeoutMs": 10000,
        "StatIntervalMs": 20000,
        "AppId": "hkhon1po62@c3df23522bXXXXX",
        "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}\"",
        "MaxAllowedRtMs": 200,
        "MinRequestAmount": 10,
        "HalfOpenBaseAmountPerStep": 5,
        "HalfOpenRecoveryStepNum": 1
      }
    ],
    "PageNumber": 1,
    "PageSize": 10,
    "TotalSize": 3
  },
  "HttpStatusCode": 200
}

错误码

HTTP status code错误码错误信息描述
400IllegalRequestInvalid request:%s非法请求: %s
400InvalidParameterParameter error:%s请求参数错误:%s
403NoPermissionYou are not authorized to perform this operation:%s没有权限使用此接口:%s
404NotFoundNot found:%s资源不存在:%s
500InternalErrorConsole error. Try again later:%s控制台错误.稍后重试:%s

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-12-19OpenAPI 返回结构发生变更查看变更详情