All Products
Search

This Product

    ENS:DescribeEpnInstances

    Document Center

    ENS:DescribeEpnInstances

    Last Updated:Mar 27, 2026

    Queries EPN instances.

    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

    ens:DescribeEpnInstances

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    EPNInstanceId

    string

    No

    The version number.

    2017-11-10
    EPNInstanceName

    string

    No

    The name of the EPN instance.

    testEPNInstanceName
    PageNumber

    integer

    No

    The page number. Default value: 1.

    1
    PageSize

    integer

    No

    The number of entries per page. Valid values: 1 to 50. Default value: 10.

    10

    Response elements

    Element

    Type

    Description

    Example

    object

    EPNInstances

    object

    EPNInstance

    array<object>

    Details of EPN instances.

    object

    CreationTime

    string

    The time when the instance was created. The time is displayed in UTC.

    2019-11-01T06:08:46Z
    EPNInstanceId

    string

    The ID of the EPN instance.

    epn****
    EPNInstanceName

    string

    The name of the EPN instance.

    ens_test_epn
    EPNInstanceType

    string

    Set the value to EdgeToEdge.

    EdgeToEdge
    EndTime

    string

    The end of the time range during which the data was queried. The time is displayed in UTC.

    2019-11-01T06:08:46Z
    InternetMaxBandwidthOut

    integer

    The inbound bandwidth. Unit: Mbit/s.

    40
    ModifyTime

    string

    The time when the instance was last modified. The time is displayed in UTC.

    2019-11-01T06:08:46Z
    NetworkingModel

    string

    The networking mode. Valid values:

    • SpeedUp: intelligent acceleration network (Internet)

    • Connection: internal network

    • SpeedUpAndConnection: intelligent acceleration network and internal network

    SpeedUp
    StartTime

    string

    The beginning of the time range during which the data was queried. The time is displayed in UTC.

    2019-11-01T06:08:46Z
    Status

    string

    The status of the instance. Valid values:

    • Running

    • Excuting

    • Stopped

    Running
    PageNumber

    integer

    The page number.

    1
    PageSize

    integer

    The number of entries per page.

    40
    RequestId

    string

    The request ID.

    A1707FC0-430C-423A-B624-284046B20399
    TotalCount

    integer

    The total number of pages returned.

    1

    Examples

    Success response

    JSON format

    {
  "EPNInstances": {
    "EPNInstance": [
      {
        "CreationTime": "2019-11-01T06:08:46Z",
        "EPNInstanceId": "epn****",
        "EPNInstanceName": "ens_test_epn",
        "EPNInstanceType": "EdgeToEdge",
        "EndTime": "2019-11-01T06:08:46Z",
        "InternetMaxBandwidthOut": 40,
        "ModifyTime": "2019-11-01T06:08:46Z",
        "NetworkingModel": "SpeedUp",
        "StartTime": "2019-11-01T06:08:46Z",
        "Status": "Running"
      }
    ]
  },
  "PageNumber": 1,
  "PageSize": 40,
  "RequestId": "A1707FC0-430C-423A-B624-284046B20399",
  "TotalCount": 1
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 MissingParameter The input parameter that is mandatory for processing this request is not supplied.
    400 NoPermission Permission denied.
    400 InvalidParameter.%s The specified field %s invalid. Please check it again.
    400 InvalidParameter The errorMessage is %s. Please check it again.
    400 ens.interface.error An error occurred while calling the API.
    400 CallInterface Call Interface Happen Error. An error occurred when you call the operation.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.