All Products
Search
Document Center

ENS:DescribeEpnInstances

Last Updated:Mar 12, 2024

Queries EPN instances.

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
EPNInstanceIdstringNo

The version number.

2017-11-10
EPNInstanceNamestringNo

The name of the EPN instance.

testEPNInstanceName
PageNumberintegerNo

The page number. Default value: 1.

1
PageSizeintegerNo

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

10

Response parameters

ParameterTypeDescriptionExample
object
EPNInstancesobject []

Details of EPN instances.

CreationTimestring

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

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

The ID of the EPN instance.

epn****
EPNInstanceNamestring

The name of the EPN instance.

ens_test_epn
EPNInstanceTypestring

Set the value to EdgeToEdge.

EdgeToEdge
EndTimestring

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

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

The inbound bandwidth. Unit: Mbit/s.

40
ModifyTimestring

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

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

The networking mode. Valid values:

  • SpeedUp: intelligent acceleration network (Internet)
  • Connection: internal network
  • SpeedUpAndConnection: intelligent acceleration network and internal network
SpeedUp
StartTimestring

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

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

The status of the instance. Valid values:

  • Running
  • Excuting
  • Stopped
Running
PageNumberinteger

The page number.

1
PageSizeinteger

The number of entries per page.

40
RequestIdstring

The request ID.

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

The total number of pages returned.

1

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400MissingParameterThe input parameter that is mandatory for processing this request is not supplied.-
400NoPermissionPermission denied.-
400InvalidParameter.%sThe specified field %s invalid. Please check it again.-
400InvalidParameterThe errorMessage is %s. Please check it again.-
400ens.interface.errorAn error occurred while calling the API.-
400CallInterfaceCall Interface Happen Error.An error occurred when you call the operation.

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

Change history

Change timeSummary of changesOperation
2023-12-26API Description Update. The Error code has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Error CodesThe Error code has changed.
    Error Codes 400 change