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

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

VPC

功能说明

安全云脑系统内置插件，可调用VPC（虚拟私有云）云服务接口执行操作，主要用于管理VPC、安全组、安全组规则、弹性公网IP、流日志、对等连接、网络ACL、IP地址组、端口等VPC资源。

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

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

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

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

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

插件执行函数listFlowLogs说明

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

函数listFlowLogs参数说明

函数功能：调用VPC（虚拟私有云）服务接口，查询提交请求的租户的所有流日志列表，并根据过滤条件进行过滤。

表1 函数listFlowLogs入参说明
参数名称	参数类型	参数描述	是否必填
id	String	流日志ID	否
name	String	流日志名称	否
tenantId	String	项目ID	否
description	String	流日志描述	否
resourceType	String	流日志采集的资源类型： port：单个网卡。 vpc：VPC内所有的网卡。 network：子网内所有的网卡。	否
resourceId	String	要采集的资源ID	否
trafficType	String	流日志采集类型： all：采集指定资源的全部流量。 accept：采集指定资源允许传入、传出的流量。 reject：采集指定资源拒绝传入、传出的流量。	否
logGroupId	String	日志组ID	否
logTopicId	String	日志主题ID	否
logStoreType	String	流日志存储类型： lts：存储类型为云日志服务（LTS）	否
status	String	流日志状态： ACTIVE：开启 DOWN：关闭 ERROR：异常故障	否
limit	String	分页查询每页返回的记录个数，取值范围为0~2000，默认值2000	否
marker	String	分页查询的起始资源ID，表示从指定资源的下一条记录开始查询。 marker需要和limit配合使用，为空时从第一条开始查询	否

表2 函数listFlowLogs出参说明
参数名称	参数类型	参数描述
headers	Object	接口返回的响应结果的headers。
code	Int	状态码，表明请求是否成功。 “code”取值示例说明： “code”为“200”：表示请求成功。 “code”为“401”：表示账号或密码错误。 “code”为“403”：表示权限不足。 “code”为“404”：表示请求资源不存在。
body	Object	接口返回的具体内容，包含flow_logs流日志列表

函数listFlowLogs输出示例

{
  "headers": {
    "Transfer-Encoding": "chunked",
    "Server": "api-gateway",
    "X-Request-Id": "b715be7fc3fe1c9960dc14e0e54ca021",
    "X-Content-Type-Options": "nosniff",
    "Connection": "keep-alive",
    "X-Download-Options": "noopen",
    "Date": "Wed, 03 Jun 2026 01:41:32 GMT",
    "Accept-Ranges": "bytes",
    "X-Frame-Options": "SAMEORIGIN",
    "Strict-Transport-Security": "max-age=31536000; includeSubdomains;",
    "Vary": "Accept-Charset, Accept-Encoding, Accept-Language, Accept",
    "X-XSS-Protection": "1; mode=block;",
    "Content-Type": "application/json"
  },
  "code": 200,
  "body": {
    "flow_logs": [
      {
        "id": "35868d55-443e-xxxx-90a4-ac618dc45c1a",
        "name": "flowlog",
        "description": "just a test",
        "tenant_id": "b2782e6708xxxxxx993e6064bc456bf8",
        "resource_type": "port",
        "resource_id": "05c4052d-8d14-xxxx-aa00-19fea5a25fde",
        "traffic_type": "reject",
        "log_group_id": "05c4052d-8d14-xxxx-aa00-19fea5a25fff",
        "log_topic_id": "a9d7dee7-37d2-xxxx-a208-a016252aaa63",
        "log_store_type": "lts",
        "created_at": "2019-01-14T11:03:02",
        "updated_at": "2019-01-14T11:03:02",
        "status": "ACTIVE",
        "admin_state": true
      }
    ]
  }
}

插件执行函数listSecurityGroupRules说明

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

函数listSecurityGroupRules参数说明

函数功能：调用VPC（虚拟私有云）服务接口，查询所有安全组规则信息，包括安全组规则ID、协议类型等。

表3 函数listSecurityGroupRules入参说明
参数名称	参数类型	参数描述	是否必填
id	Array	安全组规则的资源ID列表，支持多个ID过滤	否
description	String	安全组规则描述	否
limit	Int	分页查询每页返回的记录个数，取值范围为0~2000，默认值2000	否
marker	String	分页查询的起始资源ID，表示从指定资源的下一条记录开始查询。 marker需要和limit配合使用，为空时从第一条开始查询	否
protocol	Array	安全组规则的通信协议类型列表，支持多条过滤	否
remoteGroupId	Array	安全组规则的远端安全组ID列表，支持多ID过滤	否
direction	String	安全组规则的出入控制方向： ingress：表示入方向 egress：表示出方向	否
action	String	安全组规则的生效策略： allow：表示允许 deny：表示拒绝	否
securityGroupId	Array	安全组规则所属安全组的列表，支持多个ID过滤	否
remoteIpPrefix	String	安全组规则的远端IP地址，cidr格式	否
resultVariable	Object	出参过滤参数，{"新的字段名称1"："$(代表原全量返回参数).xxx(全量返回参数的下一级)或{xxx1，xxx2}",{"新的字段名称2"：...}...},例：{"alert_id"："$.body.data.id"} 或者{"alert"："$.body.data{id,name}"}	否

表4 函数listSecurityGroupRules出参说明
参数名称	参数类型	参数描述
headers	Object	接口返回的响应结果的headers。
code	Int	状态码，表明请求是否成功。 “code”取值示例说明： “code”为“200”：表示请求成功。 “code”为“401”：表示账号或密码错误。 “code”为“403”：表示权限不足。 “code”为“404”：表示请求资源不存在。
body	Object	接口返回的具体内容，包含security_group_rules安全组规则列表和page_info分页信息

