更新时间:2024-04-15 GMT+08:00

修改单条规则的状态

功能介绍

修改单条规则的状态,用于开启或者关闭单条规则,比如关闭精准防护中某一条规则

URI

PUT /v1/{project_id}/waf/policy/{policy_id}/{ruletype}/{rule_id}/status

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,对应控制台用户名->我的凭证->项目列表->项目ID

policy_id

String

策略id(策略id从查询防护策略列表接口获取)

ruletype

String

策略类型

枚举值:

  • whiteblackip

  • geoip

  • privacy

  • antitamper

  • custom

  • ignore

rule_id

String

规则id,根据不同的规则类型(ruletype)调用规则列表接口获取规则id,例如黑白名单(whiteblackip)规则id,您可以通过调用查询黑白名单规则列表(ListWhiteblackipRule)获取规则id

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目id

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

Content-Type

String

内容类型

缺省值:application/json;charset=utf8

表4 请求Body参数

参数

是否必选

参数类型

描述

status

Integer

状态(开启:1,关闭:0)

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

id

String

规则id

policyid

String

策略id

timestamp

Long

规则创建时间

description

String

规则描述

status

Integer

状态(开启:1,关闭:0)

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

请求示例

PUT https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/{ruletype}/{rule_id}/status?enterprise_project_id=0

{
  "status" : 0
}

响应示例

状态码: 200

OK

{
  "id" : "709bfd0d62a9410394ffa9e25eb82c36",
  "policyid" : "62fd7f8c36234a4ebedabc2ce451ed45",
  "timestamp" : 1650362797070,
  "description" : "demo",
  "status" : 0
}

状态码

状态码

描述

200

OK

400

请求失败

401

token权限不足

500

服务器内部错误

错误码

请参见错误码