文档首页/ 安全云脑 SecMaster/ 用户指南/ 安全编排/ 系统内置流程插件说明/ WAF

更新时间：2026-06-29 GMT+08:00

WAF

功能说明

安全云脑系统内置插件，可调用WAF（Web应用防火墙）云服务接口执行操作，主要用于管理防护域名、策略、IP地址组、黑白名单等WAF资源。

系统内置插件均已存在对应内置的操作连接。

查看WAF插件详情和操作连接

登录安全云脑 SecMaster控制台。
单击管理控制台左上角的，选择区域和项目。
在左侧导航栏选择“工作空间 > 空间管理”，并在工作空间列表中，单击目标工作空间名称，进入目标工作空间管理页面。

图1 进入目标工作空间管理页面
在左侧导航栏选择“安全编排 > 插件管理”，进入插件管理页面。

图2 插件管理页面
在插件管理页面，选择华为云目录下的WAF，默认进入插件“详情”页签。详情页签展示插件已关联操作连接的登录凭证信息。
单击WAF插件的“操作连接”页签，进入操作连接页面，可查看插件已关联的操作连接信息。
若用户需编辑或删除操作连接，可参见编辑操作连接、删除操作连接。新增插件操作连接可参见新增操作连接，一个插件可存在多个操作连接。

插件执行函数createIpGroup说明

函数createIpGroup参数说明：介绍函数的输入参数和输出参数。
函数createIpGroup输出示例：给出函数的输出示例。

函数createIpGroup参数说明

函数功能：创建IP地址组。

表1 函数createIpGroup入参说明
参数名称	参数类型	参数描述	是否必填
name	String	IP地址组名称	是
ips	String	IP地址列表，多个IP地址用逗号分隔	是
description	String	IP地址组描述信息	否
enterprise_project_id	String	企业项目ID，您可以通过调用企业项目管理服务（EPS）的查询企业项目列表接口（ListEnterpriseProject）查询企业项目ID	否
agency_type	String	多账号统一适配参数，使用默认值即可	否

表2 函数createIpGroup出参说明
参数名称	参数类型	参数描述
headers	Object	接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。
code	Int	状态码，表明请求是否成功。 “code”取值示例说明： “code”为“200”：表示请求成功。 “code”为“401”：表示账号或密码错误。 “code”为“403”：表示权限不足。 “code”为“404”：表示请求资源不存在。
body	Object	接口返回的具体内容。

函数createIpGroup输出示例

{
  "headers": {
    "Transfer-Encoding": "chunked",
    "Server": "api-gateway",
    "X-Request-Id": "f7e759ff25266227a1d31f5068a5b3ed",
    "X-Content-Type-Options": "nosniff",
    "Connection": "keep-alive",
    "X-Download-Options": "noopen",
    "Pragma": "no-cache",
    "Date": "Mon, 25 May 2026 09:10:00 GMT",
    "X-Frame-Options": "SAMEORIGIN",
    "Strict-Transport-Security": "max-age=31536000; includeSubdomains;",
    "Cache-Control": "no-cache, no-store, max-age=0, must-revalidate",
    "X-XSS-Protection": "1; mode=block;",
    "Content-Type": "application/json; charset=UTF-8"
  },
  "code": 200,
  "body": {
    "id": "ipg-12345678",
    "name": "test-ip-group",
    "ips": "192.xxx.1.1,xx2.168.1.2",
    "description": "测试IP地址组",
    "size": 2
  }
}

插件执行函数deleteIpGroup说明

函数deleteIpGroup参数说明：介绍函数的输入参数和输出参数。
函数deleteIpGroup输出示例：给出函数的输出示例。

函数deleteIpGroup参数说明

函数功能：删除IP地址组。

表3 函数deleteIpGroup入参说明
参数名称	参数类型	参数描述	是否必填
id	String	IP地址组ID，可通过查询IP地址组列表接口（ListIpGroup）获取	是
enterprise_project_id	String	企业项目ID	否
agency_type	String	多账号统一适配参数，使用默认值即可	否

表4 函数deleteIpGroup出参说明
参数名称	参数类型	参数描述
headers	Object	接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。
code	Int	状态码，表明请求是否成功。 “code”取值示例说明： “code”为“200”：表示请求成功。 “code”为“401”：表示账号或密码错误。 “code”为“403”：表示权限不足。 “code”为“404”：表示请求资源不存在。
body	Object	接口返回的具体内容。

函数deleteIpGroup输出示例

{
  "headers": {
    "Transfer-Encoding": "chunked",
    "Server": "api-gateway",
    "X-Request-Id": "f7e759ff25266227a1d31f5068a5b3ed",
    "X-Content-Type-Options": "nosniff",
    "Connection": "keep-alive",
    "X-Download-Options": "noopen",
    "Pragma": "no-cache",
    "Date": "Mon, 25 May 2026 09:10:00 GMT",
    "X-Frame-Options": "SAMEORIGIN",
    "Strict-Transport-Security": "max-age=31536000; includeSubdomains;",
    "Cache-Control": "no-cache, no-store, max-age=0, must-revalidate",
    "X-XSS-Protection": "1; mode=block;",
    "Content-Type": "application/json; charset=UTF-8"
  },
  "code": 200,
  "body": {}
}

