ListPrivateAccessApplicationsForDynamicRoute

Updated at:

List private access applications for dynamic routes in your Alibaba Cloud account.

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:ListPrivateAccessApplicationsForDynamicRoute

get

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

DynamicRouteIds

array

Yes

Collection of dynamic route IDs. You can specify up to 100 dynamic route IDs.

string

No

Dynamic route ID. Get this value from one of the following operations:

dr-ca9fddfac7c6****

Response elements

Element

Type

Description

Example

object

RequestId

string

ID of the request.

BE4FB974-11BC-5453-9BE1-1606A73EACA6

DynamicRoutes

array<object>

List of dynamic routes.

array<object>

Dynamic route.

DynamicRouteId

string

Dynamic route ID.

dr-ca9fddfac7c6****

Applications

array<object>

Collection of private access applications.

array<object>

Private access application.

ApplicationId

string

Private access application ID.

pa-application-7a9243dd02f4****

Name

string

Private access application name.

application_name

Description

string

Private access application description.

这是一条被动态路由引用的内网访问应用

Addresses

array

Collection of private access application addresses.

string

Private access application address.

192.168.0.0/16

PortRanges

array<object>

Collection of private access application port ranges.

object

Private access application port range.

Begin

integer

Start port.

80

End

integer

End port.

81

Protocol

string

Protocol used by the private access application. Valid values:

  • All: All protocols.

  • TCP

  • UDP

Valid values:

  • All :

    All

  • TCP :

    TCP

  • UDP :

    UDP

All

Status

string

Status of the private access application. Valid values:

  • Enabled: Enabled.

  • Disabled: Disabled.

Valid values:

  • Enabled :

    Enabled

  • Disabled :

    Disabled

Enabled

CreateTime

string

Time when the private access application was created.

2022-04-13 13:33:24

Examples

Success response

JSON format

{
  "RequestId": "BE4FB974-11BC-5453-9BE1-1606A73EACA6",
  "DynamicRoutes": [
    {
      "DynamicRouteId": "dr-ca9fddfac7c6****\n",
      "Applications": [
        {
          "ApplicationId": "pa-application-7a9243dd02f4****",
          "Name": "application_name",
          "Description": "这是一条被动态路由引用的内网访问应用",
          "Addresses": [
            "192.168.0.0/16"
          ],
          "PortRanges": [
            {
              "Begin": 80,
              "End": 81
            }
          ],
          "Protocol": "All",
          "Status": "Enabled",
          "CreateTime": "2022-04-13 13:33:24"
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.