ListGatewayCircuitBreakerRule - 查询网关熔断规则 - 微服务引擎MSE

查询该网关熔断规则。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
mse:ListGatewayCircuitBreakerRule	list	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
FilterParams	string	是	just for POP	param
AcceptLanguage	string	否	返回结果显示的语言。取值：zh（默认值）：中文，en：英文	zh

返回参数

名称	类型	描述	示例值
	object	RestResult<PageResult>
RequestId	string	请求 ID。	DC34E4A3-5F1C-4E40-86EA-02EDF967****
Data	object	返回数据。
PageNumber	integer	实例列表的页码	1
TotalSize	integer	查询到的实例总数	11
PageSize	integer	输入时设置的每页行数	100
Result	array<object>	返回结果。
Result	object	返回集合。
Id	long	熔断规则 ID。	467
GatewayId	long	网关 ID。	11919
GatewayUniqueId	string	网关唯一标识 ID。	gw-5017305290e14centbrveca****
RouteId	long	路由 ID。	3091
RouteName	string	路由名称。	routeName
Strategy	integer	阈值模式。 0：慢调用模式。 1：异常模式。	0
TriggerRatio	integer	触发熔断百分比。	10
StatDurationSec	integer	熔断统计时长。	11
RecoveryTimeoutSec	integer	熔断恢复时长。	12
MinRequestAmount	integer	触发熔断的最小请求数。	10
MaxAllowedMs	integer	慢调用模式下慢调用阈值。	14
LimitMode	integer	阈值转化模式。 0：单机。 1：集群。 2：集群转单机。	0
BehaviorType	integer	Web fallback 行为类型。 0：返回指定内容。 1：跳转到指定页面。	0
BodyEncoding	integer	编码类型。 0：普通文本 1：JSON	0
ResponseStatusCode	integer	Http 状态码。	204
ResponseContentBody	string	HTTP 返回文本。	text
ResponseRedirectUrl	string	跳转地址。	www.******.com
ResponseAdditionalHeaders	string	自定义 header，输入为 key-value 键值对。	key=value
Enable	integer	是否开启。 0：不开启。 1：开启。	0
IdList	array	筛选规则 id
IdList	long	规则 ID。	467
Results	array<object>	返回结果集合。
Result	object	返回集合。
Id	long	熔断规则 ID。	467
GatewayId	long	网关 ID。	11919
GatewayUniqueId	string	网关唯一标识 ID。	gw-1ee34548c68f4778a25c05abd657****
RouteId	long	路由 ID。	3450
RouteName	string	路由名称。	routeName
Strategy	integer	阈值模式。 0：慢调用模式。 1：异常模式。	0
TriggerRatio	integer	触发熔断的百分比。	10
StatDurationSec	integer	熔断统计时长。	11
RecoveryTimeoutSec	integer	熔断恢复时长。	12
MinRequestAmount	integer	触发熔断的最小请求数。	10
MaxAllowedMs	integer	慢调用模式下慢调用阈值。	10
LimitMode	integer	阈值转化模式。 0：单机。 1：集群。 2：集群转单机。	0
BehaviorType	integer	Web fallback 行为类型。 0：返回指定内容 1：跳转到指定页面	0
BodyEncoding	integer	编码类型。 0：普通文本 1：JSON	0
ResponseStatusCode	integer	HTTP 状态码。	204
ResponseContentBody	string	HTTP 返回文本。	text
ResponseRedirectUrl	string	跳转地址。	www.******.com
ResponseAdditionalHeaders	string	自定义 header，输入为 key-value 键值对。	key=value
Enable	integer	是否开启。 0：不开启。 1：开启。	0
IdList	array	筛选规则 id
IdList	long	规则 ID。	467

示例

正常返回示例

JSON格式

{
  "RequestId": "DC34E4A3-5F1C-4E40-86EA-02EDF967****",
  "Data": {
    "PageNumber": 1,
    "TotalSize": 11,
    "PageSize": 100,
    "Result": [
      {
        "Id": 467,
        "GatewayId": 11919,
        "GatewayUniqueId": "gw-5017305290e14centbrveca****",
        "RouteId": 3091,
        "RouteName": "routeName",
        "Strategy": 0,
        "TriggerRatio": 10,
        "StatDurationSec": 11,
        "RecoveryTimeoutSec": 12,
        "MinRequestAmount": 10,
        "MaxAllowedMs": 14,
        "LimitMode": 0,
        "BehaviorType": 0,
        "BodyEncoding": 0,
        "ResponseStatusCode": 204,
        "ResponseContentBody": "text",
        "ResponseRedirectUrl": "www.******.com",
        "ResponseAdditionalHeaders": "key=value",
        "Enable": 0,
        "IdList": [
          467
        ]
      }
    ],
    "Results": [
      {
        "Id": 467,
        "GatewayId": 11919,
        "GatewayUniqueId": "gw-1ee34548c68f4778a25c05abd657****",
        "RouteId": 3450,
        "RouteName": "routeName",
        "Strategy": 0,
        "TriggerRatio": 10,
        "StatDurationSec": 11,
        "RecoveryTimeoutSec": 12,
        "MinRequestAmount": 10,
        "MaxAllowedMs": 10,
        "LimitMode": 0,
        "BehaviorType": 0,
        "BodyEncoding": 0,
        "ResponseStatusCode": 204,
        "ResponseContentBody": "text",
        "ResponseRedirectUrl": "www.******.com",
        "ResponseAdditionalHeaders": "key=value",
        "Enable": 0,
        "IdList": [
          467
        ]
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	IllegalRequest	Invalid request:%s	非法请求： %s
400	InvalidParameter	Parameter error:%s	请求参数错误：%s
403	NoPermission	You are not authorized to perform this operation:%s	没有权限使用此接口：%s
404	NotFound	Not found:%s	资源不存在：%s
500	InternalError	Console error. Try again later:%s	控制台错误.稍后重试：%s

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