插件执行函数updateIpGroup说明

函数updateIpGroup参数说明：介绍函数的输入参数和输出参数。
函数updateIpGroup输出示例：给出函数的输出示例。

函数updateIpGroup参数说明

函数功能：更新IP地址组，支持添加或移除IP。

表5 函数updateIpGroup入参说明
参数名称	参数类型	参数描述	是否必填
ipGroupId	String	IP地址组ID	是
name	String	IP地址组名称	否
ips	String	IP地址列表	否
description	String	IP地址组描述信息	否
enterpriseProjectId	String	企业项目ID	否
action	String	修改ip地址组时，此为必传字段取值范围： add 添加 delete 删除 update 修改	否
agency_type	String	多账号统一适配参数，使用默认值即可	否

表6 函数updateIpGroup出参说明
参数名称	参数类型	参数描述
headers	Object	接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。
code	Int	状态码，表明请求是否成功。 “code”取值示例说明： “code”为“200”：表示请求成功。 “code”为“401”：表示账号或密码错误。 “code”为“403”：表示权限不足。 “code”为“404”：表示请求资源不存在。
body	Object	接口返回的具体内容。

函数updateIpGroup输出示例

{
  "headers": {
    "Transfer-Encoding": "chunked",
    "Server": "api-gateway",
    "X-Request-Id": "f7e759ff25266227a1d31f5068a5b3ed",
    "X-Content-Type-Options": "nosniff",
    "Connection": "keep-alive",
    "X-Download-Options": "noopen",
    "Pragma": "no-cache",
    "Date": "Mon, 25 May 2026 09:10:00 GMT",
    "X-Frame-Options": "SAMEORIGIN",
    "Strict-Transport-Security": "max-age=31536000; includeSubdomains;",
    "Cache-Control": "no-cache, no-store, max-age=0, must-revalidate",
    "X-XSS-Protection": "1; mode=block;",
    "Content-Type": "application/json; charset=UTF-8"
  },
  "code": 200,
  "body": {
    "id": "ipg-12345678",
    "name": "updated-ip-group",
    "ips": "192.xxx.1.1,192.xxx.1.2,192.xxx.1.3",
    "description": "更新后的IP地址组",
    "size": 3
  }
}

插件执行函数listIpGroup说明

函数listIpGroup参数说明：介绍函数的输入参数和输出参数。
函数listIpGroup输出示例：给出函数的输出示例。

函数listIpGroup参数说明

函数功能：查询IP地址组列表。

表7 函数listIpGroup入参说明
参数名称	参数类型	参数描述	是否必填
name	String	IP地址组名称	否
page	Integer	分页查询参数，第几页，不传默认第1页	否
pagesize	Integer	分页查询参数，每页多少条数据，不传默认10条，最大100条	否
enterpriseProjectId	String	企业项目ID	否
ip	String	查询包含传入的ip地址或ip段的地址组	否

表8 函数listIpGroup出参说明
参数名称	参数类型	参数描述
headers	Object	接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。
code	Int	状态码，表明请求是否成功。 “code”取值示例说明： “code”为“200”：表示请求成功。 “code”为“401”：表示账号或密码错误。 “code”为“403”：表示权限不足。 “code”为“404”：表示请求资源不存在。
body	Object	接口返回的具体内容。

函数listIpGroup输出示例

{
  "headers": {
    "Transfer-Encoding": "chunked",
    "Server": "api-gateway",
    "X-Request-Id": "f7e759ff25266227a1d31f5068a5b3ed",
    "X-Content-Type-Options": "nosniff",
    "Connection": "keep-alive",
    "X-Download-Options": "noopen",
    "Pragma": "no-cache",
    "Date": "Mon, 25 May 2026 09:10:00 GMT",
    "X-Frame-Options": "SAMEORIGIN",
    "Strict-Transport-Security": "max-age=31536000; includeSubdomains;",
    "Cache-Control": "no-cache, no-store, max-age=0, must-revalidate",
    "X-XSS-Protection": "1; mode=block;",
    "Content-Type": "application/json; charset=UTF-8"
  },
  "code": 200,
  "body": {
    "total": 10,
    "items": [
      {
        "id": "ipg-12345678",
        "name": "test-ip-group",
        "ips": "192.xxx.1.1,192.xxx.1.2",
        "description": "测试IP地址组",
        "size": 2
      }
    ]
  }
}

插件执行函数createPolicy说明

函数createPolicy参数说明：介绍函数的输入参数和输出参数。
函数createPolicy输出示例：给出函数的输出示例。

函数createPolicy参数说明

函数功能：创建防护策略。

表9 函数createPolicy入参说明
参数名称	参数类型	参数描述	是否必填
name	String	策略名称，策略名称只能由数字、字母和下划线组成，长度不能超过64位字符	否
enterpriseProjectId	String	企业项目ID	否
agency_type	String	多账号统一适配参数，使用默认值即可	否

**表10** 函数createPolicy出参说明
参数名称	参数类型	参数描述
headers	Object	接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。
code	Int	状态码，表明请求是否成功。 “code”取值示例说明： “code”为“200”：表示请求成功。 “code”为“401”：表示账号或密码错误。 “code”为“403”：表示权限不足。 “code”为“404”：表示请求资源不存在。
body	Object	接口返回的具体内容。

