All Products
Search
Document Center

ENS:DescribeEpnInstanceAttribute

Last Updated:Mar 12, 2024

Queries networking information about an EPN instance.

Operation description

In internal networking mode, the value of Instances is empty in the response. In public networking mode, the value of VSwitches is empty in the response.

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
EPNInstanceIdstringYes

The ID of the EPN instance.

epn-xxxx

Response parameters

ParameterTypeDescriptionExample
object
ConfVersionsobject []

The information about the EPN configurations.

ConfVersionstring

The version number.

2017-10-11
EnsRegionIdstring

The ID of the node.

cn-chengdu-telecom
EPNInstanceIdstring

The ID of the EPN instance.

epn-xxxx
EPNInstanceNamestring

The name of the EPN instance.

epn-test
Instancesobject []

The information about the instance.

EnsRegionIdstring

The ID of the node.

cn-chengdu-telecom-4
InstanceIdstring

The ID of the instance.

epn-xxx
InstanceNamestring

The name of the instance.

epn-test
Ispstring

The ISP. Valid values:

  • cmcc: China Mobile
  • unicom: China Unicom
  • telecom: China Telecom
cmcc
PrivateIpAddressstring

The private IP address.

192.168.1.12
PublicIpAddressstring

The public IP address.

20.3.XX.XX
Statusstring

The status of the instance. Valid values:

  • Running
  • Stopped
  • Expired
Running
NetworkingModelstring

The networking mode. Valid values:

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

The request ID.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
VSwitchesobject []

Details of the vSwitch.

CidrBlockstring

The CIDR block.

10.0.0.1/24
EnsRegionIdstring

The ID of the node.

cn-chengdu-telecom-4
VSwitchIdstring

The ID of the vSwitch.

vs-xxxx
VSwitchNamestring

The name of the vSwitch.

vs-test

Examples

Sample success responses

JSONformat

{
  "ConfVersions": [
    {
      "ConfVersion": "2017-10-11",
      "EnsRegionId": "cn-chengdu-telecom"
    }
  ],
  "EPNInstanceId": "epn-xxxx",
  "EPNInstanceName": "epn-test",
  "Instances": [
    {
      "EnsRegionId": "cn-chengdu-telecom-4",
      "InstanceId": "epn-xxx",
      "InstanceName": "epn-test",
      "Isp": "cmcc",
      "PrivateIpAddress": "192.168.1.12",
      "PublicIpAddress": "20.3.XX.XX",
      "Status": "Running"
    }
  ],
  "NetworkingModel": "SpeedUp",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "VSwitches": [
    {
      "CidrBlock": "10.0.0.1/24",
      "EnsRegionId": "\t cn-chengdu-telecom-4",
      "VSwitchId": "vs-xxxx",
      "VSwitchName": "vs-test"
    }
  ]
}

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