获取外网防火墙规则--边缘计算节点-火山引擎

文档中心

立即注册

导航

边缘计算节点

获取外网防火墙规则

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

本接口用于获取外网防火墙所有出方向和入方向规则。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	DescribeSecurityGroupRules	公共参数。该参数表示接口名称。取值：DescribeSecurityGroupRules
Version	String	是	2021-04-30	公共参数。该参数表示接口版本。取值：2021-04-30。
group_identity	String	是	veew-sg-2551200256591525****	外网防火墙的 ID。您可以通过 DescribeSecurityGroups 接口查询外网防火墙的 ID。
direction	String	是	ingress	外网防火墙规则的方向： ingress：入方向。 egress：出方向。
page	Integer	否	1	规则列表的页码。
limit	Integer	否	10	分页查询时设置的每页行数。
order_by	Integer	否	1	查询出来的外网防火墙规则的排列顺序，按照创建时间排序。取值范围： 1：按照降序排列。 2（默认值）：按照升序排列。

返回参数

参数	类型	示例值	描述
total_count	Integer	1	查询出来的外网防火墙规则的数量。
rules	[]SecurityGroupRule	请参见返回示例	规则列表。

请求示例

GET https://veenedge.volcengineapi.com/?Action=DescribeSecurityGroupRules&Version=2021-04-30
&group_identity=veew-sgr-5931197925305709****
&direction=egress
&<其他公共参数>

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202305191805053FBD5E8050BF9D76****",
        "Action": "DescribeSecurityGroupRules",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    },
    "Result": {
        "total_count": 1,
        "rules": [
            {
                "rule_identity": "veew-sgr-5931197925305709****",
                "direction": "egress",
                "rule": "reject",
                "protocol": "TCP",
                "ports": "22",
                "ip_type": "ipv4",
                "ip_cidr": "0.0.0.0/0",
                "remark": "test",
                "group_identity": "veew-sg-925050555151820****",
                "status": 2,
                "create_time": 1684489815,
                "update_time": 1684489820
            }
        ]
    }
}

错误码

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