调用DescribeVpcFirewallDetail查询VPC边界防火墙的详情_云防火墙(Cloud Firewall)-阿里云帮助中心

查询VPC边界防火墙（防护通过高速通道连接的两个VPC之间的流量）的详细信息。

接口说明

本接口用于获取 VPC 边界防火墙的详细信息。该 VPC 边界防火墙是防护通过高速通道连接的两个 VPC 之间的流量。调用本接口前，必须已经调用 CreateVpcFirewallConfigure 接口创建了 VPC 边界防火墙。

QPS 限制

本接口的单用户 QPS 限制为 10 次/秒。超过限制，API 调用将会被限流，这可能影响您的业务，请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
yundun-cloudfirewall:DescribeVpcFirewallDetail	get	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
Lang	string	否	请求和接收消息的语言类型。取值： zh（默认）：中文。 en：英文。	zh
VpcFirewallId	string	是	VPC 边界防火墙的实例 ID。说明您可以调用 DescribeVpcFirewallList 接口查询 VPC 边界防火墙的实例 ID。	vfw-m5e7dbc4y****
LocalVpcId	string	否	本端 VPC 的实例 ID。	vpc-8vbwbo90rq0anm6t****
PeerVpcId	string	否	对端 VPC 的实例 ID。	vpc-90rq0anm6t8vbwbo****

返回参数

名称	类型	描述	示例值
	object
ConnectType	string	VPC 边界防火墙的互通类型。取值：expressconnect，表示高速通道。	expressconnect
VpcFirewallId	string	VPC 边界防火墙实例 ID。	vfw-m5e7dbc4y****
RequestId	string	本次请求的 ID。	850A84D6-0DE4-4797-A1E8-00090125g4d2
Bandwidth	integer	高速通道的带宽规格。单位：Mbps。	2
VpcFirewallName	string	VPC 边界防火墙的实例名称。	测试防火墙
FirewallSwitchStatus	string	VPC 边界防火墙的状态。取值： opened：已开启。 closed：已关闭。 notconfigured：表示暂未配置 VPC 边界防火墙。 configured：表示已配置 VPC 边界防火墙。	opened
LocalVpc	object	本端 VPC 的详细信息。
VpcId	string	本端 VPC 的实例 ID。	vpc-8vbwbo90rq0anm6t****
VpcName	string	本端 VPC 的实例名称。	测试用实例
RegionNo	string	本端 VPC 所属地域 ID。	cn-hangzhou
EniPrivateIpAddress	string	本端 VPC 中弹性网卡私网 IP。	192.168.XX.XX
RouterInterfaceId	string	本端 VPC 中路由器接口 ID。	vrt-m5eb5me6c3l5sezae****
EniId	string	本端 VPC 中弹性网卡的实例 ID。	eni-8vbhfosfqv2rff42****
VpcCidrTableList	array<object>	本端 VPC 的网段列表信息。
cidrTable	object
RouteTableId	string	本端 VPC 的路由表 ID。	vtb-1234
RouteEntryList	array<object>	本端 VPC 的路由条目列表。
routeEntry	object
NextHopInstanceId	string	本端 VPC 中的下一跳实例 ID。	vrt-m5eb5me6c3l5sezae****
DestinationCidr	string	本端 VPC 的目标网段。	192.168.XX.XX/24
PeerVpc	object	对端 VPC 的详细信息。
VpcId	string	对端 VPC 的实例 ID。	vpc-90rq0anm6t8vbwbo****
VpcName	string	对端 VPC 的实例名称。	测试vpc2
RegionNo	string	对端 VPC 所属地域 ID。	cn-hangzhou
EniPrivateIpAddress	string	对端 VPC 中弹性网卡私网 IP。	192.168.XX.XX
RouterInterfaceId	string	对端 VPC 中路由器接口 ID。	vrt-m5eb5me6c3l5sezae****
EniId	string	对端 VPC 中弹性网卡的实例 ID。	eni-8vbhfosfqv2rff42****
VpcCidrTableList	array<object>	对端 VPC 的网段列表信息。
cidrTable	object
RouteTableId	string	对端 VPC 的路由表 ID。	vtb-1256
RouteEntryList	array<object>	对端 VPC 路由条目列表信息。
routeEntry	object
NextHopInstanceId	string	对端 VPC 中的下一跳实例 ID。	vrt-m5eb5me6c3l5sezae****
DestinationCidr	string	对端 VPC 的目标网段。	192.168.XX.XX/24
MemberUid	string	云防火墙成员账号的 UID。	258039427902****

示例

正常返回示例

JSON格式

{
  "ConnectType": "expressconnect",
  "VpcFirewallId": "vfw-m5e7dbc4y****",
  "RequestId": "850A84D6-0DE4-4797-A1E8-00090125g4d2",
  "Bandwidth": 2,
  "VpcFirewallName": "测试防火墙",
  "FirewallSwitchStatus": "opened",
  "LocalVpc": {
    "VpcId": "vpc-8vbwbo90rq0anm6t****",
    "VpcName": "测试用实例",
    "RegionNo": "cn-hangzhou",
    "EniPrivateIpAddress": "192.168.XX.XX",
    "RouterInterfaceId": "vrt-m5eb5me6c3l5sezae****",
    "EniId": "eni-8vbhfosfqv2rff42****",
    "VpcCidrTableList": [
      {
        "RouteTableId": "vtb-1234",
        "RouteEntryList": [
          {
            "NextHopInstanceId": "vrt-m5eb5me6c3l5sezae****",
            "DestinationCidr": "192.168.XX.XX/24"
          }
        ]
      }
    ]
  },
  "PeerVpc": {
    "VpcId": "vpc-90rq0anm6t8vbwbo****",
    "VpcName": "测试vpc2",
    "RegionNo": "cn-hangzhou",
    "EniPrivateIpAddress": "192.168.XX.XX",
    "RouterInterfaceId": "vrt-m5eb5me6c3l5sezae****",
    "EniId": "eni-8vbhfosfqv2rff42****",
    "VpcCidrTableList": [
      {
        "RouteTableId": "vtb-1256",
        "RouteEntryList": [
          {
            "NextHopInstanceId": "vrt-m5eb5me6c3l5sezae****",
            "DestinationCidr": "192.168.XX.XX/24"
          }
        ]
      }
    ]
  },
  "MemberUid": "258039427902****"
}

错误码

HTTP status code	错误码	错误信息	描述
400	ErrorAliUid	The aliuid is invalid.	无效的用户id
400	ErrorFirewallNotFound	Firewall not found	防火墙不存在
400	ErrorDBSelectError	A database select error occurred.	内部错误：数据库查询错误
400	ErrorInvalidMemberUid	Member uid is invalid	成员账号错误.
400	ErrorFirewallStatus	firewall status error.	防火墙状态错误，请稍后再试。
400	ErrorVpcIdPara	vpc id and firewall id parameter not exist.	防火墙VPC参数错误，请重新选择。
400	ErrorLocalVpcIdPeerVpcIdError	local vpc id and peer vpc id cannot be empty at the same time.	防火墙VPC参数错误，请重新选择。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-09-05	OpenAPI 错误码发生变更	查看变更详情
2022-12-08	OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情