更新时间:2026-01-09 GMT+08:00

修改策略

功能介绍

修改策略

调用方法

请参见如何调用API

URI

PUT /v2/{domain_id}/tenant/rule-sets/{rule_set_id}/update

表1 路径参数

参数

是否必选

参数类型

描述

rule_set_id

String

参数解释

策略ID,策略的唯一标识,通过获取策略列表接口获取,data.id即为策略ID。

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

domain_id

String

参数解释

租户ID,用户的domainId。

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

name

String

参数解释

策略名称。

约束限制

策略名称仅支持中文、大小写英文字母、数字、‘-’、‘_’。

取值范围

不超过128个字符。

默认取值

不涉及。

rules

Array of UpdateRuleInstance objects

参数解释

策略中的规则列表。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表4 UpdateRuleInstance

参数

是否必选

参数类型

描述

id

String

参数解释

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

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

is_valid

Boolean

参数解释

规则启用状态。

约束限制

不涉及。

取值范围

  • true:启用。

  • false:不启用。

默认取值

不涉及。

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

status

Boolean

参数解释

是否调用成功。

取值范围

  • true:调用成功。

  • false:调用失败。

rule_set_id

String

参数解释

策略ID,策略的唯一标识,通过获取策略列表接口获取,data.id即为策略ID。

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释

错误信息。

取值范围

不涉及。

error_code

String

参数解释

错误码。

取值范围

不涉及。

请求示例

PUT https://{endpoint}/v2/ce8df55870164338a72d7e828a966a2a/tenant/rule-sets/6cb18ee5ca1c48caa335706e0e5ee288/update

{
  "name" : "创建一个租户级策略",
  "rules" : [ {
    "id" : "097f315044244c9193f1e3f1fba7979d",
    "is_valid" : true
  }, {
    "id" : "80cfcff078074b8aa7951d7b67b3137b",
    "is_valid" : true
  } ]
}

响应示例

状态码:200

OK

{
  "status" : true,
  "rule_set_id" : "6cb18ee5ca1c48caa335706e0e5ee288"
}

状态码

状态码

描述

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码