函数listSecurityGroupRules输出示例

{
  "headers": {
    "Server": "api-gateway",
    "X-Request-Id": "a5d39ad8ac096a7a920d1242a019eac6",
    "X-Content-Type-Options": "nosniff",
    "Connection": "keep-alive",
    "X-Download-Options": "noopen",
    "Date": "Wed, 03 Jun 2026 01:51:42 GMT",
    "X-Handler-Trace": "C->Q",
    "X-Frame-Options": "SAMEORIGIN",
    "Strict-Transport-Security": "max-age=31536000; includeSubdomains;",
    "X-Openstack-Request-Id": "Req-a5d39ad8ac096a7a920d1242a019eac6",
    "Content-Length": "163796",
    "X-XSS-Protection": "1; mode=block;",
    "Content-Type": "application/json; charset=utf-8"
  },
  "code": 200,
  "body": {
    "page_info": {
      "current_count": 325,
      "previous_marker": "00dd26f1-1603-4ed8-8b50-217ce428915c"
    },
    "request_id": "a5d39ad8ac096a7a920d1242a019eac6",
    "security_group_rules": [
      {
        "id": "f626eb24-d8bd-4d26-xxxx-c16bb65730cb",
        "project_id": "06057678298xxxx2f9ec014dd2f1148",
        "security_group_id": "0552091e-xxxx-49dd-88a7-4a5c86fd9ec3",
        "direction": "ingress",
        "protocol": "tcp",
        "description": "security group rule description",
        "created_at": "2020-08-13T07:12:36.000+00:00",
        "updated_at": "2020-08-13T07:12:36.000+00:00",
        "ethertype": "IPv4",
        "remote_ip_prefix": "10.x.x.0/16",
        "multiport": 333,
        "action": "allow",
        "priority": 1,
        "remote_group_id": null,
        "remote_address_group_id": null,
        "enabled": true
      }
    ]
  }
}

插件执行函数listPublicips说明

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

函数listPublicips参数说明

函数功能：调用EIP（弹性公网ip）服务，查询弹性公网IP列表信息。

表5 函数listPublicips入参说明
参数名称	参数类型	参数描述	是否必填
id	Array	弹性公网ip的ID列表，支持多个ID过滤	否
description	String	弹性公网ip描述	否
offset	Int	分页查询起始的资源序号	否
limit	Int	分页查询每页返回的记录个数，取值范围为0~2000，默认值2000	否
marker	String	分页查询的起始资源ID，表示从指定资源的下一条记录开始查询。 marker需要和limit配合使用，为空时从第一条开始查询	否
sort_key	String	排序字段： id public_ip_address public_ipv6_address ip_version created_at updated_at public_border_group	否
sort_dir	String	排序方向： asc：顺序排序 desc：逆序排序	否
ip_version	Int	根据ip_version过滤： 4：ipv4 6：ipv6	否
public_ip_address	Array	根据public_ip_address过滤，支持多个值过滤	否
public_ip_address_like	String	根据public_ip_address过滤，模糊查询	否
public_ipv6_address	Array	根据public_ipv6_address过滤，支持多个值过滤	否
public_ipv6_address_like	String	根据public_ipv6_address过滤，模糊查询	否
type	Array	根据type过滤： EIP: 弹性公网IP DUALSTACK: 双栈IPV6	否
network_type	Array	根据network_type过滤： 5_telcom 5_union 5_bgp 5_sbgp 5_ipv6 5_graybgp	否
publicip_pool_name	Array	根据publicip_pool_name过滤：取值范围：5_telcom、5_union、5_bgp、5_sbgp、5_ipv6、5_graybgp、专属池名称等	否
status	Array	根据status过滤： FREEZED DOWN ACTIVE ERROR	否
alias_like	String	根据alias模糊搜索	否
alias	Array	根据alias过滤	否
description	Array	根据description过滤	否
vnic.private_ip_address	Array	根据private_ip_address过滤	否
vnic.private_ip_address_like	String	根据private_ip_address模糊搜索	否
vnic.device_id	Array	根据device_id过滤	否
vnic.device_owner	Array	根据device_owner过滤	否
vnic.vpc_id	Array	根据vpc_id过滤	否
vnic.port_id	Array	根据port_id过滤	否
vnic.device_owner_prefixlike	String	根据device_owner_prefixlike模糊搜索	否
vnic.instance_type	Array	根据instance_type过滤	否
vnic.instance_id	Array	根据instance_id过滤	否
bandwidth.id	Array	根据id过滤	否
bandwidth.name	Array	根据name过滤	否
bandwidth.name_like	String	根据name模糊过滤	否
bandwidth.size	Array	根据size过滤	否
bandwidth.share_type	Array	根据share_type过滤： PER WHOLE	否
bandwidth.charge_mode	Array	根据charge_mode过滤： bandwidth traffic 95peak_plus	否
billing_info	Array	根据billing_info过滤	否
billing_mode	String	根据订单模式过滤： YEARLY_MONTHLY PAY_PER_USE	否
associate_instance_type	Array	根据associate_instance_type过滤： PORT NATGW ELB VPN ELBV1	否
associate_instance_id	Array	根据associate_instance_id过滤	否
enterprise_project_id	Array	根据enterprise_project_id过滤	否
public_border_group	Array	根据public_border_group过滤	否
allow_share_bandwidth_type_any	Array	共享带宽类型，根据任一共享带宽类型过滤EIP列表。可以指定多个带宽类型，不同的带宽类型间用逗号分隔。	否

