复制外网防火墙到其他私有网络--边缘计算节点-火山引擎

文档中心

立即注册

导航

边缘计算节点

复制外网防火墙到其他私有网络

最近更新时间：2024.07.02 15:51:18首次发布时间：2022.02.25 18:58:32

本接口用于复制外网防火墙到其他私有网络。通过外网防火墙复制功能，您可以将已有防火墙的出方向和入方向规则复制到一个或多个私有网络。该功能为您节省配置防火墙规则的时间。

请求说明

请求方式：POST
请求地址：https://veenedge.volcengineapi.com?Action=CopySecurityGroup&Version=2021-04-30

请求参数

下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。其他公共参数，请参见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	CopySecurityGroup	公共参数。该参数表示接口名称。取值：CopySecurityGroup。
Version	String	是	2021-04-30	公共参数。该参数表示接口版本。取值：2021-04-30。

Body

参数	类型	是否必选	示例值	描述
source_group_identity	String	是	veew-sg-2551200256591525****	外网防火墙的 ID。您可以通过 DescribeSecurityGroups 接口查询外网防火墙的 ID。
name	String	是	test	新的外网防火墙的名称。命名规则如下：允许 5~20 个字符。支持中文、大写字母、小写字母、数字。支持特殊字符 ()`~!@#$%^&*-+=_\|{}[]:;'<>,.?/。 \| 不能包含双引号（"）、反斜线（ \）和空格，且不能以正斜线（/）开头。如果将外网防火墙复制到多个私有网络，系统会在您指定的外网防火墙的名称后面添加数字后缀。例如，如果将外网防火墙复制到 2 个私有网络并指定防火墙的名称为 test，则创建出来的 2 个外网防火墙的名称分别为 test-0 和 test-1。
vpc_identities	[]String	是	["vpc-sbjngs****"]	私有网络 ID 的列表。您可以通过 ListVPCInstances 接口获取私有网络的 ID。
remark	String	否	This is a test	外网防火墙的描述。最多可输入80个字符。

返回参数

参数	类型	示例值	描述
source_groups	[]SecurityGroup	请参见返回示例	新的外网防火墙的信息。

请求示例

POST https://veenedge.volcengineapi.com/?Action=CopySecurityGroup&Version=2021-04-30
&<其他公共参数>
{
  "source_group_identity": "veew-sg-0525202442145545****",
  "name": "copytest",
  "vpc_identities": [
    "vpc-29gwx9****"
  ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230522150802400197EA0177638F****",
        "Action": "CopySecurityGroup",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    },
    "Result": {
        "security_groups": [
            {
                "group_identity": "veew-sg-2125020002000320****",
                "account_identity": 210000****,
                "user_identity": 0,
                "name": "copytest-0",
                "region": "CentralChina",
                "city": "410900",
                "cluster_name": "**cu01",
                "vpc_identity": "vpc-29gwx9****",
                "vpc_name": "**联通01-默认VPC",
                "vpc_cidr": [
                    "172.**.**.128/26"
                ],
                "group_type": "custom",
                "remark": "",
                "ingress_rule": {
                    "total": 0,
                    "rules": []
                },
                "egress_rule": {
                    "total": 0,
                    "rules": []
                },
                "binds": {
                    "total": 0,
                    "binds": []
                },
                "cluster_name_alias": "**联通01",
                "create_time": 1684739283,
                "update_time": 1684739283
            }
        ]
    }
}

错误码

如果响应正文中包含 Error 字段，则表示 API 请求失败。关于错误码的更多信息，参见错误码。