更新时间:2025-09-08 GMT+08:00

开关策略

功能介绍

修改策略状态

调用方法

请参见如何调用API

URI

PUT /v2/{domain_id}/tenant/open-source/rule-sets/{rule_set_id}/switch

表1 路径参数

参数

是否必选

参数类型

描述

rule_set_id

String

参数解释

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

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

domain_id

String

参数解释

租户ID。

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

is_valid

Boolean

参数解释

规则模板实例状态。

约束限制

不涉及。

取值范围

  • true:开。

  • false:关。

默认取值

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

status

Boolean

参数解释

更新状态是否成功。

取值范围

  • true:状态更新成功。

  • false:状态更新失败。

rule_set_id

String

参数解释

更新的策略ID。

取值范围

不涉及。

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释

错误信息。

取值范围

不涉及。

error_code

String

参数解释

错误码。

取值范围

不涉及。

请求示例

响应示例

状态码

状态码

描述

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码