文档

DescribeVpcFirewallCenDetail - 查询VPC边界防火墙的详细信息

更新时间:

查询VPC边界防火墙(防护云企业网内的网络实例和指定VPC之间的互访流量)的详细信息。

接口说明

本接口一般用于获取 VPC 边界防火墙的详细信息。该 VPC 边界防火墙是防护云企业网内的网络实例(网络实例包含 VPC、VBR 和 CCN)和指定 VPC 之间的互访流量。

QPS 限制

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

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
Langstring

请求和接收消息的语言类型。取值:

  • zh(默认):中文。

  • en:英文。

zh
VpcFirewallIdstring

VPC 边界防火墙的实例 ID。

说明 您可以调用 DescribeVpcFirewallCenList 接口查询 VPC 边界防火墙的实例 ID。
vfw-m5e7dbc4y****
NetworkInstanceIdstring

创建 VPC 边界防火墙的 VPC 实例 ID。

vpc-2zefk9fbn8j7v585g****

返回参数

名称类型描述示例值
object
ConnectTypestring

VPC 边界防火墙的互通类型。取值:cen,表示云企业网。

cen
VpcFirewallNamestring

VPC 边界防火墙的实例名称。

测试防火墙
VpcFirewallIdstring

VPC 边界防火墙的实例 ID。

vfw-m5e7dbc4y****
FirewallSwitchStatusstring

VPC 边界防火墙的开关状态。取值:

  • opened:已开启。

  • closed:已关闭。

  • notconfigured:未配置。

opened
RequestIdstring

本次请求的 ID。

850A84D6-0DE4-4797-A1E8-00090125g4d2
LocalVpcobject

VPC 的详细信息。

VpcIdstring

VPC 的实例 ID。

vpc-8vbwbo90rq0anm6t****
TransitRouterTypestring

云企业网转发路由器(CEN-TR)的版本。取值:

  • Basic:基础版。

  • Enterprise:企业版。

Basic
RouteModestring

路由模式,。取值:

  • auto:表示自动模式。

  • manual:表示手动模式。

auto
NetworkInstanceIdstring

创建 VPC 边界防火墙的 VPC 实例 ID。

vpc-2zefk9fbn8j7v585g****
RegionNostring

VPC 所属地域 ID。

cn-hangzhou
ManualVSwitchIdstring

路由模式为手动模式时指定的 vSwitch 的 ID。

vsw-zeq4o875u****
OwnerIdstring

VPC 所属阿里云账户的 UID。

158039427902****
NetworkInstanceTypestring

网络实例的类型。取值:VPC

VPC
VpcNamestring

VPC 的实例名称。

测试用实例
SupportManualModestring

路由模式是否支持手动模式。取值:

  • 1:支持。
  • 0:不支持。
0
TransitRouterIdstring

CEN-TR 的实例 ID。

tr-2zetwxskej633l3u1****
AttachmentIdstring

网络实例的连接 ID。

tr-attach-sxig7bye51fid5****
NetworkInstanceNamestring

网络实例的名称。

测试业务vpc
AttachmentNamestring

网络实例的连接名称

本地测试
VpcCidrTableListobject []

VPC 的网段列表信息。

RouteTableIdstring

VPC 的路由表 ID。

vtb-1234
RouteEntryListobject []

VPC 的路由条目列表。

NextHopInstanceIdstring

VPC 中的下一跳实例 ID。

vrt-m5eb5me6c3l5sezae****
DestinationCidrstring

VPC 的目标网段。

192.168.XX.XX/24
EniListobject []

弹性网卡列表。

EniIdstring

VPC 中弹性网卡的实例 ID。

eni-8vbhfosfqv2rff42****
EniPrivateIpAddressstring

VPC 中弹性网卡的私网 IP。

192.168.XX.XX
EniVSwitchIdstring

VPC 中弹性网卡的虚拟交换机 ID。

vsw-wz9viido7j436b0n1****
DefendCidrListarray

VPC 边界防火墙防护的网段列表。

string

VPC 边界防火墙防护的网段。

10.0.XX.XX/24
FirewallVpcobject

防火墙所使用 VPC。

VpcIdstring

VPC 实例 ID。

vpc-bp1245k5oagy2bp74****
VpcCidrstring

VPC 的网段。

10.0.0.0/8
VswitchIdstring

虚拟交换机 ID。

vsw-bp1sqg9wms9wxcs1****
VswitchCidrstring

虚拟交换机的网段。

10.0.0.1/24
ZoneIdstring

可用区 ID。

cn-hangzhou-i
AllowConfigurationinteger

CEN 基础版创建 VPC 防火墙时是否允许配置防火墙 VPC 网段。取值:

  • 1:允许。
  • 0:不允许。
0

示例

正常返回示例

JSON格式

{
  "ConnectType": "cen",
  "VpcFirewallName": "测试防火墙",
  "VpcFirewallId": "vfw-m5e7dbc4y****",
  "FirewallSwitchStatus": "opened",
  "RequestId": "850A84D6-0DE4-4797-A1E8-00090125g4d2",
  "LocalVpc": {
    "VpcId": "vpc-8vbwbo90rq0anm6t****",
    "TransitRouterType": "Basic",
    "RouteMode": "auto",
    "NetworkInstanceId": "vpc-2zefk9fbn8j7v585g****",
    "RegionNo": "cn-hangzhou",
    "ManualVSwitchId": "vsw-zeq4o875u****",
    "OwnerId": "158039427902****",
    "NetworkInstanceType": "VPC",
    "VpcName": "测试用实例",
    "SupportManualMode": "0",
    "TransitRouterId": "tr-2zetwxskej633l3u1****",
    "AttachmentId": "tr-attach-sxig7bye51fid5****",
    "NetworkInstanceName": "测试业务vpc",
    "AttachmentName": "本地测试",
    "VpcCidrTableList": [
      {
        "RouteTableId": "vtb-1234",
        "RouteEntryList": [
          {
            "NextHopInstanceId": "vrt-m5eb5me6c3l5sezae****",
            "DestinationCidr": "192.168.XX.XX/24"
          }
        ]
      }
    ],
    "EniList": [
      {
        "EniId": "eni-8vbhfosfqv2rff42****",
        "EniPrivateIpAddress": "192.168.XX.XX",
        "EniVSwitchId": "vsw-wz9viido7j436b0n1****"
      }
    ],
    "DefendCidrList": [
      "10.0.XX.XX/24"
    ]
  },
  "FirewallVpc": {
    "VpcId": "vpc-bp1245k5oagy2bp74****",
    "VpcCidr": "10.0.0.0/8",
    "VswitchId": "vsw-bp1sqg9wms9wxcs1****",
    "VswitchCidr": "10.0.0.1/24",
    "ZoneId": "cn-hangzhou-i",
    "AllowConfiguration": 0
  }
}

错误码

HTTP status code错误码错误信息描述
400ErrorAliUidThe aliuid is invalid.无效的用户id
400ErrorDBSelectErrorA database select error occurred.内部错误:数据库查询错误
400ErrorVpcFirewallIdThe VPC firewall ID is invalid.无效的VPC防火墙ID
400ErrorVpcFirewallExistThe firewall has been configured and cannot be created repeatedly.防火墙已配置,不能重复新建
400ErrorUnmarshalJSONAn error occurred while parsing JSON.内部错误:JSON解码错误
400ErrorDBTxErrorA database transaction error occurred.内部错误:数据库事务错误
400ErrorVpcOpenApivpc open api failed调用 VPC API 失败

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

变更历史

变更时间变更内容概要操作
2023-06-13OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更