文档首页/ 流水线 CodeArts Pipeline/ API参考（联盟区域）/ API/ 规则管理/ 更新规则
更新时间：2026-01-09 GMT+08:00
在线调试
CLI示例
查看PDF
分享

更新规则

功能介绍

更新规则

调用方法

请参见如何调用API。

URI

PUT /v2/{domain_id}/rules/{rule_id}/update

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

是

String

参数解释：

租户ID，用户的domainId。

约束限制：

不涉及。

取值范围：

32位字符，由数字和字母组成。

默认取值：

不涉及。

rule_id

是

String

参数解释：

规则ID，规则的唯一标识，通过分页获取规则列表接口获取，data.id即为规则ID。

约束限制：

不涉及。

取值范围：

32位字符，由数字和字母组成。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。通过调用获取（响应消息头中X-Subject-Token的值）。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表3 请求Body参数

参数

是否必选

参数类型

描述

type

是

String

参数解释：

规则类型。

约束限制：

不涉及。

取值范围：

  • Build：构建。

  • Gate：代码检查。

  • Test：测试。

默认取值：

不涉及。

name

是

String

参数解释：

规则名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

plugin_id

否

String

参数解释：

扩展插件唯一ID。可以通过查询插件版本详情接口，获取响应参数中unique_id。

约束限制：

不涉及。

取值范围：

32位字符，由数字和字母组成。

默认取值：

不涉及。

plugin_name

否

String

参数解释：

扩展插件名称。

约束限制：

仅支持输入大小写英文字母、数字、'-'、'_'。

取值范围：

1到50位字符。

默认取值：

不涉及。

plugin_version

否

String

参数解释：

扩展插件版本号。

约束限制：

仅支持输入大小写英文字母、数字、'-'、'_'。

取值范围：

1到50位字符。

默认取值：

不涉及。

content

是

Array of RuleContent objects

参数解释：

规则详细属性。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表4 RuleContent

参数

是否必选

参数类型

描述

group_name

是

String

参数解释：

分组名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

can_modify_when_inherit

否

Boolean

参数解释：

继承后的子策略是否可以修改阈值。

约束限制：

不涉及。

取值范围：

  • true：可以修改阈值。

  • false：不可以修改阈值。

默认取值：

不涉及。

editable

否

Boolean

参数解释：

是否可以编辑。

约束限制：

不涉及。

取值范围：

  • true：可以编辑。

  • false：不可以编辑。

默认取值：

不涉及。

properties

是

Array of RuleProperty objects

参数解释：

规则属性列表。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表5 RuleProperty

参数

是否必选

参数类型

描述

key

是

String

参数解释：

属性键。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

type

是

String

参数解释：

规则类型。

约束限制：

不涉及。

取值范围：

  • Build：构建。

  • Gate：代码检查。

  • Test：测试。

默认取值：

不涉及。

name

是

String

参数解释：

展示名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

operator

否

String

参数解释：

比较运算符。

约束限制：

不涉及。

取值范围：

  • '='：等于。

  • '>'：大于。

  • '<'：小于。

  • '>='：大于等于。

  • '<='：小于等于。

  • '!='：不等于。

  • 'in'：包含其中。

  • 'not in'：不被包含。

默认取值：

不涉及。

value

是

String

参数解释：

属性值。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

value_type

是

String

参数解释：

数据类型。

约束限制：

不涉及。

取值范围：

  • float：数值型。

  • string：字符型。

默认取值：

不涉及。

is_valid

否

Boolean

参数解释：

属性是否启用。

约束限制：

不涉及。

取值范围：

  • true：启用。

  • false：未启用。

默认取值：

false。

响应参数

状态码：200

表6 响应Body参数

参数

参数类型

描述

status

Boolean

参数解释：

是否调用成功。

取值范围：

  • true：调用成功。

  • false：调用失败。

rule_id

String

参数解释：

规则ID，规则的唯一标识，通过分页获取规则列表接口获取，data.id即为规则ID。

约束限制：

不涉及。

取值范围：

32位字符，由数字和字母组成。

默认取值：

不涉及。

状态码：400

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

error_msg

String

参数解释：

错误描述。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

状态码：401

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

error_msg

String

参数解释：

错误描述。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

状态码：403

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

error_msg

String

参数解释：

错误描述。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

状态码：404

表10 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

error_msg

String

参数解释：

错误描述。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求示例

PUT https://{endpoint}/v2/ce8df55870164338a72d7e828a966a2a/rules/425eba0deaf04596a74cf7967d7fc04d/update

{
  "name" : "新建规则-20230919104204",
  "type" : "Test",
  "plugin_id" : "official_devcloud_apiTest",
  "plugin_name" : "official_devcloud_apiTest",
  "plugin_version" : "0.0.12",
  "content" : [ {
    "group_name" : "API测试通过率门禁",
    "properties" : [ {
      "key" : "pass_ratio",
      "name" : "api测试通过率",
      "type" : "judge",
      "operator" : "=",
      "value_type" : "float",
      "value" : "0.5"
    } ]
  } ]
}

响应示例

状态码：200

请求成功

{
  "status" : true,
  "rule_id" : "425eba0deaf04596a74cf7967d7fc04d"
}

状态码

状态码

描述

200

请求成功

400

请求失败

401

认证失败

403

无权限

404

资源不存在

错误码

请参见错误码。

父主题： 规则管理