文档首页/ 安全云脑 SecMaster/ 用户指南/ 安全编排/ 系统内置流程插件说明/ CFW
更新时间：2026-09-11 GMT+08:00
查看PDF
分享

CFW

安全云脑系统内置插件，可调用 CFW（云防火墙）云服务接口执行操作，主要用于管理防火墙、ACL规则、地址组、黑白名单等CFW资源。

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

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

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

    图1 进入目标工作空间管理页面

  4. 在左侧导航栏选择“安全编排 > 插件管理”，进入插件管理页面。

    图2 插件管理页面

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

插件执行函数addAclRule说明

函数addAclRule参数说明

函数功能：添加ACL（访问控制列表）规则。

表1 函数addAclRule入参说明

参数名称

参数类型

参数描述

是否必填

enterpriseProjectId

string

企业项目ID

否

fwInstanceId

string

防火墙实例ID

否

addressType

string

IP地址类型

0表示IPv4，1表示IPv6

否

objectId

string

防护对象ID

是

type

string

规则类型

是

rules

array

规则列表（JSON格式）

是

agency_type

string

多账号统一适配参数，使用默认值即可

否
表2 函数addAclRule出参说明

参数名称

参数类型

参数描述

headers

Object

接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。

code

Int

状态码，表明请求是否成功。

“code”取值示例说明：

  • “code”为“200”：表示请求成功。
  • “code”为“401”：表示账号或密码错误。
  • “code”为“403”：表示权限不足。
  • “code”为“404”：表示请求资源不存在。

body

Object

接口返回的具体内容。

函数addAclRule输出示例

{
  "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": {}
}

插件执行函数listAclRules说明

函数listAclRules参数说明

函数功能：列出ACL规则列表。

表3 函数listAclRules入参说明

参数名称

参数类型

参数描述

是否必填

object_id

string

防护对象ID

是

type

string

规则类型

否

ip

string

IP地址

否

name

string

规则名称

否

direction

string

方向

否

status

string

状态

否

action_type

string

动作类型

否

address_type

string

地址类型

否

offset

string

偏移量

是

limit

string

每页数量

是

enterprise_project_id

string

企业项目ID

否

fw_instance_id

string

防火墙ID

否

tags_id

string

规则标签id，创建规则时产生

否

source

string

源地址

否

destination

string

目的地址

否

service

string

服务端口

否

application

string

规则应用协议列表，包括：“HTTP”，"HTTPS"，"TLS1"，“DNS”，“SSH”，“MYSQL”，“SMTP”，“RDP”，“RDPS”，“VNC”，“POP3”，“IMAP4”，“SMTPS”，“POP3S”，“FTPS”，“ANY”，“BGP”等。

否
表4 函数listAclRules出参说明

参数名称

参数类型

参数描述

headers

Object

接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。

code

Int

状态码，表明请求是否成功。

“code”取值示例说明：

  • “code”为“200”：表示请求成功。
  • “code”为“401”：表示账号或密码错误。
  • “code”为“403”：表示权限不足。
  • “code”为“404”：表示请求资源不存在。

body

Object

接口返回的具体内容。

函数listAclRules输出示例

{
  "headers": {
    "Transfer-Encoding": "chunked",
    "Server": "api-gateway",
    "X-Request-Id": "a07e78c7c0f9b9cf556517a622cf385c",
    "X-Content-Type-Options": "nosniff",
    "Connection": "keep-alive",
    "X-Download-Options": "noopen",
    "Date": "Mon, 01 Jun 2026 07:44:15 GMT",
    "X-Frame-Options": "SAMEORIGIN",
    "Strict-Transport-Security": "max-age=31536000; includeSubdomains;",
    "Cache-Control": "no-cache, no-store, max-age=0, must-revalidate",
    "X-B3-TraceId": "a07e78c7c0xxxxxxxx556517a622cf385c",
    "X-XSS-Protection": "1; mode=block;",
    "Content-Type": "application/json"
  },
  "code": 200,
  "body": {
    "data": {
      "total": 2,
      "offset": 0,
      "records": [
        {
          "address_type": 0,
          "action_type": 1,
          "applicationsJsonString": "",
          "destination": {
            "address_group": [
              "2a57a1f9-0c35-41c4-8c35-9axxxxx8d79"
            ],
            "address_type": 0,
            "address_group_names": [
              {
                "name": "SecMaster_Group_IPv4_EGRESS_BLOCK1",
                "address_set_type": 0,
                "set_id": "2a57a1f9-0c35-41c4-8c35-9axxxxx98d79"
              }
            ],
            "type": 5
          },
          "last_open_time": "2026-03-26 15:14:43 +0800",
          "description": "SecMaster Automatic Blocking",
          "source": {
            "address": "0.0.0.0/0",
            "address_type": 0,
            "type": 0
          },
          "modified_date": "2026-03-26 15:14:43 +0800",
          "type": "0",
          "rule_id": "cffe4dd0-e2fc-48a3-82b5-afcxxxxx7b98",
          "long_connect_enable": 0,
          "service": {
            "protocol": -1,
            "type": 0
          },
          "name": "SecMaster_BLOCK_4_EGRESS_Rule0",
          "created_date": "2026-03-24 11:20:49 +0800",
          "order_id": 990000,
          "direction": 1,
          "status": 1
        },
        {
          "address_type": 0,
          "action_type": 1,
          "destination": {
            "address": "0.0.0.0/0",
            "address_type": 0,
            "type": 0
          },
          "last_open_time": "2026-03-24 10:37:06 +0800",
          "description": "SecMaster Automatic Blocking",
          "source": {
            "address_group": [
              "1e7f8d01-df22-4612-8935-bxxxxx6f55b"
            ],
            "address_type": 0,
            "address_group_names": [
              {
                "name": "SecMaster_Group_IPv4_INGRESS_BLOCK0",
                "address_set_type": 0,
                "set_id": "1e7f8d01-df22-4612-8935-xxxxxf55b"
              }
            ],
            "type": 5
          },
          "modified_date": "2026-03-24 11:12:03 +0800",
          "type": "0",
          "rule_id": "7409cb78-0b2e-446d-afe2-ed3xxxxxfce",
          "long_connect_enable": 0,
          "service": {
            "protocol": -1,
            "type": 0
          },
          "name": "SecMaster_BLOCK_4_INGRESS_Rule0",
          "created_date": "2026-03-24 10:37:06 +0800",
          "order_id": 995000,
          "direction": 0,
          "status": 1
        }
      ],
      "limit": 10,
      "up_rules_count": 0,
      "object_id": "53d54aa7-ae92-48d9-9837-8xxxx6a074"
    }
  }
}