函数createPolicy输出示例

{
  "headers": {
    "Transfer-Encoding": "chunked",
    "Server": "api-gateway",
    "X-Request-Id": "f7e759ff25266227a1d31f5068a5b3ed",
    "X-Content-Type-Options": "nosniff",
    "Connection": "keep-alive",
    "X-Download-Options": "noopen",
    "Pragma": "no-cache",
    "Date": "Mon, 25 May 2026 09:10:00 GMT",
    "X-Frame-Options": "SAMEORIGIN",
    "Strict-Transport-Security": "max-age=31536000; includeSubdomains;",
    "Cache-Control": "no-cache, no-store, max-age=0, must-revalidate",
    "X-XSS-Protection": "1; mode=block;",
    "Content-Type": "application/json; charset=UTF-8"
  },
  "code": 200,
  "body": {
    "id": "policy-12345678",
    "name": "test-policy",
    "level": 1
  }
}

插件执行函数deletePolicy说明

函数deletePolicy参数说明：介绍函数的输入参数和输出参数。
函数deletePolicy输出示例：给出函数的输出示例。

函数deletePolicy参数说明

函数功能：删除防护策略。

**表11** 函数deletePolicy入参说明
参数名称	参数类型	参数描述	是否必填
policy_id	String	防护策略ID，您可以通过调用查询防护策略列表（ListPolicy）获取策略ID	是
enterprise_project_id	String	企业项目ID	否
agency_type	String	多账号统一适配参数，使用默认值即可	否

**表12** 函数deletePolicy出参说明
参数名称	参数类型	参数描述
headers	Object	接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。
code	Int	状态码，表明请求是否成功。 “code”取值示例说明： “code”为“200”：表示请求成功。 “code”为“401”：表示账号或密码错误。 “code”为“403”：表示权限不足。 “code”为“404”：表示请求资源不存在。
body	Object	接口返回的具体内容。

函数deletePolicy输出示例

{
  "headers": {
    "Transfer-Encoding": "chunked",
    "Server": "api-gateway",
    "X-Request-Id": "f7e759ff25266227a1d31f5068a5b3ed",
    "X-Content-Type-Options": "nosniff",
    "Connection": "keep-alive",
    "X-Download-Options": "noopen",
    "Pragma": "no-cache",
    "Date": "Mon, 25 May 2026 09:10:00 GMT",
    "X-Frame-Options": "SAMEORIGIN",
    "Strict-Transport-Security": "max-age=31536000; includeSubdomains;",
    "Cache-Control": "no-cache, no-store, max-age=0, must-revalidate",
    "X-XSS-Protection": "1; mode=block;",
    "Content-Type": "application/json; charset=UTF-8"
  },
  "code": 200,
  "body": {}
}

插件执行函数showPolicy说明

函数showPolicy参数说明：介绍函数的输入参数和输出参数。
函数showPolicy输出示例：给出函数的输出示例。

函数showPolicy参数说明

函数功能：查询单个防护策略的详细信息。

**表13** 函数showPolicy入参说明
参数名称	参数类型	参数描述	是否必填
policyID	String	防护策略ID	是
enterpriseProjectId	String	企业项目ID	否

**表14** 函数showPolicy出参说明
参数名称	参数类型	参数描述
headers	Object	接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。
code	Int	状态码，表明请求是否成功。 “code”取值示例说明： “code”为“200”：表示请求成功。 “code”为“401”：表示账号或密码错误。 “code”为“403”：表示权限不足。 “code”为“404”：表示请求资源不存在。
body	Object	接口返回的具体内容。

函数showPolicy输出示例

{
  "headers": {
    "Transfer-Encoding": "chunked",
    "Server": "api-gateway",
    "X-Request-Id": "f7e759ff25266227a1d31f5068a5b3ed",
    "X-Content-Type-Options": "nosniff",
    "Connection": "keep-alive",
    "X-Download-Options": "noopen",
    "Pragma": "no-cache",
    "Date": "Mon, 25 May 2026 09:10:00 GMT",
    "X-Frame-Options": "SAMEORIGIN",
    "Strict-Transport-Security": "max-age=31536000; includeSubdomains;",
    "Cache-Control": "no-cache, no-store, max-age=0, must-revalidate",
    "X-XSS-Protection": "1; mode=block;",
    "Content-Type": "application/json; charset=UTF-8"
  },
  "code": 200,
  "body": {
    "id": "policy-12345678",
    "name": "test-policy",
    "level": 1,
    "full_compliance": true
  }
}

插件执行函数queryPolicyList说明

函数queryPolicyList参数说明：介绍函数的输入参数和输出参数。
函数queryPolicyList输出示例：给出函数的输出示例。

函数queryPolicyList参数说明

函数功能：查询单个防护策略的详细信息。

**表15** 函数queryPolicyList入参说明
参数名称	参数类型	参数描述	是否必填
enterpriseProjectId	String	企业项目ID	否
page	Integer	分页查询参数，第几页	否
pagesize	Integer	分页查询参数，每页多少条数据	否
name	String	策略名称	否
agency_type	String	多账号统一适配参数，使用默认值即可	否

