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

使用说明

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

QPS限制

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeVpcFirewallCenList

系统规定参数。取值:DescribeVpcFirewallCenList

Lang String zh

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

  • zh(默认):中文。
  • en:英文。
RegionNo String cn-hangzhou

VPC所在的地域ID。

说明 关于云防火墙支持地域的详细信息,请参见支持的地域
NetworkInstanceId String vpc-8vbwbo90rq0anm6t****

网络实例ID。

FirewallSwitchStatus String opened

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

  • opened:已开启。
  • closed:已关闭。
  • notconfigured:表示暂未配置VPC边界防火墙。
  • configured:表示已配置VPC边界防火墙。
说明 不设置该参数表示查询所有状态的VPC边界防火墙。
VpcFirewallId String vfw-m5e7dbc4y****

VPC边界防火墙的实例ID。

VpcFirewallName String 测试环境防火墙

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

CenId String cen-x5jayxou71ad73****

云企业网实例ID。

CurrentPage String 1

分页查询时,设置当前页面的页码。

默认值为1,表示返回第1页数据。

PageSize String 10

分页查询时,设置每页包含VPC边界防火墙的数量。

默认值为10,表示每页包含10条结果。最大值为50。

RouteMode String auto

路由模式。取值:

  • auto:表示自动模式。
  • manual:表示手动模式。
说明 不设置该参数表示查询所有路由模式的VPC边界防火墙。
MemberUid String 258039427902****

当前阿里云账号的成员账号UID。

返回数据

名称 类型 示例值 描述
TotalCount Integer 10

VPC边界防火墙的总数量。

RequestId String 850A84D6-0DE4-4797-A1E8-00090125k8g2

本次请求的ID。

VpcFirewalls Array of Data

VPC边界防火墙的详细信息。

ConnectType String cen

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

VpcFirewallId String vfw-m5e7dbc4y****

VPC边界防火墙的实例ID。

RegionStatus String enable

地域开放状态。取值:

  • enable:已开放,表示该地域允许配置VPC边界防火墙。
  • disable:未开放,表示该地域不允许配置VPC边界防火墙。
CenId String cen-x5jayxou71ad73****

云企业网实例ID。

VpcFirewallName String 测试防火墙

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

ResultCode String test

创建VPC边界防火墙的操作结果代码。取值:

  • Unauthorized:表示存在未授权的网络实例, 不允许创建VPC边界防火墙。
  • RegionDisable:表示网络实例所在的地域是VPC边界防火墙不支持的地域, 不允许创建VPC边界防火墙。
  • OpsDisable:表示不允许创建VPC边界防火墙。
  • VbrNotSupport:表示云企业网中的VBR不支持创建VPC边界防火墙。
  • 空字符串,表示该网络实例可以正常创建VPC边界防火墙。
CenName String 测试云企业网

云企业网实例名称。

FirewallSwitchStatus String opened

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

  • opened:已开启。
  • closed:已关闭。
  • notconfigured:表示暂未配置VPC边界防火墙。
LocalVpc Object

VPC的详细信息。

VpcId String vpc-8vbwbo90rq0anm6t****

VPC的实例ID。

TransitRouterType String Basic

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

  • Basic:基础版。
  • Enterprise:企业版。
NetworkInstanceId String vpc-2zefk9fbn8j7v585g****

网络实例ID。

RouteMode String auto

路由模式,。取值:

  • auto:表示自动模式。
  • manual:表示手动模式。
RegionNo String cn-hangzhou

VPC所属地域ID。

AuthorizationStatus String authorized

VPC的授权状态。取值:authorized,表示已授权。

ManualVSwitchId String vsw-zeq4o875u****

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

OwnerId Long 158039427902****

VPC所属阿里云账号的UID。

NetworkInstanceType String VPC

网络实例的类型。取值:

  • VPC(Virtual Private Cloud)。
  • VBR(Virtual Border Router)。
  • CCN(Cloud Connect Network)。
VpcName String 测试用实例

VPC的实例名称。

SupportManualMode String 0

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

  • 1:支持。
  • 0:不支持。
NetworkInstanceName String 测试业务vpc

网络实例的名称。

VpcCidrTableList Array of cidrTable

VPC的网段列表信息。

RouteTableId String vtb-1234

VPC的路由表ID。

RouteEntryList Array of routeEntry

VPC的路由条目列表。

NextHopInstanceId String vrt-m5eb5me6c3l5sezae****

VPC中的下一跳实例ID。

DestinationCidr String 192.168.XX.XX/24

VPC的目标网段。

DefendCidrList Array of String 10.0.XX.XX/24

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

IpsConfig Object

IPS配置信息。

BasicRules Integer 1

基础规则开关。取值:

  • 1:开启状态。
  • 0:关闭状态。
EnableAllPatch Integer 1

