文档

DescribeVpcFirewallCenList - 查询云企业网(基础版)防火墙列表

更新时间:

查询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:DescribeVpcFirewallCenListRead
  • 全部资源
    *

请求参数

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

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

  • zh(默认):中文。

  • en:英文。

zh
RegionNostring

VPC 所在的地域 ID。

说明 关于云防火墙支持地域的详细信息,请参见支持的地域
cn-hangzhou
NetworkInstanceIdstring

网络实例 ID。

vpc-8vbwbo90rq0anm6t****
FirewallSwitchStatusstring

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

  • opened:已开启。

  • closed:已关闭。

  • notconfigured:表示暂未配置 VPC 边界防火墙。

  • configured:表示已配置但未开启 VPC 边界防火墙。

说明 不设置该参数表示查询所有状态的 VPC 边界防火墙。
opened
VpcFirewallIdstring

VPC 边界防火墙的实例 ID。

vfw-m5e7dbc4y****
VpcFirewallNamestring

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

测试环境防火墙
CenIdstring

云企业网实例 ID。

cen-x5jayxou71ad73****
CurrentPagestring

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

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

1
PageSizestring

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

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

10
RouteModestring

路由模式。取值:

  • auto:表示自动模式。

  • manual:表示手动模式。

说明 不设置该参数表示查询所有路由模式的 VPC 边界防火墙。
auto
MemberUidstring

当前阿里云账号的成员账号(其他阿里云账号)UID。

258039427902****
TransitRouterTypestring

转发实例路由器类型。可选值:

  • Basic:基础版转发路由器。

  • Enterprise:企业版转发路由器。

Basic

返回参数

名称类型描述示例值
object
TotalCountinteger

VPC 边界防火墙的总数量。

10
RequestIdstring

本次请求的 ID。

850A84D6-0DE4-4797-A1E8-00090125k8g2
VpcFirewallsobject []

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

ConnectTypestring

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

cen
VpcFirewallIdstring

VPC 边界防火墙的实例 ID。

vfw-m5e7dbc4y****
RegionStatusstring

地域开放状态。取值:

  • enable:已开放,表示该地域允许配置 VPC 边界防火墙。

  • disable:未开放,表示该地域不允许配置 VPC 边界防火墙。

enable
CenIdstring

云企业网实例 ID。

cen-x5jayxou71ad73****
VpcFirewallNamestring

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

测试防火墙
ResultCodestring

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

  • Unauthorized:表示存在未授权的网络实例, 不允许创建 VPC 边界防火墙。

  • RegionDisable:表示网络实例所在的地域是 VPC 边界防火墙不支持的地域, 不允许创建 VPC 边界防火墙。

  • OpsDisable:表示不允许创建 VPC 边界防火墙。

  • VbrNotSupport:表示云企业网中的 VBR 不支持创建 VPC 边界防火墙。

  • 空字符串,表示该网络实例可以正常创建 VPC 边界防火墙。

Unauthorized
CenNamestring

云企业网实例名称。

测试云企业网
FirewallSwitchStatusstring

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

  • opened:已开启。

  • closed:已关闭。

  • notconfigured:表示暂未配置 VPC 边界防火墙。

opened
LocalVpcobject

VPC 的详细信息。

VpcIdstring

VPC 的实例 ID。

vpc-8vbwbo90rq0anm6t****
TransitRouterTypestring

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

  • Basic:基础版转发路由器。

  • Enterprise:企业版转发路由器。

Basic
NetworkInstanceIdstring

网络实例 ID。

vpc-2zefk9fbn8j7v585g****
RouteModestring

路由模式。取值:

  • auto:表示自动模式。

  • manual:表示手动模式。

auto
RegionNostring

VPC 所属地域 ID。

cn-hangzhou
AuthorizationStatusstring

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

authorized
ManualVSwitchIdstring

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

vsw-zeq4o875u****
OwnerIdlong

VPC 所属阿里云账号的 UID。

158039427902****
NetworkInstanceTypestring

网络实例的类型。取值:

  • VPC(Virtual Private Cloud)。

  • VBR(Virtual Border Router)。

  • CCN(Cloud Connect Network)。

VPC
VpcNamestring

VPC 的实例名称。

测试用实例
SupportManualModestring

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

  • 1:支持。

  • 0:不支持。

0
NetworkInstanceNamestring

网络实例的名称。

测试业务VPC
VpcCidrTableListobject []

VPC 的网段列表信息。

RouteTableIdstring

VPC 的路由表 ID。

vtb-1234
RouteEntryListobject []

VPC 的路由条目列表。

NextHopInstanceIdstring

VPC 中的下一跳实例 ID。

vrt-m5eb5me6c3l5sezae****
DestinationCidrstring

VPC 的目标网段。

192.168.XX.XX/24
DefendCidrListarray

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

string

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

10.0.XX.XX/24
IpsConfigobject

IPS 配置信息。

BasicRulesinteger

基础规则开关。取值:

  • 1:开启状态。

  • 0:关闭状态。

1
EnableAllPatchinteger

虚拟补丁开关。取值:

  • 1:开启状态。

  • 0:关闭状态。

1
RunModeinteger

IPS 防御模式。取值:

  • 1:拦截模式。

  • 0:观察模式。

0
MemberUidstring

当前阿里云账号的成员账号(其他阿里云账号)UID。

258039427902****
PrecheckStatusstring

是否可以自动开墙,即云防火墙会根据路由学习,自动防护 VPC 流量。取值:

  • passed:可以自动开墙。

  • failed:不可以自动开墙。

  • unknown:未知状态。

failed

示例

正常返回示例

JSON格式

{
  "TotalCount": 10,
  "RequestId": "850A84D6-0DE4-4797-A1E8-00090125k8g2",
  "VpcFirewalls": [
    {
      "ConnectType": "cen",
      "VpcFirewallId": "vfw-m5e7dbc4y****",
      "RegionStatus": "enable",
      "CenId": "cen-x5jayxou71ad73****",
      "VpcFirewallName": "测试防火墙",
      "ResultCode": "Unauthorized",
      "CenName": "测试云企业网",
      "FirewallSwitchStatus": "opened",
      "LocalVpc": {
        "VpcId": "vpc-8vbwbo90rq0anm6t****",
        "TransitRouterType": "Basic",
        "NetworkInstanceId": "vpc-2zefk9fbn8j7v585g****",
        "RouteMode": "auto",
        "RegionNo": "cn-hangzhou",
        "AuthorizationStatus": "authorized",
        "ManualVSwitchId": "vsw-zeq4o875u****",
        "OwnerId": 0,
        "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****",
      "PrecheckStatus": "failed"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400ErrorAliUidThe aliuid is invalid.无效的用户id
400ErrorDBSelectErrorA database select error occurred.内部错误:数据库查询错误
400ErrorAssetsStatusfirewall status is invalid.-
400ErrorPageNoEither page number or page size is invalid.无效的page number 或者 page size
400ErrorInvalidMemberUidMember uid is invalid成员账号错误.

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

变更历史

变更时间变更内容概要操作
2021-11-15新增 OpenAPI看变更集
  • 本页导读 (1)
文档反馈