**表16** 函数queryPolicyList出参说明
参数名称	参数类型	参数描述
headers	Object	接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。
code	Int	状态码，表明请求是否成功。 “code”取值示例说明： “code”为“200”：表示请求成功。 “code”为“401”：表示账号或密码错误。 “code”为“403”：表示权限不足。 “code”为“404”：表示请求资源不存在。
body	Object	接口返回的具体内容。

函数queryPolicyList输出示例

{
  "headers": {
    "Transfer-Encoding": "chunked",
    "Server": "api-gateway",
    "X-Request-Id": "f7e759ff25266227a1d31f5068a5b3ed",
    "X-Content-Type-Options": "nosniff",
    "Connection": "keep-alive",
    "X-Download-Options": "noopen",
    "Pragma": "no-cache",
    "Date": "Mon, 25 May 2026 09:10:00 GMT",
    "X-Frame-Options": "SAMEORIGIN",
    "Strict-Transport-Security": "max-age=31536000; includeSubdomains;",
    "Cache-Control": "no-cache, no-store, max-age=0, must-revalidate",
    "X-XSS-Protection": "1; mode=block;",
    "Content-Type": "application/json; charset=UTF-8"
  },
  "code": 200,
  "body": {
    "total": 10,
    "items": [
      {
        "id": "policy-12345678",
        "name": "test-policy",
        "level": 1
      }
    ]
  }
}

插件执行函数createPunishmentRule说明

函数createPunishmentRule参数说明：介绍函数的输入参数和输出参数。
函数createPunishmentRule输出示例：给出函数的输出示例。

函数createPunishmentRule参数说明

函数功能：创建惩罚规则，设置对特定类别IP的封禁。

**表17** 函数createPunishmentRule入参说明
参数名称	参数类型	参数描述	是否必填
policyId	string	策略ID	是
category	string	类别	是
blockTime	string	封禁时间（分钟）	是
description	string	描述信息	是
enterpriseProjectId	string	企业项目ID	否
agency_type	string	多账号统一适配参数，使用默认值即可	否

**表18** 函数createPunishmentRule出参说明
参数名称	参数类型	参数描述
headers	Object	接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。
code	Int	状态码，表明请求是否成功。 “code”取值示例说明： “code”为“200”：表示请求成功。 “code”为“401”：表示账号或密码错误。 “code”为“403”：表示权限不足。 “code”为“404”：表示请求资源不存在。
body	Object	接口返回的具体内容。

函数createPunishmentRule输出示例

{
  "headers": {
    "Transfer-Encoding": "chunked",
    "Server": "api-gateway",
    "X-Request-Id": "f7e759ff25266227a1d31f5068a5b3ed",
    "X-Content-Type-Options": "nosniff",
    "Connection": "keep-alive",
    "X-Download-Options": "noopen",
    "Pragma": "no-cache",
    "Date": "Mon, 25 May 2026 09:10:00 GMT",
    "X-Frame-Options": "SAMEORIGIN",
    "Strict-Transport-Security": "max-age=31536000; includeSubdomains;",
    "Cache-Control": "no-cache, no-store, max-age=0, must-revalidate",
    "X-XSS-Protection": "1; mode=block;",
    "Content-Type": "application/json; charset=UTF-8"
  },
  "code": 200,
  "body": {
    "id": "punishment-12345678",
    "name": "处罚规则",
    "punishment_time": 300,
    "punishment_action": "block"
  }
}

插件执行函数listPunishmentRule说明

函数listPunishmentRule参数说明：介绍函数的输入参数和输出参数。
函数listPunishmentRule输出示例：给出函数的输出示例。

函数listPunishmentRule参数说明

函数功能：查询惩罚规则列表。

**表19** 函数listPunishmentRule入参说明
参数名称	参数类型	参数描述	是否必填
policyId	string	策略ID	是
enterpriseProjectId	string	企业项目ID	否
offset	string	偏移量	否
limit	string	每页数量	否

**表20** 函数listPunishmentRule出参说明
参数名称	参数类型	参数描述
headers	Object	接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。
code	Int	状态码，表明请求是否成功。 “code”取值示例说明： “code”为“200”：表示请求成功。 “code”为“401”：表示账号或密码错误。 “code”为“403”：表示权限不足。 “code”为“404”：表示请求资源不存在。
body	Object	接口返回的具体内容。

函数listPunishmentRule输出示例

{
  "headers": {
    "Transfer-Encoding": "chunked",
    "Server": "api-gateway",
    "X-Request-Id": "f7e759ff25266227a1d31f5068a5b3ed",
    "X-Content-Type-Options": "nosniff",
    "Connection": "keep-alive",
    "X-Download-Options": "noopen",
    "Pragma": "no-cache",
    "Date": "Mon, 25 May 2026 09:10:00 GMT",
    "X-Frame-Options": "SAMEORIGIN",
    "Strict-Transport-Security": "max-age=31536000; includeSubdomains;",
    "Cache-Control": "no-cache, no-store, max-age=0, must-revalidate",
    "X-XSS-Protection": "1; mode=block;",
    "Content-Type": "application/json; charset=UTF-8"
  },
  "code": 200,
  "body": {
    "total": 10,
    "items": [
      {
        "id": "punishment-12345678",
        "name": "处罚规则",
        "punishment_time": 300,
        "punishment_action": "block"
      }
    ]
  }
}

