Files
pyGoEdge-UserPanel/reference/goedge 文档/HTTPFirewallRuleGroupService.md
2025-11-18 03:36:49 +08:00

5.5 KiB
Raw Blame History

HTTPFirewallRuleGroupService

WAF分组服务


addHTTPFirewallRuleGroupSet

添加规则集

  • 角色:admin, user
  • HTTPPOST https://backend.dooki.cloud/HTTPFirewallRuleGroupService/addHTTPFirewallRuleGroupSet
  • RPCrpc addHTTPFirewallRuleGroupSet(AddHTTPFirewallRuleGroupSetRequest) returns (RPCSuccess);

请求对象 (AddHTTPFirewallRuleGroupSetRequest)

{
  "firewallRuleGroupId": "int64",
  "firewallRuleSetConfigJSON": "bytes"
}

响应对象 (RPCSuccess)

{}

调用示例

curl -X POST "https://backend.dooki.cloud/HTTPFirewallRuleGroupService/addHTTPFirewallRuleGroupSet" \
  -H "Content-Type: application/json" \
  -H "X-Edge-Access-Token: <YOUR_TOKEN>" \
  -d '{
    ...
  }'

createHTTPFirewallRuleGroup

创建分组

  • 角色:admin, user
  • HTTPPOST https://backend.dooki.cloud/HTTPFirewallRuleGroupService/createHTTPFirewallRuleGroup
  • RPCrpc createHTTPFirewallRuleGroup (CreateHTTPFirewallRuleGroupRequest) returns (CreateHTTPFirewallRuleGroupResponse);

请求对象 (CreateHTTPFirewallRuleGroupRequest)

{
  "isOn": "bool // 是否启用",
  "name": "string // 名称",
  "code": "string",
  "description": "string // 描述(备注)"
}

响应对象 (CreateHTTPFirewallRuleGroupResponse)

{
  "firewallRuleGroupId": "int64"
}

调用示例

curl -X POST "https://backend.dooki.cloud/HTTPFirewallRuleGroupService/createHTTPFirewallRuleGroup" \
  -H "Content-Type: application/json" \
  -H "X-Edge-Access-Token: <YOUR_TOKEN>" \
  -d '{
    ...
  }'

findEnabledHTTPFirewallRuleGroup

获取分组信息

  • 角色:admin, user
  • HTTPPOST https://backend.dooki.cloud/HTTPFirewallRuleGroupService/findEnabledHTTPFirewallRuleGroup
  • RPCrpc findEnabledHTTPFirewallRuleGroup (FindEnabledHTTPFirewallRuleGroupRequest) returns (FindEnabledHTTPFirewallRuleGroupResponse);

请求对象 (FindEnabledHTTPFirewallRuleGroupRequest)

{
  "firewallRuleGroupId": "int64"
}

响应对象 (FindEnabledHTTPFirewallRuleGroupResponse)

{
  "firewallRuleGroup": "HTTPFirewallRuleGroup"
}

调用示例

curl -X POST "https://backend.dooki.cloud/HTTPFirewallRuleGroupService/findEnabledHTTPFirewallRuleGroup" \
  -H "Content-Type: application/json" \
  -H "X-Edge-Access-Token: <YOUR_TOKEN>" \
  -d '{
    ...
  }'

findEnabledHTTPFirewallRuleGroupConfig

获取分组配置

  • 角色:admin, user
  • HTTPPOST https://backend.dooki.cloud/HTTPFirewallRuleGroupService/findEnabledHTTPFirewallRuleGroupConfig
  • RPCrpc findEnabledHTTPFirewallRuleGroupConfig (FindEnabledHTTPFirewallRuleGroupConfigRequest) returns (FindEnabledHTTPFirewallRuleGroupConfigResponse);

请求对象 (FindEnabledHTTPFirewallRuleGroupConfigRequest)

{
  "firewallRuleGroupId": "int64"
}

响应对象 (FindEnabledHTTPFirewallRuleGroupConfigResponse)

{
  "firewallRuleGroupJSON": "bytes"
}

调用示例

curl -X POST "https://backend.dooki.cloud/HTTPFirewallRuleGroupService/findEnabledHTTPFirewallRuleGroupConfig" \
  -H "Content-Type: application/json" \
  -H "X-Edge-Access-Token: <YOUR_TOKEN>" \
  -d '{
    ...
  }'

updateHTTPFirewallRuleGroup

修改分组

  • 角色:admin, user
  • HTTPPOST https://backend.dooki.cloud/HTTPFirewallRuleGroupService/updateHTTPFirewallRuleGroup
  • RPCrpc updateHTTPFirewallRuleGroup (UpdateHTTPFirewallRuleGroupRequest) returns (RPCSuccess);

请求对象 (UpdateHTTPFirewallRuleGroupRequest)

{
  "firewallRuleGroupId": "int64",
  "isOn": "bool // 是否启用",
  "name": "string // 名称",
  "description": "string // 描述(备注)",
  "code": "string"
}

响应对象 (RPCSuccess)

{}

调用示例

curl -X POST "https://backend.dooki.cloud/HTTPFirewallRuleGroupService/updateHTTPFirewallRuleGroup" \
  -H "Content-Type: application/json" \
  -H "X-Edge-Access-Token: <YOUR_TOKEN>" \
  -d '{
    ...
  }'

updateHTTPFirewallRuleGroupIsOn

设置是否启用分组

  • 角色:admin, user
  • HTTPPOST https://backend.dooki.cloud/HTTPFirewallRuleGroupService/updateHTTPFirewallRuleGroupIsOn
  • RPCrpc updateHTTPFirewallRuleGroupIsOn (UpdateHTTPFirewallRuleGroupIsOnRequest) returns (RPCSuccess);

请求对象 (UpdateHTTPFirewallRuleGroupIsOnRequest)

{
  "firewallRuleGroupId": "int64",
  "isOn": "bool // 是否启用"
}

响应对象 (RPCSuccess)

{}

调用示例

curl -X POST "https://backend.dooki.cloud/HTTPFirewallRuleGroupService/updateHTTPFirewallRuleGroupIsOn" \
  -H "Content-Type: application/json" \
  -H "X-Edge-Access-Token: <YOUR_TOKEN>" \
  -d '{
    ...
  }'

updateHTTPFirewallRuleGroupSets

修改分组的规则集

  • 角色:admin, user
  • HTTPPOST https://backend.dooki.cloud/HTTPFirewallRuleGroupService/updateHTTPFirewallRuleGroupSets
  • RPCrpc updateHTTPFirewallRuleGroupSets (UpdateHTTPFirewallRuleGroupSetsRequest) returns (RPCSuccess);

请求对象 (UpdateHTTPFirewallRuleGroupSetsRequest)

{
  "firewallRuleGroupId": "int64",
  "firewallRuleSetsJSON": "bytes"
}

响应对象 (RPCSuccess)

{}

调用示例

curl -X POST "https://backend.dooki.cloud/HTTPFirewallRuleGroupService/updateHTTPFirewallRuleGroupSets" \
  -H "Content-Type: application/json" \
  -H "X-Edge-Access-Token: <YOUR_TOKEN>" \
  -d '{
    ...
  }'