插件执行函数addAddressItemsUsingPost说明

函数addAddressItemsUsingPost参数说明

函数功能：添加地址项（IP地址等）。

表5 函数addAddressItemsUsingPost入参说明

参数名称

参数类型

参数描述

是否必填

enterpriseProjectId

string

企业项目ID

否

fwInstanceId

string

防火墙实例ID

否

setId

string

地址集ID

否

name

string

地址项名称

是

addressType

string

地址类型：0-IPv4, 1-IPv6

否

address

string

地址

否

description

string

描述

否

agency_type

string

多账号统一适配参数，使用默认值即可

否
表6 函数addAddressItemsUsingPost出参说明

参数名称

参数类型

参数描述

headers

Object

接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。

code

Int

状态码，表明请求是否成功。

“code”取值示例说明：

  • “code”为“200”：表示请求成功。
  • “code”为“401”：表示账号或密码错误。
  • “code”为“403”：表示权限不足。
  • “code”为“404”：表示请求资源不存在。

body

Object

接口返回的具体内容。

函数addAddressItemsUsingPost输出示例

{
  "headers": {
    "Transfer-Encoding": "chunked",
    "Server": "api-gateway",
    "X-Request-Id": "a6c1486e9c0ddcf1fb3b0997deefec94",
    "X-Content-Type-Options": "nosniff",
    "Connection": "keep-alive",
    "X-Download-Options": "noopen",
    "Date": "Mon, 01 Jun 2026 07:47:49 GMT",
    "X-Frame-Options": "SAMEORIGIN",
    "Strict-Transport-Security": "max-age=31536000; includeSubdomains;",
    "Cache-Control": "no-cache, no-store, max-age=0, must-revalidate",
    "X-B3-TraceId": "a6c1486e9c0ddcf1fb3b0997deefec94",
    "X-XSS-Protection": "1; mode=block;",
    "Content-Type": "application/json"
  },
  "code": 200,
  "body": {
    "data": {
      "covered_ip": [],
      "items": [
        {
          "id": "859b0d32-1f35-4030-904c-8b5284ff2700"
        }
      ]
    }
  }
}

插件执行函数deleteAddressItemUsingDelete说明

函数deleteAddressItemUsingDelete参数说明

函数功能：删除地址项。

表7 函数deleteAddressItemUsingDelete入参说明

参数名称

参数类型

参数描述

是否必填

item_id

string

地址项ID

是

enterpriseProjectId

string

企业项目ID

否

fwInstanceId

string

防火墙ID

否

agency_type

string

账号统一适配参数，使用默认值即可

否
表8 函数deleteAddressItemUsingDelete出参说明

参数名称

参数类型

参数描述

headers

Object

接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。

code

Int

状态码，表明请求是否成功。

“code”取值示例说明：

  • “code”为“200”：表示请求成功。
  • “code”为“401”：表示账号或密码错误。
  • “code”为“403”：表示权限不足。
  • “code”为“404”：表示请求资源不存在。

body

Object

接口返回的具体内容。

函数deleteAddressItemUsingDelete输出示例

{
  "headers": {
    "Transfer-Encoding": "chunked",
    "Server": "api-gateway",
    "X-Request-Id": "03a489dce9c814e5eed4eaa0d38517dc",
    "X-Content-Type-Options": "nosniff",
    "Connection": "keep-alive",
    "X-Download-Options": "noopen",
    "Date": "Mon, 01 Jun 2026 07:50:27 GMT",
    "X-Frame-Options": "SAMEORIGIN",
    "Strict-Transport-Security": "max-age=31536000; includeSubdomains;",
    "Cache-Control": "no-cache, no-store, max-age=0, must-revalidate",
    "X-B3-TraceId": "03a489dce9c814e5eed4eaa0d38517dc",
    "X-XSS-Protection": "1; mode=block;",
    "Content-Type": "application/json"
  },
  "code": 200,
  "body": {
    "data": {
      "name": "20.26.6.1",
      "id": "859b0d32-1f35-4030-904c-8b5284ff2700"
    }
  }
}

插件执行函数listAddressItemsUsingGet说明

函数listAddressItemsUsingGet参数说明

函数功能：列出地址项。

表9 函数listAddressItemsUsingGet入参说明

参数名称

参数类型

参数描述

是否必填

offset

string

偏移量

是

limit

string

每页数量

是

set_id

string

地址集ID

是

address

string

IP地址

否

keyWord

string

关键字，包括地址组成员名称或描述的一部分

否

enterpriseProjectId

string

企业项目ID

否

fwInstanceId

string

防火墙ID

否
表10 函数listAddressItemsUsingGet出参说明

参数名称

参数类型

参数描述

headers

Object

接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。

code

Int

状态码，表明请求是否成功。

“code”取值示例说明：

  • “code”为“200”：表示请求成功。
  • “code”为“401”：表示账号或密码错误。
  • “code”为“403”：表示权限不足。
  • “code”为“404”：表示请求资源不存在。

body

Object

接口返回的具体内容。

函数listAddressItemsUsingGet输出示例

{
  "headers": {
    "Transfer-Encoding": "chunked",
    "Server": "api-gateway",
    "X-Request-Id": "9fbf862f92c9373ca15fbcff56c9b9e9",
    "X-Content-Type-Options": "nosniff",
    "Connection": "keep-alive",
    "X-Download-Options": "noopen",
    "Date": "Mon, 01 Jun 2026 07:58:29 GMT",
    "X-Frame-Options": "SAMEORIGIN",
    "Strict-Transport-Security": "max-age=31536000; includeSubdomains;",
    "Cache-Control": "no-cache, no-store, max-age=0, must-revalidate",
    "X-B3-TraceId": "9fbf862f92c9373ca15fbcff56c9b9e9",
    "X-XSS-Protection": "1; mode=block;",
    "Content-Type": "application/json"
  },
  "code": 200,
  "body": {
    "data": {
      "total": 1,
      "offset": 0,
      "records": [
        {
          "address": "20.26.6.1",
          "address_type": 0,
          "item_id": "1aa59359-a214-40f4-aea5-57d9c4c260e6",
          "description": ""
        }
      ],
      "limit": 10,
      "set_id": "2a57a1f9-0c35-41c4-8c35-9ab7a3998d79"
    }
  }
}