插件执行函数createWhiteblackipRule说明

函数createWhiteblackipRule参数说明：介绍函数的输入参数和输出参数。
函数createWhiteblackipRule输出示例：给出函数的输出示例。

函数createWhiteblackipRule参数说明

函数功能：创建黑白名单规则。

**表21** 函数createWhiteblackipRule入参说明
参数名称	参数类型	参数描述	是否必填
policy_id	String	防护策略ID，您可以通过调用查询防护策略列表（ListPolicy）获取策略ID	是
name	String	规则名称，长度范围[1,256]	是
addr	String	IP地址，需要输入标准的IP地址或地址段，例如：42.123.120.66或42.123.120.0/16。参数"addr"和"ip_group_id"必须存在一个，同时存在时以参数"addr"为准	否
white	Integer	防护动作：0-拦截，1-放行，2-仅记录	是
description	String	黑白名单规则描述	是
ipGroupId	String	IP地址组ID，可在控制台中对象管理->地址组管理中添加。参数"addr"和"ip_group_id"必须存在一个，同时存在时以参数"addr"为准	否
enterpriseProjectId	String	企业项目ID	否
punishmentId	String	攻击惩罚规则id	否
agency_type	String	多账号统一适配参数，使用默认值即可	否

**表22** 函数createWhiteblackipRule出参说明
参数名称	参数类型	参数描述
headers	Object	接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。
code	Int	状态码，表明请求是否成功。 “code”取值示例说明： “code”为“200”：表示请求成功。 “code”为“401”：表示账号或密码错误。 “code”为“403”：表示权限不足。 “code”为“404”：表示请求资源不存在。
body	Object	接口返回的具体内容。

函数createWhiteblackipRule输出示例

{
  "headers": {
    "Transfer-Encoding": "chunked",
    "Server": "api-gateway",
    "X-Request-Id": "f7e759ff25266227a1d31f5068a5b3ed",
    "X-Content-Type-Options": "nosniff",
    "Connection": "keep-alive",
    "X-Download-Options": "noopen",
    "Pragma": "no-cache",
    "Date": "Mon, 25 May 2026 09:10:00 GMT",
    "X-Frame-Options": "SAMEORIGIN",
    "Strict-Transport-Security": "max-age=31536000; includeSubdomains;",
    "Cache-Control": "no-cache, no-store, max-age=0, must-revalidate",
    "X-XSS-Protection": "1; mode=block;",
    "Content-Type": "application/json; charset=UTF-8"
  },
  "code": 200,
  "body": {
    "id": "rule-12345678",
    "name": "test-rule",
    "policy_id": "policy-12345678",
    "addr": "192.168.1.1",
    "white": 1,
    "description": "测试黑白名单规则",
    "status": 1
  }
}

插件执行函数deleteWhiteblackipRule说明

函数deleteWhiteblackipRule参数说明：介绍函数的输入参数和输出参数。
函数deleteWhiteblackipRule输出示例：给出函数的输出示例。

函数deleteWhiteblackipRule参数说明

函数功能：删除黑白名单规则。

**表23** 函数deleteWhiteblackipRule入参说明
参数名称	参数类型	参数描述	是否必填
policy_id	String	防护策略ID	是
rule_id	String	黑白名单规则ID	是
enterprise_project_id	String	企业项目ID	否
agency_type	String	多账号统一适配参数，使用默认值即可	否

**表24** 函数deleteWhiteblackipRule出参说明
参数名称	参数类型	参数描述
headers	Object	接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。
code	Int	状态码，表明请求是否成功。 “code”取值示例说明： “code”为“200”：表示请求成功。 “code”为“401”：表示账号或密码错误。 “code”为“403”：表示权限不足。 “code”为“404”：表示请求资源不存在。
body	Object	接口返回的具体内容。

函数deleteWhiteblackipRule输出示例

{
  "headers": {
    "Transfer-Encoding": "chunked",
    "Server": "api-gateway",
    "X-Request-Id": "f7e759ff25266227a1d31f5068a5b3ed",
    "X-Content-Type-Options": "nosniff",
    "Connection": "keep-alive",
    "X-Download-Options": "noopen",
    "Pragma": "no-cache",
    "Date": "Mon, 25 May 2026 09:10:00 GMT",
    "X-Frame-Options": "SAMEORIGIN",
    "Strict-Transport-Security": "max-age=31536000; includeSubdomains;",
    "Cache-Control": "no-cache, no-store, max-age=0, must-revalidate",
    "X-XSS-Protection": "1; mode=block;",
    "Content-Type": "application/json; charset=UTF-8"
  },
  "code": 200,
  "body": {}
}

插件执行函数updateWhiteblackipRule说明

函数updateWhiteblackipRule参数说明：介绍函数的输入参数和输出参数。
函数updateWhiteblackipRule输出示例：给出函数的输出示例。

函数updateWhiteblackipRule参数说明

函数功能：更新黑白名单规则。

