DescribeVpcFirewallRoutePolicyList - 查询 VPC 防火墙引流场景--云防火墙-火山引擎

文档中心

立即注册

云防火墙

VPC边界防火墙

DescribeVpcFirewallRoutePolicyList - 查询 VPC 防火墙引流场景

调用本接口查询 VPC 防火墙的引流场景列表详情，包括引流场景的名称、类型、创建时间以及状态等信息。

请求说明

请求方式：POST
请求地址：https://fw-center.volcengineapi.com/?Action=DescribeVpcFirewallRoutePolicyList&Version=2021-09-06

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

Query

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

Body

参数	类型	是否必选	示例值	描述
VpcFirewallId	String	是	`vfw-****`	VPC 边界防火墙 ID

返回参数

参数	类型	示例值	描述
Data	Array of VpcFirewallRoutePolicyDetail	`--`	引流场景列表详情

VpcFirewallRoutePolicyDetail

参数	类型	示例值	描述
CreateAt	Long	`1721115816`	创建时间，Unix 秒级时间戳
PolicyName	String	`name`	引流场景名称
PolicyType	String	`fullmesh`	引流场景类型 one_to_one：点到点 end_to_end：点到多点 fullmesh：多点互联
PolicyStatus	String	`opened`	引流场景状态 opened：开启 closed：关闭 creating：创建中 deleting：删除中 opening：开启中 closing：关闭中 error：错误
VpcFirewallId	String	`vfw-****`	VPC 边界防火墙实例 ID
DstCandidateList	Array of CandidateStructure	`--`	目的网络连接实例列表
SrcCandidateList	Array of CandidateStructure	`--`	源网络连接实例列表
PolicyDescription	String	`description`	引流场景描述
VpcFirewallRoutePolicyId	String	`vfw-policy-xxxxx`	引流场景 ID

CandidateStructure

参数	类型	示例值	描述
CandidateId	String	`vfw-****`	VPC、专线网关、VPN 资源的网络连接实例 ID。
AttachmentId	String	`tr-attach-****`	中转路由器实例（TR）上的网络连接实例 ID。
CandidateName	String	`namedemo`	网络连接实例名称。
CandidateType	String	`VPC`	网络连接实例类型： VPC：私有网络 VPN：VPN 网关 DirectConnectGateway：专线网关
TrRouteTableId	String	`tr-rtb-****`	中转路由器实例（TR）的路由表 ID。

请求示例

POST https://fw-center.volcengineapi.com/?Action=DescribeVpcFirewallRoutePolicyList&Version=2021-09-06
{
    "VpcFirewallId": "vfw-****"
}

返回示例

{
    "ResponseMetadata": {
        "Action": "DescribeVpcFirewallRoutePolicyList",
        "Region": "cn-beijing",
        "Service": "fw_center",
        "Version": "2021-09-06",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "Data": [
            {
                "CreateAt": 1721115816,
                "PolicyName": "name",
                "PolicyType": "fullmesh",
                "PolicyStatus": "opened",
                "VpcFirewallId": "vfw-****",
                "DstCandidateList": [
                    {
                        "CandidateId": "vfw-****",
                        "AttachmentId": "tr-attach-****",
                        "CandidateName": "namedemo",
                        "CandidateType": "VPC",
                        "TrRouteTableId": "tr-rtb-****"
                    }
                ],
                "SrcCandidateList": [
                    {
                        "CandidateId": "vfw-****",
                        "AttachmentId": "tr-attach-****",
                        "CandidateName": "namedemo",
                        "CandidateType": "VPC",
                        "TrRouteTableId": "tr-rtb-****"
                    }
                ],
                "PolicyDescription": "description",
                "VpcFirewallRoutePolicyId": "vfw-policy-xxxxx"
            }
        ]
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。

最近更新时间：2025.12.31 15:16:09

这个页面对您有帮助吗？

有用

无用