插件执行函数addAddressSetInfoUsingPost说明

函数addAddressSetInfoUsingPost参数说明

函数功能：添加地址集信息。

表11 函数addAddressSetInfoUsingPost入参说明

参数名称

参数类型

参数描述

是否必填

enterpriseProjectId

string

企业项目ID

否

fwInstanceId

string

防火墙实例ID

否

name

string

地址组名称

是

address_type

string

地址类型

否

objectId

string

防护对象id

是

description

string

地址组描述

否

agency_type

string

多账号统一适配参数，使用默认值即可

否
表12 函数addAddressSetInfoUsingPost出参说明

参数名称

参数类型

参数描述

headers

Object

接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。

code

Int

状态码，表明请求是否成功。

“code”取值示例说明：

  • “code”为“200”：表示请求成功。
  • “code”为“401”：表示账号或密码错误。
  • “code”为“403”：表示权限不足。
  • “code”为“404”：表示请求资源不存在。

body

Object

接口返回的具体内容。

函数addAddressSetInfoUsingPost输出示例

{
  "headers": {
    "Transfer-Encoding": "chunked",
    "Server": "api-gateway",
    "X-Request-Id": "fe015e02c42747b34a0c8247d6aec920",
    "X-Content-Type-Options": "nosniff",
    "Connection": "keep-alive",
    "X-Download-Options": "noopen",
    "Date": "Mon, 01 Jun 2026 08:49:15 GMT",
    "X-Frame-Options": "SAMEORIGIN",
    "Strict-Transport-Security": "max-age=31536000; includeSubdomains;",
    "Cache-Control": "no-cache, no-store, max-age=0, must-revalidate",
    "X-B3-TraceId": "fe015e02c42747b34a0c8247d6aec920",
    "X-XSS-Protection": "1; mode=block;",
    "Content-Type": "application/json"
  },
  "code": 200,
  "body": {
    "data": {
      "name": "test",
      "has_item": false,
      "id": "89da5700-cecb-4027-b6a4-e2fe94b8b9f7"
    }
  }
}

插件执行函数deleteAddressSetInfoUsingDelete说明

函数deleteAddressSetInfoUsingDelete参数说明

函数功能：删除地址集信息。

表13 函数deleteAddressSetInfoUsingDelete入参说明

参数名称

参数类型

参数描述

是否必填

set_id

string

地址组ID

是

enterpriseProjectId

string

企业项目ID

否

fwInstanceId

string

防火墙ID

否

agency_type

string

多账号统一适配参数，使用默认值即可

否
表14 函数deleteAddressSetInfoUsingDelete出参说明

参数名称

参数类型

参数描述

headers

Object

接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。

code

Int

状态码，表明请求是否成功。

“code”取值示例说明：

  • “code”为“200”：表示请求成功。
  • “code”为“401”：表示账号或密码错误。
  • “code”为“403”：表示权限不足。
  • “code”为“404”：表示请求资源不存在。

body

Object

接口返回的具体内容。

函数deleteAddressSetInfoUsingDelete输出示例

{
  "headers": {
    "Transfer-Encoding": "chunked",
    "Server": "api-gateway",
    "X-Request-Id": "c858039f43996f536545b43be18985ea",
    "X-Content-Type-Options": "nosniff",
    "Connection": "keep-alive",
    "X-Download-Options": "noopen",
    "Date": "Mon, 01 Jun 2026 08:51:43 GMT",
    "X-Frame-Options": "SAMEORIGIN",
    "Strict-Transport-Security": "max-age=31536000; includeSubdomains;",
    "Cache-Control": "no-cache, no-store, max-age=0, must-revalidate",
    "X-B3-TraceId": "c858039f43996f536545b43be18985ea",
    "X-XSS-Protection": "1; mode=block;",
    "Content-Type": "application/json"
  },
  "code": 200,
  "body": {
    "data": {
      "name": "test",
      "id": "89da5700-cecb-4027-b6a4-e2fe94b8b9f7"
    }
  }
}

插件执行函数listAddressSetListUsingGet说明

函数listAddressSetListUsingGet参数说明

函数功能：列出地址集列表。

表15 函数listAddressSetListUsingGet入参说明

参数名称

参数类型

参数描述

是否必填

offset

string

偏移量

是

limit

string

每页数量

是

objectId

string

防护对象ID

是

enterpriseProjectId

string

企业项目ID

否

fwInstanceId

string

防火墙实例ID

否

address

string

地址

否

keyWord

string

关键词

否

addressType

string

地址类型

否
表16 函数listAddressSetListUsingGet出参说明

参数名称

参数类型

参数描述

headers

Object

接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。

code

Int

状态码，表明请求是否成功。

“code”取值示例说明：

  • “code”为“200”：表示请求成功。
  • “code”为“401”：表示账号或密码错误。
  • “code”为“403”：表示权限不足。
  • “code”为“404”：表示请求资源不存在。

body

Object

接口返回的具体内容。

函数listAddressSetListUsingGet输出示例

{
  "headers": {
    "Transfer-Encoding": "chunked",
    "Server": "api-gateway",
    "X-Request-Id": "eaa66a4ee0ee4dea548d970c26b232bc",
    "X-Content-Type-Options": "nosniff",
    "Connection": "keep-alive",
    "X-Download-Options": "noopen",
    "Date": "Wed, 03 Jun 2026 02:27:04 GMT",
    "X-Frame-Options": "SAMEORIGIN",
    "Strict-Transport-Security": "max-age=31536000; includeSubdomains;",
    "Cache-Control": "no-cache, no-store, max-age=0, must-revalidate",
    "X-B3-TraceId": "eaa66a4ee0ee4dea548d970c26b232bc",
    "X-XSS-Protection": "1; mode=block;",
    "Content-Type": "application/json"
  },
  "code": 200,
  "body": {
    "data": {
      "total": 3,
      "offset": 0,
      "records": [
        {
          "address_type": 0,
          "name": "SecMaster_Group_IPv4_EGRESS_BLOCK0",
          "address_set_type": 0,
          "description": "SecMaster Automatic Blocking",
          "set_id": "33c18eaa-799a-482b-9a34-cd588e086791",
          "ref_count": 1,
          "object_id": "973ffe00-7b96-401d-87c0-fd8207423a98"
        }
      ],
      "limit": 1
    }
  }
}