**表25** 函数updateWhiteblackipRule入参说明
参数名称	参数类型	参数描述	是否必填
policyId	String	防护策略ID	是
ruleId	String	黑白名单规则ID	是
name	String	规则名称	是
addr	String	IP地址或地址段	是
white	Integer	防护动作：0-拦截，1-放行，2-仅记录	是
description	String	黑白名单规则描述	是
enterpriseProjectId	String	企业项目ID	否
agency_type	String	多账号统一适配参数，使用默认值即可	否

**表26** 函数updateWhiteblackipRule出参说明
参数名称	参数类型	参数描述
headers	Object	接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。
code	Int	状态码，表明请求是否成功。 “code”取值示例说明： “code”为“200”：表示请求成功。 “code”为“401”：表示账号或密码错误。 “code”为“403”：表示权限不足。 “code”为“404”：表示请求资源不存在。
body	Object	接口返回的具体内容。

函数updateWhiteblackipRule输出示例

{
  "headers": {
    "Transfer-Encoding": "chunked",
    "Server": "api-gateway",
    "X-Request-Id": "f7e759ff25266227a1d31f5068a5b3ed",
    "X-Content-Type-Options": "nosniff",
    "Connection": "keep-alive",
    "X-Download-Options": "noopen",
    "Pragma": "no-cache",
    "Date": "Mon, 25 May 2026 09:10:00 GMT",
    "X-Frame-Options": "SAMEORIGIN",
    "Strict-Transport-Security": "max-age=31536000; includeSubdomains;",
    "Cache-Control": "no-cache, no-store, max-age=0, must-revalidate",
    "X-XSS-Protection": "1; mode=block;",
    "Content-Type": "application/json; charset=UTF-8"
  },
  "code": 200,
  "body": {
    "id": "rule-12345678",
    "name": "updated-rule",
    "policy_id": "policy-12345678",
    "addr": "192.168.1.2",
    "white": 0,
    "description": "更新后的黑白名单规则",
    "status": 1
  }
}

插件执行函数listWhiteblackipRule说明

函数listWhiteblackipRule参数说明：介绍函数的输入参数和输出参数。
函数listWhiteblackipRule输出示例：给出函数的输出示例。

函数listWhiteblackipRule参数说明

函数功能：查询黑白名单规则列表。

**表27** 函数listWhiteblackipRule入参说明
参数名称	参数类型	参数描述	是否必填
policy_id	String	防护策略ID	是
page	Integer	分页查询参数，第几页	否
pagesize	Integer	分页查询参数，每页多少条数据	否
name	String	黑白名单规则名称	否
addr	String	黑白名单规则中IP或IP段	否
enterprise_project_id	String	企业项目ID	否
resultVariable	String	用于过滤查询结果	否

**表28** 函数listWhiteblackipRule出参说明
参数名称	参数类型	参数描述
headers	Object	接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。
code	Int	状态码，表明请求是否成功。 “code”取值示例说明： “code”为“200”：表示请求成功。 “code”为“401”：表示账号或密码错误。 “code”为“403”：表示权限不足。 “code”为“404”：表示请求资源不存在。
body	Object	接口返回的具体内容。

函数listWhiteblackipRule输出示例

{
  "headers": {
    "Transfer-Encoding": "chunked",
    "Server": "api-gateway",
    "X-Request-Id": "f7e759ff25266227a1d31f5068a5b3ed",
    "X-Content-Type-Options": "nosniff",
    "Connection": "keep-alive",
    "X-Download-Options": "noopen",
    "Pragma": "no-cache",
    "Date": "Mon, 25 May 2026 09:10:00 GMT",
    "X-Frame-Options": "SAMEORIGIN",
    "Strict-Transport-Security": "max-age=31536000; includeSubdomains;",
    "Cache-Control": "no-cache, no-store, max-age=0, must-revalidate",
    "X-XSS-Protection": "1; mode=block;",
    "Content-Type": "application/json; charset=UTF-8"
  },
  "code": 200,
  "body": {
    "total": 10,
    "items": [
      {
        "id": "rule-12345678",
        "name": "test-rule",
        "addr": "192.168.1.1",
        "white": 1,
        "description": "测试黑白名单规则"
      }
    ]
  }
}

插件执行函数listHost说明

函数listHost参数说明：介绍函数的输入参数和输出参数。
函数listHost输出示例：给出函数的输出示例。

函数listHost参数说明

函数功能：查询防护域名列表。

**表29** 函数listHost入参说明
参数名称	参数类型	参数描述	是否必填
enterprise_project_id	String	企业项目ID	否
page	Integer	分页查询参数，第几页	否
pagesize	Integer	分页查询参数，每页多少条数据	否
hostname	String	防护域名名称	否
policyname	String	策略名称	否

**表30** 函数listHost出参说明
参数名称	参数类型	参数描述
headers	Object	接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。
code	Int	状态码，表明请求是否成功。 “code”取值示例说明： “code”为“200”：表示请求成功。 “code”为“401”：表示账号或密码错误。 “code”为“403”：表示权限不足。 “code”为“404”：表示请求资源不存在。
body	Object	接口返回的具体内容。

函数listHost输出示例