表6 函数listPublicips出参说明
参数名称	参数类型	参数描述
headers	Object	接口返回的响应结果的headers。
code	Int	状态码，表明请求是否成功。 “code”取值示例说明： “code”为“200”：表示请求成功。 “code”为“401”：表示账号或密码错误。 “code”为“403”：表示权限不足。 “code”为“404”：表示请求资源不存在。
body	Object	接口返回的具体内容，包含publicips弹性公网IP列表、page_info分页信息、total_count总数

函数listPublicips输出示例

{
  "headers": {
    "Server": "api-gateway",
    "X-Request-Id": "e341d8f30baa16119701ddf2aa4e5f12",
    "X-Content-Type-Options": "nosniff",
    "Connection": "keep-alive",
    "X-Download-Options": "noopen",
    "Date": "Wed, 03 Jun 2026 02:05:08 GMT",
    "X-Handler-Trace": "C->Q",
    "X-Frame-Options": "SAMEORIGIN",
    "Strict-Transport-Security": "max-age=31536000; includeSubdomains;",
    "X-Openstack-Request-Id": "Req-e341d8f30baa16119701ddf2aa4e5f12",
    "Content-Length": "6029",
    "X-XSS-Protection": "1; mode=block;",
    "Content-Type": "application/json; charset=utf-8"
  },
  "code": 200,
  "body": {
    "total_count": 1,
    "page_info": {
      "current_count": 1,
      "previous_marker": "0a88e7b4-53fd-4dbb-8875-4d8bbe6fa7ac"
    },
    "request_id": "e341d8f30baa16119701ddf2aa4e5f12",
    "publicips": [
      {
        "public_ip_address": "215.252.12.244",
        "associate_instance_type": "PORT",
        "vnic": {
          "port_vif_details": "{\"primary_interface\":true}",
          "instance_id": "",
          "device_id": "25c4a8d9-9b08-442e-883c-399eaec39847",
          "vpc_id": "316a461f-8219-498e-84cc-726d0ffe8976",
          "port_id": "37a55739-a847-4577-8ff6-38bbb5158d9e",
          "private_ip_address": "192.168.0.97",
          "instance_type": "",
          "device_owner": "compute:cn-north-7c",
          "mac": "fa:16:3e:1e:76:d7"
        },
        "bandwidth": {
          "billing_info": "",
          "size": 10,
          "share_type": "PER",
          "name": "ecs-secmaster-z60114071-bandwidth-f517",
          "charge_mode": "traffic",
          "id": "efa99393-192c-4128-9d21-905de88729e5"
        },
        "created_at": "2026-05-15T02:45:12Z",
        "publicip_pool_id": "8a425166-82ac-4163-94d5-e6913579e7e7",
        "associate_instance_id": "37a55739-a847-4577-8ff6-38bbb5158d9e",
        "type": "EIP",
        "tags": [],
        "enterprise_project_id": "0",
        "publicip_pool_name": "5_g-vm",
        "updated_at": "2026-05-15T02:45:12Z",
        "ip_version": 4,
        "project_id": "f69081793d9e4ea8a2f479dcef961989",
        "allow_share_bandwidth_types": [
          "share",
          "share_bgp_ext",
          "testshare"
        ],
        "id": "0a88e7b4-53fd-4dbb-8875-4d8bbe6fa7ac",
        "public_border_group": "center",
        "status": "ACTIVE"
      }
    ]
  }
}

插件执行函数deleteSecurityGroupRule说明

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

函数deleteSecurityGroupRule参数说明

函数功能：调用VPC（虚拟私有云）服务接口，已创建的安全组规则不再使用时，可通过调用该接口删除安全组规则资源。

表7 函数deleteSecurityGroupRule入参说明
参数名称	参数类型	参数描述	是否必填
securityGroupRuleId	String	需要删除的安全组规则id	是
agency_type	String	多账号统一适配参数，使用默认值即可	否

表8 函数deleteSecurityGroupRule出参说明
参数名称	参数类型	参数描述
headers	Object	接口返回的响应结果的headers。
code	Int	状态码，表明请求是否成功。 “code”取值示例说明： “code”为“200”：表示请求成功。 “code”为“401”：表示账号或密码错误。 “code”为“403”：表示权限不足。 “code”为“404”：表示请求资源不存在。
body	Object	接口返回的具体内容，删除操作无响应体。

函数deleteSecurityGroupRule输出示例

{
  "headers": {
    "Accept-Ranges": "bytes",
    "X-Frame-Options": "SAMEORIGIN",
    "Strict-Transport-Security": "max-age=31536000; includeSubdomains;",
    "Server": "api-gateway",
    "X-Request-Id": "3dca9828e35bf051b99babff33462981",
    "X-Content-Type-Options": "nosniff",
    "Connection": "keep-alive",
    "X-Download-Options": "noopen",
    "Vary": "Accept-Charset, Accept-Encoding, Accept-Language, Accept",
    "X-XSS-Protection": "1; mode=block;",
    "Date": "Fri, 05 Jun 2026 06:50:09 GMT",
    "Content-Type": "application/json"
  },
  "code": 204,
  "body": "success"
}

插件执行函数createSecurityGroup说明

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

函数createSecurityGroup参数说明

函数功能：调用VPC（虚拟私有云）服务接口，通过VPC（虚拟私有云）服务接口，创建安全组。

表9 函数createSecurityGroup入参说明
参数名称	参数类型	参数描述	是否必填
dryRun	Boolean	是否只预检此次请求，true：发送检查请求不会创建安全组，false：发送正常请求直接创建安全组，默认值：false	否
name	String	安全组名称，1-64个字符，支持数字、字母、中文、_（下划线）、-（中划线）、.（点）	是
description	String	安全组描述，0-255个字符，不能包含"<"和">"	否
enterpriseProjectId	String	企业项目ID，最大长度36字节，带"-"连字符的UUID格式，或者是字符串"0"	否
agency_type	String	多账号统一适配参数，使用默认值即可	否

