DescribeAclApps

更新时间:
复制 MD 格式

Queries multiple ACL applications.

Operation description

QPS limit

The single-user QPS limit for this operation is 10 requests per second. Calls that exceed this limit are throttled, which may impact your business.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-cloudfirewall:DescribeAclApps

get

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

Lang

string

No

The language of the response. Valid values:

  • zh (default): Chinese

  • en: English

zh

PageNo

integer

Yes

The page number.

1

PageSize

integer

Yes

The page size.

10

AclType

string

Yes

The ACL type. Valid values:

  • Internet

  • NAT

  • VPC

  • All

Valid values:

  • NAT :

    NAT firewall policy

  • All :

    All policy types

  • VPC :

    VPC firewall policy

  • Internet :

    internet firewall policy

VPC

Popular

integer

No

Specifies whether the application is common. Valid values:

  • 1: common

  • 0: not common

  • If you omit this parameter (the default), all applications are returned.

Valid values:

  • 1 :

    1

1

Protocols

array

No

The list of protocol types.

string

No

A protocol type. Valid values:

  • TCP: Transmission Control Protocol

  • UDP: User Datagram Protocol

Valid values:

  • TCP :

    Transmission Control Protocol

  • UDP :

    User Datagram Protocol

[ "TCP", "UDP" ]

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

9063AB86-6FFA-5B2D-A16D-697C966D****

AclApps

array<object>

The list of ACL applications.

object

AppId

integer

The application ID.

1.0

AppName

string

The application name.

test

RiskLevel

integer

The risk level. Valid values:

  • 1: Low

  • 2: Medium

  • 3: High

1

Popular

integer

Indicates whether the application is common. Valid values:

  • 1: common

  • 0: not common

1

Protocols

array

The protocols supported by the application.

string

A protocol type. Valid values:

  • TCP: Transmission Control Protocol

  • UDP: User Datagram Protocol

[ "TCP", "UDP" ]

SupportFqdn

integer

Indicates whether the application supports FQDN. Valid values:

  • 0: No

  • 1: Yes

1

TotalCount

integer

The total count.

20

Examples

Success response

JSON format

{
  "RequestId": "9063AB86-6FFA-5B2D-A16D-697C966D****",
  "AclApps": [
    {
      "AppId": 1,
      "AppName": "test",
      "RiskLevel": 1,
      "Popular": 1,
      "Protocols": [
        "[\n  \"TCP\",\n  \"UDP\"\n]"
      ],
      "SupportFqdn": 1
    }
  ],
  "TotalCount": 20
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.