{
  "headers": {
    "Transfer-Encoding": "chunked",
    "Server": "api-gateway",
    "X-Request-Id": "f7e759ff25266227a1d31f5068a5b3ed",
    "X-Content-Type-Options": "nosniff",
    "Connection": "keep-alive",
    "X-Download-Options": "noopen",
    "Pragma": "no-cache",
    "Date": "Mon, 25 May 2026 09:10:00 GMT",
    "X-Frame-Options": "SAMEORIGIN",
    "Strict-Transport-Security": "max-age=31536000; includeSubdomains;",
    "Cache-Control": "no-cache, no-store, max-age=0, must-revalidate",
    "X-XSS-Protection": "1; mode=block;",
    "Content-Type": "application/json; charset=UTF-8"
  },
  "code": 200,
  "body": {
    "total": 10,
    "items": [
      {
        "id": "host-12345678",
        "hostname": "www.example.com",
        "policy_id": "policy-12345678",
        "policy_name": "test-policy",
        "protect_status": 1,
        "access_status": 1
      }
    ]
  }
}

插件执行函数listCompositeHosts说明

函数listCompositeHosts参数说明：介绍函数的输入参数和输出参数。
函数listCompositeHosts输出示例：给出函数的输出示例。

函数listCompositeHosts参数说明

函数功能：查询组合域名列表，返回格式化后的域名防护状态信息。

**表31** 函数listCompositeHosts入参说明
参数名称	参数类型	参数描述	是否必填
hostname	String	防护域名名称	否
page	Integer	分页查询参数，第几页	否
limit	Integer	分页查询参数，每页多少条数据	否
enterpriseProjectId	String	企业项目ID	否

**表32** 函数listCompositeHosts出参说明
参数名称	参数类型	参数描述
headers	Object	接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。
code	Int	状态码，表明请求是否成功。 “code”取值示例说明： “code”为“200”：表示请求成功。 “code”为“401”：表示账号或密码错误。 “code”为“403”：表示权限不足。 “code”为“404”：表示请求资源不存在。
body	Object	接口返回的具体内容。

函数listCompositeHosts输出示例

{
  "headers": {
    "Transfer-Encoding": "chunked",
    "Server": "api-gateway",
    "X-Request-Id": "f7e759ff25266227a1d31f5068a5b3ed",
    "X-Content-Type-Options": "nosniff",
    "Connection": "keep-alive",
    "X-Download-Options": "noopen",
    "Pragma": "no-cache",
    "Date": "Mon, 25 May 2026 09:10:00 GMT",
    "X-Frame-Options": "SAMEORIGIN",
    "Strict-Transport-Security": "max-age=31536000; includeSubdomains;",
    "Cache-Control": "no-cache, no-store, max-age=0, must-revalidate",
    "X-XSS-Protection": "1; mode=block;",
    "Content-Type": "application/json; charset=UTF-8"
  },
  "code": 200,
  "body": {
    "total": 10,
    "items": [
      {
        "id": "host-12345678",
        "hostname": "www.example.com",
        "protect_status": 1
      }
    ]
  }
}

插件执行函数showBundle说明

函数showBundle参数说明：介绍函数的输入参数和输出参数。
函数showBundle输出示例：给出函数的输出示例。

函数showBundle参数说明

函数功能：获取WAF资源配额信息。

**表33** 函数showBundle入参说明
参数名称	参数类型	参数描述	是否必填
enterpriseProjectId	string	企业项目ID	否
resultVariable	String	用于过滤查询结果	否

**表34** 函数showBundle出参说明
参数名称	参数类型	参数描述
headers	Object	接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。
code	Int	状态码，表明请求是否成功。 “code”取值示例说明： “code”为“200”：表示请求成功。 “code”为“401”：表示账号或密码错误。 “code”为“403”：表示权限不足。 “code”为“404”：表示请求资源不存在。
body	Object	接口返回的具体内容。

函数showBundle输出示例

{
  "headers": {
    "Transfer-Encoding": "chunked",
    "Server": "api-gateway",
    "X-Request-Id": "f7e759ff25266227a1d31f5068a5b3ed",
    "X-Content-Type-Options": "nosniff",
    "Connection": "keep-alive",
    "X-Download-Options": "noopen",
    "Pragma": "no-cache",
    "Date": "Mon, 25 May 2026 09:10:00 GMT",
    "X-Frame-Options": "SAMEORIGIN",
    "Strict-Transport-Security": "max-age=31536000; includeSubdomains;",
    "Cache-Control": "no-cache, no-store, max-age=0, must-revalidate",
    "X-XSS-Protection": "1; mode=block;",
    "Content-Type": "application/json; charset=UTF-8"
  },
  "code": 200,
  "body": {
    "bundleId": "bundle-12345678",
    "name": "WAF套餐",
    "quota": 100
  }
}

插件执行函数showSourceIp说明

函数showSourceIp参数说明：介绍函数的输入参数和输出参数。
函数showSourceIp输出示例：给出函数的输出示例。

函数showSourceIp参数说明

函数功能：获取WAF源IP配置信息。

**表35** 函数showSourceIp入参说明
参数名称	参数类型	参数描述	是否必填
input	String	输入参数	否

**表36** 函数showSourceIp出参说明
参数名称	参数类型	参数描述
headers	Object	接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。
code	Int	状态码，表明请求是否成功。 “code”取值示例说明： “code”为“200”：表示请求成功。 “code”为“401”：表示账号或密码错误。 “code”为“403”：表示权限不足。 “code”为“404”：表示请求资源不存在。
body	Object	接口返回的具体内容。