**表10** 函数createSecurityGroup出参说明
参数名称	参数类型	参数描述
headers	Object	接口返回的响应结果的headers。
code	Int	状态码，表明请求是否成功。 “code”取值示例说明： “code”为“200”：表示请求成功。 “code”为“401”：表示账号或密码错误。 “code”为“403”：表示权限不足。 “code”为“404”：表示请求资源不存在。
body	Object	接口返回的具体内容，包含security_group安全组对象

函数createSecurityGroup输出示例

{
  "headers": {
    "Server": "api-gateway",
    "X-Request-Id": "4a04a7195f3f097db0eb9995cb465721",
    "X-Content-Type-Options": "nosniff",
    "Connection": "keep-alive",
    "X-Download-Options": "noopen",
    "Date": "Fri, 05 Jun 2026 06:52:36 GMT",
    "X-Handler-Trace": "C->Q",
    "X-Frame-Options": "SAMEORIGIN",
    "Strict-Transport-Security": "max-age=31536000; includeSubdomains;",
    "X-Openstack-Request-Id": "Req-4a04a7195f3f097db0eb9995cb465721",
    "Content-Length": "2156",
    "X-XSS-Protection": "1; mode=block;",
    "Content-Type": "application/json; charset=utf-8"
  },
  "code": 201,
  "body": {
    "security_group": {
      "enterprise_project_id": "0",
      "updated_at": "2026-06-05T06:52:36Z",
      "project_id": "f8ae07d4148f4e418c5fe15833f6b105",
      "name": "test",
      "description": "",
      "created_at": "2026-06-05T06:52:36Z",
      "id": "381f726c-6225-47c1-ac06-54381e711c35",
      "security_group_rules": [
        {
          "updated_at": "2026-06-05T06:52:36Z",
          "project_id": "f8ae07d4148f4e418c5fe15833f6b105",
          "ethertype": "IPv6",
          "security_group_id": "381f726c-6225-47c1-ac06-54381e711c35",
          "description": "",
          "created_at": "2026-06-05T06:52:36Z",
          "action": "allow",
          "id": "3b23a1af-520e-4d86-97a7-2d446d00587f",
          "priority": 100,
          "enabled": true,
          "direction": "egress"
        },
        {
          "updated_at": "2026-06-05T06:52:36Z",
          "project_id": "f8ae07d4148f4e418c5fe15833f6b105",
          "ethertype": "IPv4",
          "security_group_id": "381f726c-6225-47c1-ac06-54381e711c35",
          "description": "",
          "created_at": "2026-06-05T06:52:36Z",
          "action": "allow",
          "id": "de0036a8-8d2c-4a62-9735-2433179f4a72",
          "priority": 100,
          "enabled": true,
          "direction": "egress"
        },
        {
          "remote_group_id": "381f726c-6225-47c1-ac06-54381e711c35",
          "updated_at": "2026-06-05T06:52:36Z",
          "project_id": "f8ae07d4148f4e418c5fe15833f6b105",
          "ethertype": "IPv6",
          "security_group_id": "381f726c-6225-47c1-ac06-54381e711c35",
          "description": "",
          "created_at": "2026-06-05T06:52:36Z",
          "action": "allow",
          "id": "314498ae-8f54-419f-8f2a-93c9674fb936",
          "priority": 100,
          "enabled": true,
          "direction": "ingress"
        },
        {
          "remote_group_id": "381f726c-6225-47c1-ac06-54381e711c35",
          "updated_at": "2026-06-05T06:52:36Z",
          "project_id": "f8ae07d4148f4e418c5fe15833f6b105",
          "ethertype": "IPv4",
          "security_group_id": "381f726c-6225-47c1-ac06-54381e711c35",
          "description": "",
          "created_at": "2026-06-05T06:52:36Z",
          "action": "allow",
          "id": "4bb21d10-8083-47a7-a9ac-854692462fac",
          "priority": 100,
          "enabled": true,
          "direction": "ingress"
        }
      ],
      "tags": []
    },
    "request_id": "4a04a7195f3f097db0eb9995cb465721"
  }
}

插件执行函数createSecurityGroupRule说明

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

函数createSecurityGroupRule参数说明

函数功能：通过VPC（虚拟私有云）服务接口，创建安全组规则。

**表11** 函数createSecurityGroupRule入参说明
参数名称	参数类型	参数描述	是否必填
dryRun	Boolean	是否只预检此次请求，true：发送检查请求不会创建规则，false：发送正常请求直接创建规则，默认值：false	否
securityGroupId	String	安全组规则所属的安全组ID	是
description	String	安全组规则描述，0-255个字符，不能包含"<"和">"	否
direction	String	安全组规则的出入控制方向，取值：ingress（入方向）、egress（出方向）	是
ethertype	String	IP地址协议类型，取值：IPv4、IPv6	否
protocol	String	通信协议类型，取值：icmp、tcp、udp、icmpv6、IP协议号	否
multiport	String	端口取值范围，支持单端口(80)、连续端口(1-30)、不连续端口(22,3389,80)	否
remoteIpPrefix	String	远端IP地址，cidr格式，如192.168.0.0/16	否
remoteGroupId	String	远端安全组ID	否
remoteAddressGroupId	String	远端地址组ID	否
action	String	生效策略，取值：allow（允许）、deny（拒绝）	否
priority	Integer	生效优先级，1~100，1代表最高优先级	否
agency_type	String	多账号统一适配参数，使用默认值即可	否