插件执行函数listAddressSetDetailUsingGet说明

函数listAddressSetDetailUsingGet参数说明

函数功能：列出地址集详情。

表17 函数listAddressSetDetailUsingGet入参说明

参数名称

参数类型

参数描述

是否必填

setId

string

地址集ID

是

enterpriseProjectId

string

企业项目ID

否

fwInstanceId

string

防火墙实例ID

否
表18 函数listAddressSetDetailUsingGet出参说明

参数名称

参数类型

参数描述

headers

Object

接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。

code

Int

状态码，表明请求是否成功。

“code”取值示例说明：

  • “code”为“200”：表示请求成功。
  • “code”为“401”：表示账号或密码错误。
  • “code”为“403”：表示权限不足。
  • “code”为“404”：表示请求资源不存在。

body

Object

接口返回的具体内容。

函数listAddressSetDetailUsingGet输出示例

{
  "headers": {
    "Transfer-Encoding": "chunked",
    "Server": "api-gateway",
    "X-Request-Id": "e50f60f6d0f3c9e8b6dcf37b4d49578c",
    "X-Content-Type-Options": "nosniff",
    "Connection": "keep-alive",
    "X-Download-Options": "noopen",
    "Date": "Wed, 03 Jun 2026 02:28:24 GMT",
    "X-Frame-Options": "SAMEORIGIN",
    "Strict-Transport-Security": "max-age=31536000; includeSubdomains;",
    "Cache-Control": "no-cache, no-store, max-age=0, must-revalidate",
    "X-B3-TraceId": "e50f60f6d0f3c9e8b6dcf37b4d49578c",
    "X-XSS-Protection": "1; mode=block;",
    "Content-Type": "application/json"
  },
  "code": 200,
  "body": {
    "data": {
      "address_type": 0,
      "name": "SecMaster_Group_IPv4_EGRESS_BLOCK0",
      "address_set_type": 0,
      "description": "SecMaster Automatic Blocking",
      "id": "33c18eaa-799a-482b-9a34-cd588e086791"
    }
  }
}

插件执行函数addBlackWhiteListUsingPost说明

函数addBlackWhiteListUsingPost参数说明

函数功能：添加黑白名单规则。

表19 函数addBlackWhiteListUsingPost入参说明

参数名称

参数类型

参数描述

是否必填

fwInstanceId

string

防火墙实例ID

否

address

string

IP地址

是

direction

string

方向

是

protocol

string

协议

否

port

string

端口

否

addressType

string

地址类型

是

objectId

string

防护对象ID

是

enterpriseProjectId

string

企业项目ID

否

listType

string

黑白名单类型

4：黑名单，5：白名单

是

description

string

描述

否

language

string

查询结果的响应语言，可取值范围：zh-cn、en-us，不支持大写，不支持其他取值。

其中zh-cn表示查询结果显示语言为简体中文；en-us表示查询结果显示语言为英语。

否

agency_type

string

多账号统一适配参数，使用默认值即可

否
表20 函数addBlackWhiteListUsingPost出参说明

参数名称

参数类型

参数描述

headers

Object

接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。

code

Int

状态码，表明请求是否成功。

“code”取值示例说明：

  • “code”为“200”：表示请求成功。
  • “code”为“401”：表示账号或密码错误。
  • “code”为“403”：表示权限不足。
  • “code”为“404”：表示请求资源不存在。

body

Object

接口返回的具体内容。

函数addBlackWhiteListUsingPost输出示例

{
  "headers": {
    "Transfer-Encoding": "chunked",
    "Server": "api-gateway",
    "X-Request-Id": "fa8c2e2af80e461d79bfb361c3287cbe",
    "X-Content-Type-Options": "nosniff",
    "Connection": "keep-alive",
    "X-Download-Options": "noopen",
    "Date": "Wed, 03 Jun 2026 02:34:49 GMT",
    "X-Frame-Options": "SAMEORIGIN",
    "Strict-Transport-Security": "max-age=31536000; includeSubdomains;",
    "Cache-Control": "no-cache, no-store, max-age=0, must-revalidate",
    "X-B3-TraceId": "fa8c2e2af80e461d79bfb361c3287cbe",
    "X-XSS-Protection": "1; mode=block;",
    "Content-Type": "application/json"
  },
  "code": 200,
  "body": {
    "data": {
      "name": "20.26.6.3",
      "id": "8f178c60-304a-4d3c-bc6b-12c74ceece68"
    }
  }
}

插件执行函数deleteBlackWhiteListUsingDelete说明

函数deleteBlackWhiteListUsingDelete参数说明

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

表21 函数deleteBlackWhiteListUsingDelete入参说明

参数名称

参数类型

参数描述

是否必填

listId

string

黑白名单ID

是

fwInstanceId

string

防火墙ID

否

enterpriseProjectId

string

企业项目ID

否

language

string

查询结果的响应语言，可取值范围：zh-cn、en-us，不支持大写，不支持其他取值。

其中zh-cn表示查询结果显示语言为简体中文；en-us表示查询结果显示语言为英语。

否

agency_type

string

多账号统一适配参数，使用默认值即可

否
表22 函数deleteBlackWhiteListUsingDelete出参说明

参数名称

参数类型

参数描述

headers

Object

接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。

code

Int

状态码，表明请求是否成功。

“code”取值示例说明：

  • “code”为“200”：表示请求成功。
  • “code”为“401”：表示账号或密码错误。
  • “code”为“403”：表示权限不足。
  • “code”为“404”：表示请求资源不存在。

body

Object

接口返回的具体内容。

函数deleteBlackWhiteListUsingDelete输出示例