函数showSourceIp输出示例

{
  "headers": {
    "Transfer-Encoding": "chunked",
    "Server": "api-gateway",
    "X-Request-Id": "f7e759ff25266227a1d31f5068a5b3ed",
    "X-Content-Type-Options": "nosniff",
    "Connection": "keep-alive",
    "X-Download-Options": "noopen",
    "Pragma": "no-cache",
    "Date": "Mon, 25 May 2026 09:10:00 GMT",
    "X-Frame-Options": "SAMEORIGIN",
    "Strict-Transport-Security": "max-age=31536000; includeSubdomains;",
    "Cache-Control": "no-cache, no-store, max-age=0, must-revalidate",
    "X-XSS-Protection": "1; mode=block;",
    "Content-Type": "application/json; charset=UTF-8"
  },
  "code": 200,
  "body": {
    "source_ips": [
      "192.168.1.1",
      "192.168.1.2"
    ]
  }
}

插件执行函数showSubscriptionInfo说明

函数showSubscriptionInfo参数说明：介绍函数的输入参数和输出参数。
函数showSubscriptionInfo输出示例：给出函数的输出示例。

函数showSubscriptionInfo参数说明

函数功能：获取WAF订阅信息。

**表37** 函数showSubscriptionInfo入参说明
参数名称	参数类型	参数描述	是否必填
input	String	输入参数	否

**表38** 函数showSubscriptionInfo出参说明
参数名称	参数类型	参数描述
headers	Object	接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。
code	Int	状态码，表明请求是否成功。 “code”取值示例说明： “code”为“200”：表示请求成功。 “code”为“401”：表示账号或密码错误。 “code”为“403”：表示权限不足。 “code”为“404”：表示请求资源不存在。
body	Object	接口返回的具体内容。

函数showSubscriptionInfo输出示例

{
  "headers": {
    "Transfer-Encoding": "chunked",
    "Server": "api-gateway",
    "X-Request-Id": "f7e759ff25266227a1d31f5068a5b3ed",
    "X-Content-Type-Options": "nosniff",
    "Connection": "keep-alive",
    "X-Download-Options": "noopen",
    "Pragma": "no-cache",
    "Date": "Mon, 25 May 2026 09:10:00 GMT",
    "X-Frame-Options": "SAMEORIGIN",
    "Strict-Transport-Security": "max-age=31536000; includeSubdomains;",
    "Cache-Control": "no-cache, no-store, max-age=0, must-revalidate",
    "X-XSS-Protection": "1; mode=block;",
    "Content-Type": "application/json; charset=UTF-8"
  },
  "code": 200,
  "body": {
    "subscriptionId": "sub-12345678",
    "subscriptionName": "WAF订阅",
    "status": "ACTIVE",
    "version": "v1.0"
  }
}

插件执行函数operationAddressGroup说明

函数operationAddressGroup参数说明：介绍函数的输入参数和输出参数。
函数operationAddressGroup输出示例：给出函数的输出示例。

函数operationAddressGroup参数说明

函数功能：批量操作地址组，支持添加或删除IP地址到WAF地址组。

**表39** 函数operationAddressGroup入参说明
参数名称	参数类型	参数描述	是否必填
ip_list	String	IP列表	是
enterprise_project_id	String	企业项目ID	是
policy	String	策略名称	是
operation_type	String	操作类型，SENDING表示添加IP，DELETING表示删除IP	是
language	String	语言，可取值范围：zh-cn、en-us，不支持大写，不支持其他取值。其中zh-cn表示简体中文；en-us表示英语。	否
agency_type	String	多账号统一适配参数，使用默认值即可	否

**表40** 函数operationAddressGroup出参说明
参数名称	参数类型	参数描述
headers	Object	接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。
code	Int	状态码，表明请求是否成功。 “code”取值示例说明： “code”为“200”：表示请求成功。 “code”为“401”：表示账号或密码错误。 “code”为“403”：表示权限不足。 “code”为“404”：表示请求资源不存在。
body	Object	接口返回的具体内容。

函数operationAddressGroup输出示例

{
  "headers": {
    "Transfer-Encoding": "chunked",
    "Server": "api-gateway",
    "X-Request-Id": "f7e759ff25266227a1d31f5068a5b3ed",
    "X-Content-Type-Options": "nosniff",
    "Connection": "keep-alive",
    "X-Download-Options": "noopen",
    "Pragma": "no-cache",
    "Date": "Mon, 25 May 2026 09:10:00 GMT",
    "X-Frame-Options": "SAMEORIGIN",
    "Strict-Transport-Security": "max-age=31536000; includeSubdomains;",
    "Cache-Control": "no-cache, no-store, max-age=0, must-revalidate",
    "X-XSS-Protection": "1; mode=block;",
    "Content-Type": "application/json; charset=UTF-8"
  },
  "code": 200,
  "body": {
    "id": "ipg-12345678",
    "name": "updated-ip-group",
    "ips": "192.168.1.1,192.168.1.2,192.168.1.3",
    "size": 3
  }
}

父主题： 系统内置流程插件说明

上一篇：VPC

下一篇：CFW

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

云宝助手提问云社区提问

WAF