**表12** 函数createSecurityGroupRule出参说明
参数名称	参数类型	参数描述
headers	Object	接口返回的响应结果的headers。
code	Int	状态码，表明请求是否成功。 “code”取值示例说明： “code”为“200”：表示请求成功。 “code”为“401”：表示账号或密码错误。 “code”为“403”：表示权限不足。 “code”为“404”：表示请求资源不存在。
body	Object	接口返回的具体内容，包含security_group_rule安全组规则对象

函数createSecurityGroupRule输出示例

{
  "headers": {
    "Content-Type": "application/json",
    "X-Request-Id": "b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7",
    "Connection": "keep-alive",
    "Date": "Wed, 03 Jun 2026 03:10:00 GMT",
    "Server": "api-gateway"
  },
  "code": 201,
  "body": {
    "security_group_rule": {
      "id": "f626eb24-d8bd-4d26-ae0b-c16bb65730cb",
      "description": "security group rule description",
      "security_group_id": "0552091e-b83a-49dd-88a7-4a5c86fd9ec3",
      "direction": "ingress",
      "protocol": "tcp",
      "ethertype": "IPv4",
      "multiport": "33",
      "remote_ip_prefix": "10.10.0.0/16",
      "action": "allow",
      "priority": 1,
      "remote_group_id": null,
      "remote_address_group_id": null,
      "created_at": "2026-06-03T03:10:00.000+00:00",
      "updated_at": "2026-06-03T03:10:00.000+00:00",
      "project_id": "060576782980d5762f9ec014dd2f1148",
      "enabled": true
    }
  }
}

插件执行函数listAddressGroup说明

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

函数listAddressGroup参数说明

函数功能：通过VPC（虚拟私有云）服务接口，查询所有IP地址组信息，包括IP地址组的名称、包含的IP地址等。

**表13** 函数listAddressGroup入参说明
参数名称	参数类型	参数描述	是否必填
limit	Integer	每页返回的资源个数，取值范围0-2000	否
marker	String	分页查询起始的资源ID，为空时查询第一页	否
address_id	Array of strings	IP地址组ID，支持传入多个ID过滤	否
name	Array of strings	IP地址组名称，支持传入多个名称过滤	否
ip_version	Integer	IP地址组版本，取值：4（IPv4）、6（IPv6）	否
description	Array of strings	IP地址组描述，支持传入多个描述过滤	否
enterprise_project_id	String	企业项目ID，最大长度36字节，带"-"连字符的UUID格式，或者是字符串"0"	否

**表14** 函数listAddressGroup出参说明
参数名称	参数类型	参数描述
headers	Object	接口返回的响应结果的headers。
code	Int	状态码，表明请求是否成功。 “code”取值示例说明： “code”为“200”：表示请求成功。 “code”为“401”：表示账号或密码错误。 “code”为“403”：表示权限不足。 “code”为“404”：表示请求资源不存在。
body	Object	接口返回的具体内容，包含address_groups地址组列表和page_info分页信息

函数listAddressGroup输出示例

{
  "headers": {
    "Content-Type": "application/json",
    "X-Request-Id": "c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8",
    "Connection": "keep-alive",
    "Date": "Wed, 03 Jun 2026 03:20:00 GMT",
    "Server": "api-gateway"
  },
  "code": 200,
  "body": {
    "address_groups": [
      {
        "id": "dd6a0c79-5e48-4e5d-9c1b-84b0a5c6e7d8",
        "name": "SecMaster_Group_IPv4_INGRESS_BLOCK0",
        "description": "SecMaster Automatic Blocking",
        "ip_version": 4,
        "ip_set": [
          "192.168.1.1",
          "192.168.1.2"
        ],
        "enterprise_project_id": "0"
      }
    ],
    "request_id": "c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8",
    "page_info": {
      "previous_marker": "dd6a0c79-5e48-4e5d-9c1b-84b0a5c6e7d8",
      "current_count": 1
    }
  }
}

插件执行函数listFirewall说明

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

函数listFirewall参数说明

函数功能：通过VPC（虚拟私有云）服务接口，查询网络ACL列表。

**表15** 函数listFirewall入参说明
参数名称	参数类型	参数描述	是否必填
limit	Integer	每页返回的资源个数，取值范围0-2000	否
marker	String	分页查询起始的资源ID，为空时查询第一页	否
id	Array of strings	网络ACL ID，支持传入多个ID过滤	否
name	Array of strings	网络ACL名称，支持传入多个名称过滤	否
enterprise_project_id	String	企业项目ID	否
status	String	网络ACL状态	否
admin_state_up	Boolean	管理状态，true表示启用，false表示停用	否
resultVariable	String	用于过滤查询结果	否

**表16** 函数listFirewall出参说明
参数名称	参数类型	参数描述
headers	Object	接口返回的响应结果的headers。
code	Int	状态码，表明请求是否成功。 “code”取值示例说明： “code”为“200”：表示请求成功。 “code”为“401”：表示账号或密码错误。 “code”为“403”：表示权限不足。 “code”为“404”：表示请求资源不存在。
body	Object	接口返回的具体内容，包含firewalls网络ACL列表和page_info分页信息

函数listFirewall输出示例

{
  "headers": {
    "Content-Type": "application/json",
    "X-Request-Id": "d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9",
    "Connection": "keep-alive",
    "Date": "Wed, 03 Jun 2026 03:30:00 GMT",
    "Server": "api-gateway"
  },
  "code": 200,
  "body": {
    "firewalls": [
      {
        "id": "f78a0c79-5e48-4e5d-9c1b-84b0a5c6e7d8",
        "name": "firewall-test",
        "description": "测试网络ACL",
        "status": "ACTIVE",
        "admin_state_up": true,
        "enterprise_project_id": "0"
      }
    ],
    "request_id": "d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9",
    "page_info": {
      "previous_marker": "f78a0c79-5e48-4e5d-9c1b-84b0a5c6e7d8",
      "current_count": 1
    }
  }
}