{
  "headers": {
    "Transfer-Encoding": "chunked",
    "Server": "api-gateway",
    "X-Request-Id": "2e83a23f720a490377149ad8d4266c2a",
    "X-Content-Type-Options": "nosniff",
    "Connection": "keep-alive",
    "X-Download-Options": "noopen",
    "Date": "Wed, 03 Jun 2026 02:36:26 GMT",
    "X-Frame-Options": "SAMEORIGIN",
    "Strict-Transport-Security": "max-age=31536000; includeSubdomains;",
    "Cache-Control": "no-cache, no-store, max-age=0, must-revalidate",
    "X-B3-TraceId": "2e83a23f720a490377149ad8d4266c2a",
    "X-XSS-Protection": "1; mode=block;",
    "Content-Type": "application/json"
  },
  "code": 200,
  "body": {
    "data": {
      "name": "20.26.6.3",
      "id": "8f178c60-304a-4d3c-bc6b-12c74ceece68"
    }
  }
}

插件执行函数listBlackWhiteListsUsingGet说明

函数listBlackWhiteListsUsingGet参数说明

函数功能：列出黑白名单。

表23 函数listBlackWhiteListsUsingGet入参说明

参数名称

参数类型

参数描述

是否必填

offset

string

偏移量

是

limit

string

每页显示个数，范围为1-1024

是

objectId

string

防护对象ID

是

enterpriseProjectId

string

企业项目ID

否

listType

string

黑白名单类型

4：黑名单，5：白名单

是

fwInstanceId

string

防火墙ID

否

address

string

IP地址

否

port

string

端口

否

addressType

string

IP地址类型

0：ipv4，1:ipv6

否

language

string

查询结果的响应语言，可取值范围：zh-cn、en-us，不支持大写，不支持其他取值。

其中zh-cn表示查询结果显示语言为简体中文；en-us表示查询结果显示语言为英语。

否
表24 函数listBlackWhiteListsUsingGet出参说明

参数名称

参数类型

参数描述

headers

Object

接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。

code

Int

状态码，表明请求是否成功。

“code”取值示例说明：

  • “code”为“200”：表示请求成功。
  • “code”为“401”：表示账号或密码错误。
  • “code”为“403”：表示权限不足。
  • “code”为“404”：表示请求资源不存在。

body

Object

接口返回的具体内容。

函数listBlackWhiteListsUsingGet输出示例

{
  "headers": {
    "Transfer-Encoding": "chunked",
    "Server": "api-gateway",
    "X-Request-Id": "4e87c2dfe2341f6ef30db50a11411685",
    "X-Content-Type-Options": "nosniff",
    "Connection": "keep-alive",
    "X-Download-Options": "noopen",
    "Date": "Wed, 03 Jun 2026 03:11:52 GMT",
    "X-Frame-Options": "SAMEORIGIN",
    "Strict-Transport-Security": "max-age=31536000; includeSubdomains;",
    "Cache-Control": "no-cache, no-store, max-age=0, must-revalidate",
    "X-B3-TraceId": "4e87c2dfe2341f6ef30db50a11411685",
    "X-XSS-Protection": "1; mode=block;",
    "Content-Type": "application/json"
  },
  "code": 200,
  "body": {
    "data": {
      "total": 1,
      "offset": 0,
      "records": [
        {
          "protocol": -1,
          "address": "22.33.44.55",
          "address_type": 0,
          "list_id": "8f064c4a-cb4e-4007-bae9-5142300df777",
          "created_date": 1780456306000,
          "modified_date": 1780456306000,
          "direction": 0
        }
      ],
      "limit": 1
    }
  }
}

插件执行函数listFirewall说明

函数listFirewall参数说明

函数功能：列出防火墙实例。

表25 函数listFirewall入参说明

参数名称

参数类型

参数描述

是否必填

offset

string

偏移量

是

limit

string

每页数量

是

keyWord

string

关键词

否

enterpriseProjectId

string

企业项目ID

否

tags

array

标签列表

否

resultVariable

string

用于过滤查询结果

否
表26 函数listFirewall出参说明

参数名称

参数类型

参数描述

headers

Object

接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。

code

Int

状态码，表明请求是否成功。

“code”取值示例说明：

  • “code”为“200”：表示请求成功。
  • “code”为“401”：表示账号或密码错误。
  • “code”为“403”：表示权限不足。
  • “code”为“404”：表示请求资源不存在。

body

Object

接口返回的具体内容。

函数listFirewall输出示例

{
  "headers": {
    "Transfer-Encoding": "chunked",
    "Server": "api-gateway",
    "X-Request-Id": "6f81a2de70b51c81df744f097e7f49ae",
    "X-Content-Type-Options": "nosniff",
    "Connection": "keep-alive",
    "X-Download-Options": "noopen",
    "Date": "Wed, 03 Jun 2026 03:16:02 GMT",
    "X-Frame-Options": "SAMEORIGIN",
    "Strict-Transport-Security": "max-age=31536000; includeSubdomains;",
    "Cache-Control": "no-cache, no-store, max-age=0, must-revalidate",
    "X-B3-TraceId": "6f81a2de70b51c81df744f097e7f49ae",
    "X-XSS-Protection": "1; mode=block;",
    "Content-Type": "application/json"
  },
  "code": 200,
  "body": {
    "is_support_postpaid": true,
    "is_support_unibuy": true,
    "data": {
      "total": 5,
      "offset": 0,
      "project_id": "f69081793d9e4ea8a2f479dcef961989",
      "records": [
        {
          "az_code": "center",
          "fw_instance_name": "CFW-60055215",
          "az_name": "center",
          "charge_mode": 1,
          "tags": "{}",
          "flavor": {
            "vpc_count": 5,
            "eip_count": 1000,
            "default_bandwidth": 50,
            "bandwidth": 200,
            "default_eip_count": 50,
            "default_vpc_count": 2,
            "log_storage": 0,
            "version": 1,
            "default_log_storage": 0
          },
          "enterprise_project_id": "0",
          "service_type": 0,
          "engine_type": 1,
          "name": "1754635159172",
          "resource_id": "a442690e-536f-4c25-991d-a5243f1baa99",
          "fw_instance_id": "a442690e-536f-4c25-991d-a5243f1baa99",
          "ha_type": 1,
          "status": 7
        }
      ],
      "limit": 1
    },
    "is_support_buy_professional": true,
    "user_support_eps": true,
    "is_support_edge": true,
    "is_support_platinum": false,
    "os_type": 0,
    "has_ndr": false,
    "is_support_tms": true,
    "is_support_ndr": true,
    "is_support_upgrade_platinum": false,
    "is_support_basic_version": true
  }
}

