ListEnterpriseAcceleratePolicies

Updated at:

Query acceleration policies

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

csas:ListEnterpriseAcceleratePolicies

get

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

Name

string

No

The name of the enterprise acceleration policy.

测试策略

CurrentPage

integer

Yes

The number of the page to return for a paged query. Valid values: 1 to 10000.

1

PageSize

integer

Yes

The number of entries to return on each page for a paged query. Valid values: 1 to 1000.

10

Response elements

Element

Type

Description

Example

object

Schema of Response.

RequestId

string

The ID of the request.

DB0471D0-C05C-556D-9F40-0325D890036F

Total

integer

The total number of policies.

5

Policies

array<object>

The list of policies.

object

A policy object.

EapId

string

The policy ID.

eap-eec34d4b12fcca61

Name

string

The policy name.

test

Description

string

The description of the policy.

这是一条测试策略。

UpstreamType

string

The acceleration instance.

connector

UpstreamHost

string

The address of the acceleration instance. The address can be an IP address or a domain name.

12.34.56.XX

UpstreamPort

integer

The port of the acceleration instance. The port must be between 1000 and 60000.

1000

Enabled

integer

Indicates whether the policy is enabled.

  • 1: enabled

  • 0: disabled

0

UserAttributeGroup

string

The user group for acceleration.

测试用户组

Priority

integer

The policy priority.

99

AccelerationType

string

The acceleration pattern.

  • whitelist: accelerates access to applications in the whitelist.

  • global: accelerates access to all applications.

  • build-in-list: accelerates access to built-in applications.

whitelist

ShowInClient

integer

Indicates whether the policy is visible on the client.

  • 0: not visible

  • 1: visible

1

OnTls

integer

Indicates whether to enable Transport Layer Security (TLS).

  • 0: disable

  • 1: enable

0

Examples

Success response

JSON format

{
  "RequestId": "DB0471D0-C05C-556D-9F40-0325D890036F",
  "Total": 5,
  "Policies": [
    {
      "EapId": "eap-eec34d4b12fcca61",
      "Name": "test",
      "Description": "这是一条测试策略。",
      "UpstreamType": "connector",
      "UpstreamHost": "12.34.56.XX",
      "UpstreamPort": 1000,
      "Enabled": 0,
      "UserAttributeGroup": "测试用户组",
      "Priority": 99,
      "AccelerationType": "whitelist",
      "ShowInClient": 1,
      "OnTls": 0
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.