创建熔断规则。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| mse:CreateCircuitBreakerRule | create | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Namespace | string | 是 | 应用所属的微服务命名空间。 | default |
| AppName | string | 是 | 应用名称。 | spring-cloud-a |
| Threshold | float | 是 | 熔断比例阈值：触发熔断的比例阈值，取值范围为 0 - 1，代表 0% - 100%。 | 0.8 |
| Enable | boolean | 是 | 规则的启用状态。 枚举值：
| true |
| Resource | string | 是 | 接口名称：适用该规则的应用资源。需要与控制台接口详情处接口名称一致。 | /a |
| AppId | string | 否 | 应用 ID。 | hkhon1po62@c3df23522bXXXXX |
| RegionId | string | 否 | 集群所在地域。 | cn-hangzhou |
| Strategy | integer | 是 | 阈值类型：选择以慢调用比例或异常比例作为阈值。 | 0 |
| RetryTimeoutMs | integer | 否 | 熔断时长（单位毫秒）：即熔断触发后持续的时间。资源进入熔断状态后，在配置的熔断时长内，请求都会快速失败。取值需要为 1000 的整数倍，默认值为 10000，即 10 秒。 | 10000 |
| StatIntervalMs | integer | 否 | 统计窗口时长（单位毫秒）：统计的时间窗口长度，取值范围为 1 秒~120 分钟。默认值为 20000，即 20 秒。 | 20000 |
| MaxAllowedRtMs | integer | 否 | 慢调用 RT（单位毫秒）：超过该时长则判定为慢请求，阈值类型为慢调用比例时必填。 | 200 |
| MinRequestAmount | integer | 否 | 触发熔断的最小请求数目，若当前统计窗口请求数小于此值，即使达到熔断条件规则也不会触发。默认值为 10。 | 10 |
| HalfOpenBaseAmountPerStep | integer | 否 | 熔断恢复每步最小通过数目，默认值为 1。 | 5 |
| HalfOpenRecoveryStepNum | integer | 否 | 熔断恢复阶段数，默认值为 1。 | 1 |
| ResourceType | integer | 否 | 资源类型。 枚举值：
| 0 |
| AcceptLanguage | string | 否 | 返回信息的语言类型：
| zh |
返回参数
示例
正常返回示例
JSON格式
{
"Message": "OK",
"RequestId": "EE5C32A1-BC0E-4B79-817C-103E4EDF****",
"Code": "200",
"Data": {
"Namespace": "default",
"Id": 1,
"AppName": "spring-cloud-a",
"Resource": "/a",
"StatIntervalMs": 20000,
"Threshold": 0.8,
"Enable": true,
"Strategy": 0,
"RetryTimeoutMs": 10000,
"AppId": "hkhon1po62@c3df23522bXXXXX",
"RegionId": "cn-hangzhou",
"MaxAllowedRtMs": 200,
"MinRequestAmount": 10,
"HalfOpenBaseAmountPerStep": 5,
"HalfOpenRecoveryStepNum": 1
},
"Success": true
}错误码
| 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 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-05-22 | API 内部配置变更，不影响调用 | 查看变更详情 |
| 2023-12-19 | OpenAPI 入参发生变更 | 查看变更详情 |