插件执行函数listFirewallDetail说明

函数listFirewallDetail参数说明

函数功能：列出防火墙详细信息。

表27 函数listFirewallDetail入参说明

参数名称

参数类型

参数描述

是否必填

offset

string

偏移量

是

limit

string

每页显示个数，范围为1-1024

是

service_type

string

服务类型

是

enterprise_project_id

string

企业项目ID

否

fw_instance_id

string

防火墙ID

否

name

string

防火墙名称

否

resultVariable

string

用于过滤查询结果

否
表28 函数listFirewallDetail出参说明

参数名称

参数类型

参数描述

headers

Object

接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。

code

Int

状态码，表明请求是否成功。

“code”取值示例说明：

  • “code”为“200”：表示请求成功。
  • “code”为“401”：表示账号或密码错误。
  • “code”为“403”：表示权限不足。
  • “code”为“404”：表示请求资源不存在。

body

Object

接口返回的具体内容。

函数listFirewallDetail输出示例

{
  "headers": {
    "Transfer-Encoding": "chunked",
    "Server": "api-gateway",
    "X-Request-Id": "7ecb4f71a5279898f5f655d76c07b6cc",
    "X-Content-Type-Options": "nosniff",
    "Connection": "keep-alive",
    "X-Download-Options": "noopen",
    "Date": "Wed, 03 Jun 2026 06:39:07 GMT",
    "X-Frame-Options": "SAMEORIGIN",
    "Strict-Transport-Security": "max-age=31536000; includeSubdomains;",
    "Cache-Control": "no-cache, no-store, max-age=0, must-revalidate",
    "X-B3-TraceId": "7ecb4f71a5279898f5f655d76c07b6cc",
    "X-XSS-Protection": "1; mode=block;",
    "Content-Type": "application/json"
  },
  "code": 200,
  "body": {
    "is_support_other_project_vpc": false,
    "data": {
      "total": 5,
      "offset": 0,
      "records": [
        {
          "fw_instance_name": "CFW-60055215",
          "resources": [],
          "is_available_obs": true,
          "charge_mode": 1,
          "time_zone": "GMT+08:00",
          "feature_toggle": {
            "is_support_anti_virus": true,
            "is_support_sctp": false,
            "is_support_local_az": true,
            "is_support_other_project_vpc": false,
            "is_support_application": true,
            "is_support_mix_multi_object": true,
            "is_support_lts": true,
            "is_support_ew_create_er_tenant_inspection_mode": false,
            "is_support_dnat": true,
            "is_support_vpc_application_domain": true,
            "ips_rule_list": true,
            "is_support_capture_result_link_enhance": true,
            "is_support_close_import_acl": false,
            "is_support_ew_create_vpc_peering_inspection_mode": true,
            "is_support_multi_project": false,
            "is_support_threat_tags": true,
            "is_not_support_resource_reduction": false,
            "is_support_ew_create_er_bearer_inspection_mode": true,
            "is_support_traffic_filter_ip_blacklist": true,
            "is_support_smn": true,
            "is_support_predefined": true,
            "is_support_user_defined_dns_config": true,
            "is_support_url_profile": false,
            "is_support_flink": true,
            "is_support_domain_identify": true,
            "is_support_vpc_dns_domain": true,
            "is_support_acl_group": true,
            "is_support_acl_hit_status": true,
            "isSupportSession": false,
            "is_support_acl_region_config": true,
            "is_support_ips": false,
            "long_connect": true,
            "is_support_firewall_bypass": true,
            "is_support_api_compliance_v1": true,
            "is_new_self_engine": true,
            "alarm_config": true,
            "is_support_flow_associated_host": true,
            "acl_multi_object": true,
            "is_support_advanced_ips_rule": true,
            "is_support_capture": false,
            "is_support_ips_whitelist": true,
            "is_support_link_enhancements": false,
            "is_support_tcp_proxy": false,
            "is_support_attack_source_type": true,
            "is_support_l3gw": false,
            "is_support_upgrade": true,
            "is_support_domain_intelligence": true,
            "is_support_schedule": false,
            "is_self_support_all_application": true,
            "is_support_slb_private_network_segments": true,
            "is_support_real_ip": false,
            "is_support_qos": false,
            "is_support_multi_account": false,
            "is_support_swift_adaptor": false
          },
          "tags": "{}",
          "failed_policy_count": 8,
          "is_support_ew_ipv6": false,
          "flavor": {
            "vpc_count": 5,
            "eip_count": 1000,
            "total_rule_count": 20000,
            "bandwidth": 200,
            "version": 1,
            "default_log_storage": 0,
            "default_bandwidth": 50,
            "default_eip_count": 50,
            "default_vpc_count": 2,
            "session_create": 200,
            "log_storage": 0,
            "used_rule_count": 2,
            "vpc_bandwidth": 800,
            "session_concurrent": 200
          },
          "enterprise_project_id": "0",
          "service_type": 0,
          "engine_type": 1,
          "name": "1754635159172",
          "support_url_filtering": true,
          "resource_id": "a442690e-536f-4c25-991d-a5243f1baa99",
          "support_ipv6": false,
          "trust_service_status": false,
          "protect_objects": [
            {
              "object_name": "1754635159172",
              "type": 0,
              "object_id": "9d203d3d-66c8-4791-b2fd-7e94995e3dbd"
            },
            {
              "object_name": "ew-1756291745880",
              "type": 1,
              "object_id": "e4832163-5c96-495d-a505-88de848bb913",
              "status": 1
            }
          ],
          "acl_service_max_count": 5,
          "fw_instance_id": "a442690e-536f-4c25-991d-a5243f1baa99",
          "ha_type": 1,
          "status": 7,
          "is_old_firewall_instance": false
        }
      ],
      "limit": 1
    },
    "is_support_buy_professional": true
  }
}

插件执行函数listEipResources说明

函数listEipResources参数说明

函数功能：列出EIP（弹性公网IP）资源。

表29 函数listEipResources入参说明

参数名称

参数类型

参数描述

是否必填

offset

string

偏移量

是

limit

string

每页显示个数，范围为1-1024

是

object_id

string

防护对象ID

是

key_word

string

查询防护EIP列表关键字，可选用弹性公网ID和弹性公网IP

否

status

string

防护状态

null-全部 0-开启防护 1-关闭防护

