全部产品
Search
文档中心

云防火墙:DescribeVpcFirewallAclGroupList - 获取VPC防火墙所有访问控制策略组信息

更新时间:Sep 25, 2024

获取VPC防火墙所有访问控制策略组信息。

接口说明

本接口一般用于查询 VPC 防火墙所有访问控制策略组信息。

QPS 限制

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

调试

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

授权信息

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

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

请求参数

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

接收消息的语言类型。

  • zh(默认):中文
  • en:英文
zh
FirewallConfigureStatusstring

VPC 防火墙的配置状态。

  • notconfigured:VPC 边界防火墙未配置(即未创建防火墙) 。
  • configured:VPC 边界防火墙已配置(即已创建了防火墙)。
  • 不填:表示查询所有 VPC 边界防火墙的访问控制策略。
configured
CurrentPagestring

分页查询时,显示的当前页的页码。 默认值为 1。

1
PageSizestring

分页查询时,显示的每页数据的最大条数。 可设置值最大为 50。

10

返回参数

名称类型描述示例值
object
TotalCountinteger

VPC 防火墙访问控制策略组的总数量。

1
RequestIdstring

结果的请求 ID。

CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D
AclGroupListarray<object>

VPC 防火墙访问控制策略组的信息。

Dataobject

AclGroupIdstring

VPC 边界防火墙的访问控制策略组 ID。

取值:

  • VPC 边界防火墙防护云企业网时,策略组 ID 使用云企业网实例 ID。

    例如:cen-ervw0g12b5jbw****

  • VPC 边界防火墙防护高速通道时,策略组 ID 使用 VPC 边界防火墙实例 ID。

    例如:vfw-a42bbb7b887148c9****

vfw-a42bbb7b887148c9****
AclGroupNamestring

VPC 边界防火墙的访问控制策略组名称。

  • VPC 边界防火墙防护云企业网时,策略组名称使用云企业网名称。
  • VPC 边界防火墙防护高速通道时,策略组名称使用 VPC 边界防火墙名称。
group_test
MemberUidstring

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

258039427902****
AclRuleCountinteger

VPC 边界防火墙访问控制策略组的策略数量。

9
IsDefaultboolean

是否是默认防火墙。取值:

  • true:是默认防火墙。
  • false:不是默认防火墙。
true

示例

正常返回示例

JSON格式

{
  "TotalCount": 1,
  "RequestId": "CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D",
  "AclGroupList": [
    {
      "AclGroupId": "vfw-a42bbb7b887148c9****",
      "AclGroupName": "group_test",
      "MemberUid": "258039427902****",
      "AclRuleCount": 9,
      "IsDefault": true
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400ErrorAliUidThe aliuid is invalid.无效的用户id
400ErrorDBSelectErrorA database select error occurred.内部错误:数据库查询错误
400ErrorPageNoEither page number or page size is invalid.无效的page number 或者 page size
400ErrorInvalidMemberUidMember uid is invalid成员账号错误.
400ErrorConfigureStatusfirewall configure status invalid.防火墙状态参数错误,请重新选择。

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

变更历史

变更时间变更内容概要操作
2023-12-06OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2023-09-11OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情