虚拟补丁开关。取值:

  • 1:开启状态。
  • 0:关闭状态。
RunMode Integer 0

IPS防御模式。取值:

  • 1:拦截模式。
  • 0:观察模式。
MemberUid String 258039427902****

当前阿里云账号的成员账号UID。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeVpcFirewallCenList
&Lang=zh
&RegionNo=cn-hangzhou
&NetworkInstanceId=vpc-8vbwbo90rq0anm6t****
&FirewallSwitchStatus=opened
&VpcFirewallId=vfw-m5e7dbc4y****
&VpcFirewallName=测试环境防火墙
&CenId=cen-x5jayxou71ad73****
&CurrentPage=1
&PageSize=10
&RouteMode=auto
&MemberUid=258039427902****
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeVpcFirewallCenListResponse>
    <TotalCount>10</TotalCount>
    <RequestId>850A84D6-0DE4-4797-A1E8-00090125k8g2</RequestId>
    <VpcFirewalls>
        <ConnectType>cen</ConnectType>
        <VpcFirewallId>vfw-m5e7dbc4y****</VpcFirewallId>
        <RegionStatus>enable</RegionStatus>
        <CenId>cen-x5jayxou71ad73****</CenId>
        <VpcFirewallName>测试防火墙</VpcFirewallName>
        <ResultCode>test</ResultCode>
        <CenName>测试云企业网</CenName>
        <FirewallSwitchStatus>opened</FirewallSwitchStatus>
        <LocalVpc>
            <VpcId>vpc-8vbwbo90rq0anm6t****</VpcId>
            <TransitRouterType>Basic</TransitRouterType>
            <NetworkInstanceId>vpc-2zefk9fbn8j7v585g****</NetworkInstanceId>
            <RouteMode>auto</RouteMode>
            <RegionNo>cn-hangzhou</RegionNo>
            <AuthorizationStatus>authorized</AuthorizationStatus>
            <ManualVSwitchId>vsw-zeq4o875u****</ManualVSwitchId>
            <NetworkInstanceType>VPC</NetworkInstanceType>
            <VpcName>测试用实例</VpcName>
            <SupportManualMode>0</SupportManualMode>
            <NetworkInstanceName>测试业务vpc</NetworkInstanceName>
            <VpcCidrTableList>
                <RouteTableId>vtb-1234</RouteTableId>
                <RouteEntryList>
                    <NextHopInstanceId>vrt-m5eb5me6c3l5sezae****</NextHopInstanceId>
                    <DestinationCidr>192.168.XX.XX/24</DestinationCidr>
                </RouteEntryList>
            </VpcCidrTableList>
            <DefendCidrList>10.0.XX.XX/24</DefendCidrList>
        </LocalVpc>
        <IpsConfig>
            <BasicRules>1</BasicRules>
            <EnableAllPatch>1</EnableAllPatch>
            <RunMode>0</RunMode>
        </IpsConfig>
        <MemberUid>258039427902****</MemberUid>
    </VpcFirewalls>
</DescribeVpcFirewallCenListResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 10,
  "RequestId" : "850A84D6-0DE4-4797-A1E8-00090125k8g2",
  "VpcFirewalls" : [ {
    "ConnectType" : "cen",
    "VpcFirewallId" : "vfw-m5e7dbc4y****",
    "RegionStatus" : "enable",
    "CenId" : "cen-x5jayxou71ad73****",
    "VpcFirewallName" : "测试防火墙",
    "ResultCode" : "test",
    "CenName" : "测试云企业网",
    "FirewallSwitchStatus" : "opened",
    "LocalVpc" : {
      "VpcId" : "vpc-8vbwbo90rq0anm6t****",
      "TransitRouterType" : "Basic",
      "NetworkInstanceId" : "vpc-2zefk9fbn8j7v585g****",
      "RouteMode" : "auto",
      "RegionNo" : "cn-hangzhou",
      "AuthorizationStatus" : "authorized",
      "ManualVSwitchId" : "vsw-zeq4o875u****",
      "NetworkInstanceType" : "VPC",
      "VpcName" : "测试用实例",
      "SupportManualMode" : "0",
      "NetworkInstanceName" : "测试业务vpc",
      "VpcCidrTableList" : [ {
        "RouteTableId" : "vtb-1234",
        "RouteEntryList" : [ {
          "NextHopInstanceId" : "vrt-m5eb5me6c3l5sezae****",
          "DestinationCidr" : "192.168.XX.XX/24"
        } ]
      } ],
      "DefendCidrList" : [ "10.0.XX.XX/24" ]
    },
    "IpsConfig" : {
      "BasicRules" : 1,
      "EnableAllPatch" : 1,
      "RunMode" : 0
    },
    "MemberUid" : "258039427902****"
  } ]
}