否

sync

string

是否同步租户EIP数据

0-不同步 1-同步

否

enterprise_project_id

string

企业项目ID

否

device_key

string

设备关键字，是eip绑定的资产的名称或ID

否

address_type

string

地址类型

0-ipv4，1-ipv6

否

fw_instance_id

string

防火墙ID

否

fw_key_word

string

防火墙关键字，可使用防火墙ID或名称查询

否

eps_id

string

弹性公网IP的企业项目ID

否

tags

string

标签列表信息

否

resultVariable

string

用于过滤查询结果

否
表30 函数listEipResources出参说明

参数名称

参数类型

参数描述

headers

Object

接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。

code

Int

状态码，表明请求是否成功。

“code”取值示例说明：

  • “code”为“200”：表示请求成功。
  • “code”为“401”：表示账号或密码错误。
  • “code”为“403”：表示权限不足。
  • “code”为“404”：表示请求资源不存在。

body

Object

接口返回的具体内容。

函数listEipResources输出示例

{
  "headers": {
    "Transfer-Encoding": "chunked",
    "Server": "api-gateway",
    "X-Request-Id": "0d1ae2716f839c7a39ec4c52b7193a8b",
    "X-Content-Type-Options": "nosniff",
    "Connection": "keep-alive",
    "X-Download-Options": "noopen",
    "Date": "Wed, 03 Jun 2026 06:49:44 GMT",
    "X-Frame-Options": "SAMEORIGIN",
    "Strict-Transport-Security": "max-age=31536000; includeSubdomains;",
    "Cache-Control": "no-cache, no-store, max-age=0, must-revalidate",
    "X-B3-TraceId": "0d1ae2716f839c7a39ec4c52b7193a8b",
    "X-XSS-Protection": "1; mode=block;",
    "Content-Type": "application/json"
  },
  "code": 200,
  "body": {
    "data": {
      "total": 5,
      "offset": 1,
      "records": [
        {
          "public_ip": "100.93.10.149",
          "device_id": "c38ac04d-5aa7-4457-b501-dcb7962189fa",
          "associate_instance_type": "ELB",
          "fw_instance_name": "CFW-260312创建",
          "fw_enterprise_project_id": "0",
          "bypass_status": 0,
          "object_id": "58aec820-4c68-4014-b56f-4fb4396f9a82",
          "device_owner": "",
          "tags": "",
          "domain_id": "f9d7bacbfd2c49e892532ba3f62ab75d",
          "enterprise_project_id": "0",
          "device_name": "elb-8688",
          "fw_domain_id": "f9d7bacbfd2c49e892532ba3f62ab75d",
          "id": "f3d5d454-0716-4b5b-9ff4-0094eda22232",
          "status": 0,
          "fw_instance_id": "5261f821-08db-4566-9bbf-963b819f1e7d"
        }
      ],
      "limit": 1
    }
  }
}

插件执行函数listLogConfig说明

函数listLogConfig参数说明

函数功能：列出日志配置。

表31 函数listLogConfig入参说明

参数名称

参数类型

参数描述

是否必填

fwInstanceId

string

防火墙ID

是

enterpriseProjectId

string

企业项目ID

否
表32 函数listLogConfig出参说明

参数名称

参数类型

参数描述

headers

Object

接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。

code

Int

状态码，表明请求是否成功。

“code”取值示例说明：

  • “code”为“200”：表示请求成功。
  • “code”为“401”：表示账号或密码错误。
  • “code”为“403”：表示权限不足。
  • “code”为“404”：表示请求资源不存在。

body

Object

接口返回的具体内容。

函数listLogConfig输出示例

{
  "headers": {
    "Transfer-Encoding": "chunked",
    "Server": "api-gateway",
    "X-Request-Id": "c97efce461c1fbdeac58725939f6e5a9",
    "X-Content-Type-Options": "nosniff",
    "Connection": "keep-alive",
    "X-Download-Options": "noopen",
    "Date": "Wed, 03 Jun 2026 06:52:23 GMT",
    "X-Frame-Options": "SAMEORIGIN",
    "Strict-Transport-Security": "max-age=31536000; includeSubdomains;",
    "Cache-Control": "no-cache, no-store, max-age=0, must-revalidate",
    "X-B3-TraceId": "c97efce461c1fbdeac58725939f6e5a9",
    "X-XSS-Protection": "1; mode=block;",
    "Content-Type": "application/json"
  },
  "code": 200,
  "body": {
    "data": {
      "lts_enable": 0,
      "fw_instance_id": "eb20ba96-508b-4428-8900-56c1bc07034e"
    }
  }
}

插件执行函数showAlarmConfig说明

函数showAlarmConfig参数说明

函数功能：显示告警配置。

表33 函数showAlarmConfig入参说明

参数名称

参数类型

参数描述

是否必填

fw_instance_id

string

防火墙ID

是

enterprise_project_id

string

企业项目ID

否
表34 函数showAlarmConfig出参说明

参数名称

参数类型

参数描述

headers

Object

接口返回的响应结果的headers，包含请求和响应的基本信息，如请求时间、响应服务、请求Id等信息。

code

Int

状态码，表明请求是否成功。

“code”取值示例说明：

  • “code”为“200”：表示请求成功。
  • “code”为“401”：表示账号或密码错误。
  • “code”为“403”：表示权限不足。
  • “code”为“404”：表示请求资源不存在。

body

Object

接口返回的具体内容。

函数showAlarmConfig输出示例

{
  "headers": {
    "Transfer-Encoding": "chunked",
    "Server": "api-gateway",
    "X-Request-Id": "10a22e51032f8fbb4c31e2d3104d5d3e",
    "X-Content-Type-Options": "nosniff",
    "Connection": "keep-alive",
    "X-Download-Options": "noopen",
    "Date": "Wed, 03 Jun 2026 06:55:32 GMT",
    "X-Frame-Options": "SAMEORIGIN",
    "Strict-Transport-Security": "max-age=31536000; includeSubdomains;",
    "Cache-Control": "no-cache, no-store, max-age=0, must-revalidate",
    "X-B3-TraceId": "10a22e51032f8fbb4c31e2d3104d5d3e",
    "X-XSS-Protection": "1; mode=block;",
    "Content-Type": "application/json"
  },
  "code": 200,
  "body": {
    "alarm_configs": [
      {
        "enable_status": 0,
        "frequency_count": 10,
        "severity": "CRITICAL,HIGH,MEDIUM,LOW",
        "alarm_time_period": 0,
        "alarm_type": 0,
        "frequency_time": 5
      },
      {
        "enable_status": 0,
        "severity": "1",
        "alarm_time_period": 0,
        "alarm_type": 1
      },
      {
        "enable_status": 0,
        "severity": "3",
        "alarm_time_period": 0,
        "alarm_type": 2
      },
      {
        "enable_status": 0,
        "frequency_count": 10,
        "severity": "CRITICAL,HIGH,MEDIUM,LOW",
        "alarm_time_period": 0,
        "alarm_type": 3,
        "frequency_time": 5
      }
    ]
  }
}