插件执行函数listSecurityGroups说明

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

函数listSecurityGroups参数说明

函数功能：通过VPC（虚拟私有云）服务接口，查询所有安全组信息，包括安全组名称、ID、描述等。单次查询最多返回2000条数据，超过2000后会返回分页标记。

**表17** 函数listSecurityGroups入参说明
参数名称	参数类型	参数描述	是否必填
limit	Integer	每页返回的资源个数，取值范围0-2000	否
marker	String	分页查询起始的资源ID，为空时查询第一页	否
enterpriseProjectId	String	企业项目ID，最大长度36字节，带"-"连字符的UUID格式，或者是字符串"0"。若需要查询所有有权限查看的安全组，请传参all_granted_eps	否
vpcId	Array of strings	安全组所属的VPC ID	否

**表18** 函数listSecurityGroups出参说明
参数名称	参数类型	参数描述
headers	Object	接口返回的响应结果的headers。
code	Int	状态码，表明请求是否成功。 “code”取值示例说明： “code”为“200”：表示请求成功。 “code”为“401”：表示账号或密码错误。 “code”为“403”：表示权限不足。 “code”为“404”：表示请求资源不存在。
body	Object	接口返回的具体内容，包含security_groups安全组列表和page_info分页信息

函数listSecurityGroups输出示例

{
  "headers": {
    "Server": "api-gateway",
    "X-Request-Id": "55f74ba6e6691be7b3f64b54539b5325",
    "X-Content-Type-Options": "nosniff",
    "Connection": "keep-alive",
    "X-Download-Options": "noopen",
    "Date": "Fri, 05 Jun 2026 07:14:15 GMT",
    "X-Handler-Trace": "C->Q",
    "X-Frame-Options": "SAMEORIGIN",
    "Strict-Transport-Security": "max-age=31536000; includeSubdomains;",
    "X-Openstack-Request-Id": "Req-55f74ba6e6691be7b3f64b54539b5325",
    "Content-Length": "11630",
    "X-XSS-Protection": "1; mode=block;",
    "Content-Type": "application/json; charset=utf-8"
  },
  "code": 200,
  "body": {
    "security_groups": [
      {
        "enterprise_project_id": "0",
        "updated_at": "2025-08-18T11:35:52Z",
        "project_id": "099706f4090026a62f0bc014b68c0527",
        "name": "test495011-cce-node-mdssd",
        "description": "The security group is created by CCE cluster 7db9da55-7c27-11f0-8e7a-0255ac10024a for the node",
        "created_at": "2025-08-18T11:35:52Z",
        "id": "3be73caa-519f-4168-b97f-4f98d937e8f6",
        "tags": []
      },
      {
        "enterprise_project_id": "0",
        "updated_at": "2023-07-19T02:34:45Z",
        "project_id": "099706f4090026a62f0bc014b68c0527",
        "name": "SecMaster",
        "description": "您可以勾选常见协议端口，在入方向快速添加规则放通对应的协议及端口。若您未勾选任何协议端口，则不会放通任何端口。您可在安全组创建后，根据实际访问需求添加或修改安全组规则。",
        "created_at": "2023-07-19T02:34:45Z",
        "id": "4950081a-f0a4-4c19-8aac-1d8168197828",
        "tags": []
      },
      {
        "enterprise_project_id": "b5566e6a-7b7e-4629-8b2f-75108ee8214b",
        "updated_at": "2023-09-13T06:11:23Z",
        "project_id": "099706f4090026a62f0bc014b68c0527",
        "name": "Sys-WebServer",
        "description": "",
        "created_at": "2023-09-13T06:11:23Z",
        "id": "65fad4c2-1a81-47e1-a01f-5e2286177bbc",
        "tags": []
      },
      {
        "enterprise_project_id": "0",
        "updated_at": "2020-08-11T02:55:52Z",
        "project_id": "099706f4090026a62f0bc014b68c0527",
        "name": "mrd-10086",
        "description": "入方向不放通任何端口，您可在安全组创建后，根据实际访问需求添加或修改安全组规则。",
        "created_at": "2020-08-11T02:55:52Z",
        "id": "71385f85-ff57-46c4-b94d-5218ef515081",
        "tags": []
      },
      {
        "enterprise_project_id": "0",
        "updated_at": "2023-09-06T07:33:56Z",
        "project_id": "099706f4090026a62f0bc014b68c0527",
        "name": "SecMaster_主机一键隔离",
        "description": "安全云脑自动创建安全组",
        "created_at": "2023-09-06T07:33:56Z",
        "id": "73f39739-b23d-429d-9e60-23d68aad3008",
        "tags": []
      },
      {
        "enterprise_project_id": "0",
        "updated_at": "2022-09-23T10:10:34Z",
        "project_id": "099706f4090026a62f0bc014b68c0527",
        "name": "CSB",
        "description": "入方向不放通任何端口，您可在安全组创建后，根据实际访问需求添加或修改安全组规则。",
        "created_at": "2022-09-23T10:10:34Z",
        "id": "a7c4649c-4a64-4611-828c-a44aa5158d87",
        "tags": []
      },
      {
        "enterprise_project_id": "0",
        "updated_at": "2023-10-10T03:49:56Z",
        "project_id": "099706f4090026a62f0bc014b68c0527",
        "name": "all",
        "description": "开放全部端口有一定安全风险，请谨慎选择。",
        "created_at": "2023-10-10T03:49:56Z",
        "id": "ab58944d-5475-450b-afd5-bff11b7fd8a9",
        "tags": []
      },
      {
        "enterprise_project_id": "f5cd2ecb-7e77-4c6e-8836-105b47e05771",
        "updated_at": "2024-11-21T09:10:19Z",
        "project_id": "099706f4090026a62f0bc014b68c0527",
        "name": "sg-1fb0",
        "description": "",
        "created_at": "2024-11-21T09:10:19Z",
        "id": "b2ee13ce-1bc4-49a5-819c-323bc099776d",
        "tags": []
      }
    ],
    "page_info": {
      "current_count": 8,
      "previous_marker": "06b553e2-02c1-4eb9-b621-993251c681b9"
    },
    "request_id": "55f74ba6e6691be7b3f64b54539b5325"
  }
}

