All Products
Search
Document Center

ENS:DescribeEpnInstanceAttribute

Last Updated:Dec 25, 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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ens:DescribeEpnInstanceAttributeget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
EPNInstanceIdstringYes

The ID of the EPN instance.

epn-xxxx

Response parameters

ParameterTypeDescriptionExample
object
ConfVersionsarray<object>

The information about the EPN configurations.

ConfVersionsobject
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
Instancesarray<object>

The information about the instance.

EPNInstanceobject
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
VSwitchesarray<object>

Details of the vSwitch.

EPNInstanceobject
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 changedView Change Details