插件执行函数operationAddressGroup说明

函数operationAddressGroup参数说明

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

表35 函数operationAddressGroup入参说明

参数名称

参数类型

参数描述

是否必填

ip_list

array

IP地址列表

是

object_id

string

防护对象ID

是

operation_type

string

操作类型：SENDING/DELETING

是

fw_instance_id

string

防火墙ID

是

enterprise_project_id

string

企业项目ID

否

address_type

string

IP地址类型

是

policy

string

应急策略类型

BLOCK-阻断、UNBLOCK-取消阻断

是

language

string

查询结果的响应语言，可取值范围：zh-cn、en-us，不支持大写，不支持其他取值。

其中zh-cn表示查询结果显示语言为简体中文；en-us表示查询结果显示语言为英语。

否

direction

string

出入方向

是

agency_type

string

多账号统一适配参数，使用默认值即可

否
表36 函数operationAddressGroup出参说明

参数名称

参数类型

参数描述

failed_targets

Array

处理地址组失败的IP列表

success_targets

Array

处理地址组成功的IP列表

函数operationAddressGroup输出示例

{
  "failed_targets": [],
  "success_targets": [
    {
      "address_group_name": "",
      "address_group_id": "",
      "target": "144.159.72.108"
    },
    {
      "address_group_name": "",
      "address_group_id": "",
      "target": "163.113.49.244"
    }
  ]
}

插件执行函数bindAddressGroup说明

函数bindAddressGroup参数说明

函数功能：绑定地址组到防护对象。

表37 函数bindAddressGroup入参说明

参数名称

参数类型

参数描述

是否必填

ip_list

array

IP地址列表

是

object_id

string

防护对象ID

是

operation_type

string

操作类型：SENDING/DELETING

是

fw_instance_id

string

防火墙ID

是

enterprise_project_id

string

企业项目ID

否

address_type

string

IP地址类型

否

policy

string

应急策略类型

BLOCK-阻断、UNBLOCK-取消阻断

是

language

string

查询结果的响应语言，可取值范围：zh-cn、en-us，不支持大写，不支持其他取值。

其中zh-cn表示查询结果显示语言为简体中文；en-us表示查询结果显示语言为英语。

否

direction

string

出入方向

否

agency_type

string

多账号统一适配参数，使用默认值即可

否
表38 函数bindAddressGroup出参说明

参数名称

参数类型

参数描述

failed_targets

Array

绑定地址组失败的IP列表

success_targets

Array

绑定地址组成功的IP列表

函数bindAddressGroup输出示例

{
  "failed_targets": [],
  "success_targets": [
    {
      "address_group_name": "",
      "address_group_id": "",
      "target": "144.159.72.108"
    },
    {
      "address_group_name": "",
      "address_group_id": "",
      "target": "163.113.49.244"
    }
  ]
}

插件执行函数operationDomainGroup说明

函数operationDomainGroup参数说明

函数功能：操作域名组，支持添加或删除域名。

表39 函数operationDomainGroup入参说明

参数名称

参数类型

参数描述

是否必填

domain_list

array

域名列表

是

fw_instance_id

string

域名组ID

是

enterprise_project_id

string

企业项目ID

否

policy

string

应急策略类型

BLOCK-阻断、UNBLOCK-取消阻断

是

operation_type

string

操作类型：SENDING/DELETING

是

object_id

string

防护对象ID

是

language

string

查询结果的响应语言，可取值范围：zh-cn、en-us，不支持大写，不支持其他取值。

其中zh-cn表示查询结果显示语言为简体中文；en-us表示查询结果显示语言为英语。

否

direction

string

出入方向

否
表40 函数operationDomainGroup出参说明

参数名称

参数类型

参数描述

failed_targets

Array

处理域名地址组失败的域名列表

success_targets

Array

处理域名地址组成功的域名列表

函数operationDomainGroup输出示例

{
  "failed_targets": [],
  "success_targets": [
    {
      "address_group_name": "SecMaster_Domain_Group_BLOCK0",
      "address_group_id": "279423f2-36de-49e4-94a1-0eb1dd494787",
      "target": "test-domain.com"
    }
  ]
}

插件执行函数bindDomainGroup说明

函数bindDomainGroup参数说明

函数功能：绑定域名组到防护对象。

表41 函数bindDomainGroup入参说明

参数名称

参数类型

参数描述

是否必填

domain_list

string

域名组ID

是

fw_instance_id

string

防护对象ID

是

enterprise_project_id

string

企业项目ID

否

operation_type

string

操作类型

可选值：SENDING-阻断、DELETING-取消阻断

否

policy

string

应急策略类型

BLOCK-阻断、UNBLOCK-取消阻断

是

object_id

string

防护对象ID

是

language

string

查询结果的响应语言，可取值范围：zh-cn、en-us，不支持大写，不支持其他取值。

其中zh-cn表示查询结果显示语言为简体中文；en-us表示查询结果显示语言为英语。

否

direction

string

出入方向

否

existing_domain_list

string

已存在的域名列表

否
表42 函数bindDomainGroup出参说明

参数名称

参数类型

参数描述

failed_targets

Array

绑定域名地址组失败的域名列表

success_targets

Array

绑定域名地址组成功的域名列表

函数bindDomainGroup输出示例

{
  "failed_targets": [],
  "success_targets": [
    {
      "address_group_name": "SecMaster_Domain_Group_BLOCK0",
      "address_group_id": "279423f2-36de-49e4-94a1-0eb1dd494787",
      "target": "test-domain.com"
    }
  ]
}