插件执行函数listVpcPeerings说明

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

函数listVpcPeerings参数说明

函数功能：通过VPC（虚拟私有云）服务接口，查询提交请求的租户的所有对等连接。根据过滤条件进行过滤。

**表19** 函数listVpcPeerings入参说明
参数名称	参数类型	参数描述	是否必填
limit	Integer	分页查询每页返回的记录个数，取值范围0~2000，默认值2000	否
marker	String	分页查询的起始资源ID，表示从指定资源的下一条记录开始查询	否
id	String	按照peering_id过滤查询	否
name	String	按照peering_name过滤查询，最大长度不超过64	否
status	String	按照status进行过滤，取值：PENDING_ACCEPTANCE（等待接受）、REJECTED（已拒绝）、EXPIRED（已过期）、DELETED（已删除）、ACTIVE（活动的）	否
tenant_id	String	按照tenant_id过滤查询	否
vpc_id	String	按照vpc_id过滤查询	否
resultVariable	String	用于过滤查询结果	否

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

函数listVpcPeerings输出示例

{
  "headers": {
    "Content-Type": "application/json",
    "X-Request-Id": "f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1",
    "Connection": "keep-alive",
    "Date": "Wed, 03 Jun 2026 03:50:00 GMT",
    "Server": "api-gateway"
  },
  "code": 200,
  "body": {
    "peerings": [
      {
        "request_vpc_info": {
          "vpc_id": "9daeac7c-a98f-430f-8e38-67f9c044e299",
          "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e"
        },
        "accept_vpc_info": {
          "vpc_id": "f583c072-0bb8-4e19-afb2-afb7c1693be5",
          "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e"
        },
        "name": "test",
        "description": "test",
        "id": "b147a74b-39bb-4c7a-aed5-19cac4c2df13",
        "status": "ACTIVE"
      }
    ]
  }
}

插件执行函数listVpcs说明

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

函数listVpcs参数说明

函数功能：通过VPC（虚拟私有云）服务接口，查询VPC列表。

**表21** 函数listVpcs入参说明
参数名称	参数类型	参数描述	是否必填
limit	Integer	每页返回的资源个数，取值范围0-2000	否
marker	String	分页查询起始的资源ID，为空时查询第一页	否
id	Array of strings	VPC资源ID，支持传入多个ID过滤	否

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

函数listVpcs输出示例

{
  "headers": {
    "Content-Type": "application/json",
    "X-Request-Id": "a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2",
    "Connection": "keep-alive",
    "Date": "Wed, 03 Jun 2026 04:00:00 GMT",
    "Server": "api-gateway"
  },
  "code": 200,
  "body": {
    "vpcs": [
      {
        "id": "0552091e-b83a-49dd-88a7-4a5c86fd9ec3",
        "name": "vpc-test",
        "description": "测试VPC",
        "cidr": "192.168.0.0/16",
        "status": "ACTIVE",
        "project_id": "060576782980d5762f9ec014dd2f1148",
        "enterprise_project_id": "0",
        "created_at": "2026-01-01T00:00:00.000+00:00",
        "updated_at": "2026-01-01T00:00:00.000+00:00",
        "tags": []
      }
    ],
    "request_id": "a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2",
    "page_info": {
      "previous_marker": "0552091e-b83a-49dd-88a7-4a5c86fd9ec3",
      "current_count": 1
    }
  }
}

插件执行函数showFirewall说明

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

函数showFirewall参数说明

函数功能：通过VPC（虚拟私有云）服务接口，查询单个网络ACL的详细信息，包括网络ACL的名称、状态等。

**表23** 函数showFirewall入参说明
参数名称	参数类型	参数描述	是否必填
firewall_id	String	网络ACL的资源ID，可先通过查询网络ACL列表API获取目标网络ACL的ID	是

**表24** 函数showFirewall出参说明
参数名称	参数类型	参数描述
headers	Object	接口返回的响应结果的headers。
code	Int	状态码，表明请求是否成功。 “code”取值示例说明： “code”为“200”：表示请求成功。 “code”为“401”：表示账号或密码错误。 “code”为“403”：表示权限不足。 “code”为“404”：表示请求资源不存在。
body	Object	接口返回的具体内容，包含firewall网络ACL对象

函数showFirewall输出示例

{
  "headers": {
    "Content-Type": "application/json",
    "X-Request-Id": "b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3",
    "Connection": "keep-alive",
    "Date": "Wed, 03 Jun 2026 04:10:00 GMT",
    "Server": "api-gateway"
  },
  "code": 200,
  "body": {
    "firewall": {
      "id": "f78a0c79-5e48-4e5d-9c1b-84b0a5c6e7d8",
      "name": "firewall-test",
      "description": "测试网络ACL",
      "status": "ACTIVE",
      "admin_state_up": true,
      "enterprise_project_id": "0",
      "ingress_rules": [],
      "egress_rules": []
    },
    "request_id": "b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3"
  }
}

插件执行函数showSecurityGroup说明

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

函数showSecurityGroup参数说明

