You need to enable JavaScript to run this app.
导航
DescribeVpcFirewallAclRuleList - 获取VPC边界流量控制网关规则列表
最近更新时间:2024.07.15 11:06:25首次发布时间:2024.03.28 17:09:34

获取 VPC 边界流量控制网关规则列表。

请求说明

  • 请求方式:POST
  • 请求地址:https://open.volcengineapi.com/?Action=DescribeVpcFirewallAclRuleList&Version=2021-09-06

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

Query

参数
类型
是否必填
示例值
描述
Action
String

DescribeVpcFirewallAclRuleList

要执行的操作,取值:DescribeVpcFirewallAclRuleList。

Version
String

2021-09-06

API的版本,取值:2021-09-06。

Body

参数
类型
是否必填
示例值
描述
VpcFirewallId
String

vfw-****

VPC 边界防火墙实例 ID。

PageNumber
Integer

1

当前页码。

PageSize
Integer

10

分页大小。

Source
String

10.0.0.0/0

访问控制策略的源地址,支持模糊查询。

Destination
String

10.0.0.0/0

访问控制策略的目的地址,支持模糊查询。

Proto
Array of String

["ICMP"]

协议。

Action
Array of String

["accept"]

访问控制策略的动作。

Status
Array of Boolean

[false]

访问控制策略的状态。

RuleId
String

f04ac7ce-628b-4cb7-be61-310222b7****

访问控制策略的唯一标识。

Description
String

test

描述信息。

返回参数

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

参数
类型
示例值
描述
TotalCount
Integer

1

返回数据总数量。当查询数据为空时,且使用 Python SDK 调用时此项为 None。

PageSize
Integer

1

返回数据的分页大小。

PageNumber
Integer

1

返回数据的当前页码。

Count
Integer

1

返回数据的实际数量。当查询数据为空时,且使用 Python SDK 调用时此项为 None。

Data
Array of Object

参见结构示例值

返回的 VPC rule 数据。

请求示例

POST /?Action=DescribeVpcFirewallAclRuleList&Version=2021-09-06 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20240711T063703Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240711/cn-beijing/fw_center/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "VpcFirewallId": "vfw-****",
  "PageNumber": 1,
  "PageSize": 10,
  "Source": "10.0.0.0/0",
  "Destination": "10.0.0.0/0",
  "Proto": [
    "ICMP"
  ],
  "Action": [
    "accept"
  ],
  "Status": [
    true
  ],
  "RuleId": "f04ac7ce-628b-4cb7-be61-310222b7****",
  "Description": "test"
}

返回示例

{
    "ResponseMetadata":{
        "RequestID":"2023100720365381D6E985*****",
        "Service":"fw_center",
        "Region":"cn-beijing",
        "Action":"DescribeVpcFirewallAclRuleList",
        "Version":"2021-09-06"
    },
    "Result":{
        "TotalCount":1,
        "PageSize":1,
        "CurrentPage":1,
        "Count":1,
        "Data":[
            {
                "AccountId":"2100*******",
                "RuleId":"f3d94384-78ba-431a-*****",
                "VpcFirewallId":"",
                "VpcFirewallName":"创建完后再新购高级版本",
                "Prio":1,
                "Source":"192.168.3.1/32",
                "SourceType":"net",
                "SourceGroupType":"",
                "Destination":"192.168.4.1/32",
                "DestinationType":"net",
                "DestinationGroupType":"",
                "DestPort":"23",
                "DestPortType":"port",
                "DestPortGroupType":"",
                "Proto":"TCP",
                "Action":"accept",
                "Status":false,
                "Description":"",
                "HitCnt":0,
                "UseCount":1,
                "SourceCidrList":[
                    "192.168.3.1/32"
                ],
                "DestinationCidrList":[
                    "192.168.4.1/32"
                ],
                "DestPortList":[
                    "23"
                ]
            }
        ]
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
400
InvalidParameter
非法的参数。请检查%s。

请求中缺乏某个参数或者某个参数校验失败,请参考错误信息,根据 API 接口文档修改对应的参数。

400
BadRequest
错误的请求。请检查http请求或者联系管理员!

请求无法被正确地解析,请重新构建请求,或者通过工单联系相关人员进行处理。

400
NotFound.Resource
资源未找到。请检查%s。

请求需要操作的资源未找到,请参考错误信息,检查请求中的资源是否已被删除。

500
InternalError
内部错误。请联系管理员!

请求过程中发生了一些非预期的错误,请通过工单联系相关人员进行处理。