调用ListCircuitBreakerRules获取熔断规则列表_微服务引擎(MSE)-阿里云帮助中心

获取熔断规则列表。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

mse:ListCircuitBreakerRules

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
Namespace	string	是	应用所属的微服务命名空间。	default
AppName	string	是	应用名称。	spring-cloud-a
ResourceSearchKey	string	否	查找包含接口关键字的防护规则。	a
AppId	string	否	应用 ID。	hkhon1po62@c3df23522bXXXXX
Resource	string	否	查找指定接口的防护规则。	/a
PageIndex	integer	否	起始页。默认值为 1。	1
PageSize	integer	否	页大小。默认值为 6。	10
AcceptLanguage	string	否	返回结果显示的语言。取值：zh-CN（默认值）：中文，en-US：英文	zh

返回参数

名称	类型	描述	示例值
	object
Code	integer	响应码。	200
Message	string	响应信息。	OK
RequestId	string	请求 ID。	4E9FDCFE-0738-493B-B801-82BDFBCB****
Success	boolean	请求结果。	true
Data	object	规则信息。
Result	array	返回结果。
	object
Namespace	string	应用所属的微服务命空间。	default
RuleId	integer	规则 ID。	1
AppName	string	应用名称。	spring-cloud-a
Resource	string	接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。	/a
ResourceType	integer	接口资源分类。	1
Strategy	integer	阈值类型：选择以慢调用比例或异常比例作为阈值。	0
Threshold	number	熔断比例阈值：触发熔断的比例阈值，取值范围为 0 - 1，代表 0% - 100%。	0.8
Enable	boolean	规则的启用状态。	true
RetryTimeoutMs	integer	熔断时长（单位毫秒）：即熔断触发后持续的时间。资源进入熔断状态后，在配置的熔断时长内，请求都会快速失败。	10000
StatIntervalMs	integer	统计窗口时长（单位毫秒）：统计的时间窗口长度，取值范围为 1 秒~120 分钟。	20000
AppId	string	应用 ID。	hkhon1po62@c3df23522bXXXXX
RegionId	string	集群所在地域。	cn-hangzhou
FallbackObject	string	规则绑定的行为。	"{\"appName\":\"spring-cloud-a\",\"fallbackBehavior\":{\"webFallbackMode\":0,\"webRespContentType\":0,\"webRespMessage\":\"Blocked\",\"webRespStatusCode\":429},\"id\":977,\"name\":\"Fallback\",\"namespace\":\"default\",\"resourceClassification\":1}"
MaxAllowedRtMs	integer	慢调用 RT（单位毫秒）：阈值类型为慢调用比例时，超过该时长则判定为慢请求。	200
MinRequestAmount	integer	触发熔断的最小请求数目，若当前统计窗口请求数小于此值，即使达到熔断条件规则也不会触发。	10
HalfOpenBaseAmountPerStep	integer	熔断恢复每步最小通过数目。	5
HalfOpenRecoveryStepNum	integer	熔断恢复阶段数。	1
PageNumber	integer	起始页。	1
PageSize	integer	页大小。	10
TotalSize	integer	总页数。	3
HttpStatusCode	integer	状态码。	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": 1,
        "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	错误码	错误信息	描述
400	IllegalRequest	Invalid request:%s	非法请求： %s
400	InvalidParameter	Parameter error:%s	请求参数错误：%s
500	InternalError	Console error. Try again later:%s	控制台错误.稍后重试：%s
403	NoPermission	You are not authorized to perform this operation:%s	没有权限使用此接口：%s
404	NotFound	Not found:%s	资源不存在：%s

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

变更历史

更多信息，参考变更详情。