函数功能：通过VPC（虚拟私有云）服务接口，查询单个安全组的详细信息，包括安全组名称、ID、描述等。

**表25** 函数showSecurityGroup入参说明
参数名称	参数类型	参数描述	是否必填
securityGroupId	String	安全组资源ID	是

**表26** 函数showSecurityGroup出参说明
参数名称	参数类型	参数描述
headers	Object	接口返回的响应结果的headers。
code	Int	状态码，表明请求是否成功。 “code”取值示例说明： “code”为“200”：表示请求成功。 “code”为“401”：表示账号或密码错误。 “code”为“403”：表示权限不足。 “code”为“404”：表示请求资源不存在。
body	Object	接口返回的具体内容，包含security_group安全组对象及security_group_rules规则列表

函数showSecurityGroup输出示例

{
  "headers": {
    "Content-Type": "application/json",
    "X-Request-Id": "c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4",
    "Connection": "keep-alive",
    "Date": "Wed, 03 Jun 2026 04:20:00 GMT",
    "Server": "api-gateway"
  },
  "code": 200,
  "body": {
    "security_group": {
      "id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325",
      "name": "security_group_1",
      "project_id": "060576782980d5762f9ec014dd2f1148",
      "description": "security group description",
      "enterprise_project_id": "0",
      "created_at": "2026-06-03T04:20:00.000+00:00",
      "updated_at": "2026-06-03T04:20:00.000+00:00",
      "tags": [],
      "security_group_rules": [
        {
          "id": "f626eb24-d8bd-4d26-ae0b-c16bb65730cb",
          "direction": "ingress",
          "protocol": "tcp",
          "ethertype": "IPv4",
          "multiport": "33",
          "action": "allow",
          "priority": 1
        }
      ]
    },
    "request_id": "c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4"
  }
}

插件执行函数mapError说明

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

函数mapError参数说明

函数功能：将VPC错误码映射为可读的中文或英文说明。

**表27** 函数mapError入参说明
参数名称	参数类型	参数描述	是否必填
language	String	语言，取值：zh（中文）、en（英文），默认值：en	否
code	String	VPC错误码，如VPC.0002、VPC.0003、VPC.0004、VPC.0005、VPC.0007、VPC.0008、VPC.0009、VPC.0010、VPC.0011、VPC.0014、VPC.2201、VPC.2701、VPC.0602、VPC.9902、VPC.9929等	是

**表28** 函数mapError出参说明
参数名称	参数类型	参数描述
result	String	错误码对应的可读说明字符串
engine_has_error	Int	0表示映射成功

函数mapError输出示例

{
  "result": "安全组规则已存在,请修改请求体中创建安全组规则",
  "engine_has_error": 0
}

插件执行函数operationAddressGroup说明

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

函数operationAddressGroup参数说明

函数功能：管理地址组中的IP，支持添加或删除IP地址到VPC地址组。添加时自动创建新地址组或追加到已有地址组，删除时从地址组中移除指定IP。每个地址组最多20个IP，最多50个地址组。

**表29** 函数operationAddressGroup入参说明
参数名称	参数类型	参数描述	是否必填
ip_list	JSON Array	IP地址列表，JSON数组格式	是
policy	String	策略，取值：BLOCK（封堵）、ALLOW（白名单）	是
operation_type	String	操作类型，取值：SENDING（添加IP）、DELETING（删除IP）	是
enterprise_project_id	String	企业项目ID	是
language	String	语言	否
agency_type	String	多账号统一适配参数，使用默认值即可	否

**表30** 函数operationAddressGroup出参说明
参数名称	参数类型	参数描述
failed_targets	Array	处理失败的IP列表
success_targets	Array	处理成功的IP列表

函数operationAddressGroup输出示例

{
  "failed_targets": [],
  "success_targets": [
    {
      "target": "192.168.1.1",
      "address_group_id": "dd6a0c79-5e48-4e5d-9c1b-84b0a5c6e7d8",
      "address_group_name": "SecMaster_Group_IPv4_INGRESS_BLOCK0"
    }
  ]
}

插件执行函数bindAddressGroup说明

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

函数bindAddressGroup参数说明

函数功能：将IP地址组绑定到安全组规则上，实现基于地址组的访问控制。支持封堵（BLOCK/deny）和白名单（ALLOW/allow）策略。

**表31** 函数bindAddressGroup入参说明
参数名称	参数类型	参数描述	是否必填
ip_list	JSON Array	IP地址列表，JSON数组格式	是
ip_version	String	IP版本，取值：IPv4、IPv6，默认值：IPv4	是
enterprise_project_id	String	企业项目ID	是
description	String	描述信息	是
action	String	操作策略，取值：WHITE（白名单，映射为allow）、BLOCK（封堵，映射为deny）	是
direction	String	方向，取值：INGRESS（入方向）、EGRESS（出方向）	是
operation_type	String	操作类型，取值：SENDING（绑定）、DELETING（解绑）	是
language	String	语言	否
agency_type	String	多账号统一适配参数，使用默认值即可	否

**表32** 函数bindAddressGroup出参说明
参数名称	参数类型	参数描述
failed_targets	Array	绑定失败的IP列表
success_targets	Array	绑定成功的IP列表

函数bindAddressGroup输出示例

{
  "failed_targets": [],
  "success_targets": [
    {
      "target": "192.168.1.1",
      "address_group_id": "dd6a0c79-5e48-4e5d-9c1b-84b0a5c6e7d8",
      "address_group_name": "SecMaster_Group_IPv4_INGRESS_BLOCK0"
    }
  ]
}

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

上一篇：HSS

下一篇：WAF

意见反馈

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

有帮助没帮助

提供反馈

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

系统繁忙，请稍后重试

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

云宝助手提问云社区提问

VPC