All Products
Search
Document Center

Cloud Firewall:DescribeVpcFirewallAclGroupList

更新時間:Sep 02, 2024

Queries the information about all policy groups of access control policies that are created for virtual private cloud (VPC) firewalls.

Operation description

You can call the DescribeVpcFirewallAclGroupList operation to query the information about all policy groups of access control policies that are created for VPC firewalls.

Limits

You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-cloudfirewall:DescribeVpcFirewallAclGroupListget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
LangstringNo

The language of the content within the response. Valid values:

  • zh: Chinese (default)
  • en: English
zh
FirewallConfigureStatusstringNo

Specifies whether VPC firewalls are configured. Valid values:

  • notconfigured: VPC firewalls are not configured.
  • configured: VPC firewalls are configured.
  • If you do not specify this parameter, the access control policies of all VPC firewalls are queried.
configured
CurrentPagestringNo

The number of the page to return. Default value: 1.

1
PageSizestringNo

The number of entries to return on each page. Maximum value: 50.

10

Response parameters

ParameterTypeDescriptionExample
object
TotalCountinteger

The total number of the policy groups that are returned.

1
RequestIdstring

The ID of the request.

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

The information about the policy groups.

object

None.

AclGroupIdstring

The ID of the policy group.

Valid values:

  • If the VPC firewall is used to protect a Cloud Enterprise Network (CEN) instance, the value of this parameter is the ID of the CEN instance.

    Example: cen-ervw0g12b5jbw****

  • If the VPC firewall is used to protect an Express Connect circuit, the value of this parameter is the instance ID of the VPC firewall.

    Example: vfw-a42bbb7b887148c9****

vfw-a42bbb7b887148c9****
AclGroupNamestring

The name of the policy group. Valid values:

  • If the VPC firewall is used to protect a CEN instance, the value of this parameter is the name of the CEN instance.
  • If the VPC firewall is used to protect an Express Connect circuit, the value of this parameter is the instance name of the VPC firewall.
group_test
MemberUidstring

The UID of the member that is managed by your Alibaba Cloud account.

258039427902****
AclRuleCountinteger

The number of access control policies in the policy group.

9

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400ErrorAliUidThe aliuid is invalid.The aliuid is invalid.
400ErrorDBSelectErrorA database select error occurred.The error message returned because an internal error has occurred in querying the database.
400ErrorPageNoEither page number or page size is invalid.Either page number or page size is invalid.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-12-06The Error code has changed. The response structure of the API has changedView Change Details
2023-09-11The Error code has changed. The response structure of the API has changedView Change Details