创建外网防火墙--边缘计算节点-火山引擎

文档中心

立即注册

导航

边缘计算节点

创建外网防火墙

最近更新时间：2025.12.09 14:44:59首次发布时间：2022.02.25 18:58:31

本接口用于创建外网防火墙。
关于外网防火墙的介绍，请参见外网防火墙概述。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`CreateSecurityGroup`	接口名称。当前 API 的名称为 `CreateSecurityGroup`。
Version	String	是	`2021-04-30`	接口版本。当前 API 的版本为 `2021-04-30`。

Body

参数	类型	是否必选	示例值	描述
name	String	是	`郑州联通01-默认外网防火墙`	外网防火墙的名称。命名规则如下：允许 5~20 个字符。支持中文、大写字母、小写字母、数字。支持特殊字符 ()`~!@#$%^&*-+=_\|{}[]:;'<>,.?/。不能包含双引号（"）、反斜线（ \）和空格，且不能以正斜线（/）开头。
vpc_identity	String	是	`vpc-sbjngs****`	外网防火墙所属的私有网络的 ID。您可以通过 ListVPCInstances 接口查询私有网络 ID。
remark	String	否	`This is a new security group`	外网防火墙的描述。最多可输入 80 个字符。
project	String	否	`default`	外网防火墙所在项目。如果未指定该参数，外网防火墙默认加入 default 项目。
Tags	Object[]	否	`-`	绑定的标签。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结果。

参数	类型	示例值	描述
security_group	Object	`-`	外网防火墙的详细信息。

请求示例

POST https://veenedge.volcengineapi.com/?Action=CreateSecurityGroup&Version=2021-04-30
&<其他公共参数>
{
  "name": "sg-test",
  "vpc_identity": "vpc-sbjngs****"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230519152852465B1B0B8230B667****",
        "Action": "CreateSecurityGroup",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    },
    "Result": {
        "security_group": {
            "group_identity": "veew-sg-9250505551518201****",
            "account_identity": 210000****,
            "user_identity": 0,
            "name": "sg-test",
            "region": "EastChina",
            "city": "321000",
            "cluster_name": "**cm01",
            "vpc_identity": "vpc-djxn578***",
            "vpc_name": "**移动01-默认VPC",
            "vpc_cidr": [
                "172.**.**.64/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": 1684481333,
            "update_time": 1684481333
        }
    }
}

错误码

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