获取熔断规则列表。
调试
您可以在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 |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 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 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-12-19 | OpenAPI 返回结构发生变更 | 查看变更详情 |